Home » API » scrapeableFile

saveFileOnRequest

scrapeableFile.saveFileOnRequest( String pathToSaveTo ) (enterprise edition only)
Description
Causes the file to be saved to the local file system after being requested by screen-scraper. This method must be called before the file is scraped. That is, the script calling this method should be associated with the scrapeable file, and should be invoked "Before file is scraped". Note that the preferred method for downloading files to the file system is session.downloadFile, but this method is useful in cases where a POST request is required to request the file. For example, if you'd like to download and save a PDF that is accessible only through a POST request it would be appropriate to use this method.
Example
// When the current file is requested it will be saved to the
// local file system as "sample.pdf".
scrapeableFile.saveFileOnRequest( "C:/downloaded_files/sample.pdf" );