scrapeableFile
removeHTTPHeader
void scrapeableFile.removeHTTPHeader ( String key, String value ) (enterprise edition only)
Description
Remove an HTTP header from a scrapeable file.
getMaxResponseLength
Description
Retrieve the kilobyte limit for information retrieved by the scrapeable file, any additional information will not be retrieved.
Parameters
This method does not receive any parameters.
Return Values
Returns the current kilobyte limit on the response, as an integer.
setAuthenticationPreemptive
Description
Set the authentication expectation of the request.
getAuthenticationPreemptive
Description
Retrieve the authentication expectation of the request.
Parameters
This method does not receive any parameters.
Return Values
Returns whether the scrapeable file expects to have to authenticate and so will send the information initially instead of waiting for the request for it, as a boolean.
getUserAgent
Description
Retrieve the name of the user agent making the request.
Parameters
This method does not receive any parameters.
Return Values
Returns the user agent, as a string.
getContentType
Description
Retrieve the POST payload type being used to interpret the page. This can be important with scraping some site's implementation of AJAX, where the payload in explicitly set as xml.
Parameters
This method does not receive any parameters.
Return Values
Returns the content type, as a string (e.g., text/html or text/xml).
setForceNonBinary
Description
Set whether or not the contents of this response should be forced to be treated as non-binary. Default forceNonBinary value is false.
Parameters
- forceNonBinary Whether or not the scrapeable file should be forced to be non-binary.
Return Values
Returns void.
getForceNonBinary
Description
Determine whether or not the contents of this response are being forced to be recognized as non-binary.
Parameters
This method does not receive any parameters.
Return Values
Returns true if the scrapeable file is being forced to be treated as non-binary; otherwise, it returns false.
getCharacterSet
Description
Get the character set being used in the page response rendering.
Parameters
This method does not receive any parameters.
Return Values
Returns the character set applied to the scraped page, as a string. If a character set has not been specified then it will default to the character set specified in settings dialog box.
inputOutputErrorOccured
Description
Determine if an input or output error occurred when requesting file.
Parameters
This method does not receive any parameters.
Return Values
Returns true if an error has occurred; otherwise, it returns false.