session
clearAllSessionVariables
Description
Remove all session variables.
Parameters
This method does not receive any parameters.
Return Values
Returns void.
logError
Description
Write message to the log, at the the error level (least verbose).
logWarn
Description
Write message to the log, at the the warn level (third most verbose).
logInfo
Description
Write message to the log, at the the info level (second most verbose).
logDebug
Description
Write message to the log, at the the debug level (most verbose).
session
Overview
This object refers to the current scraping session that is running. To make the methods a little easier to sort through they have been grouped into related methods. The groups have been named to ease in finding them when they are needed.
stopScraping
Description
Stop the current scraping session.
Parameters
This method does not receive any parameters.
Return Values
Returns void.
setNumRecordsScraped
Description
Set the number of records that have been scraped.
Parameters
- value Value to set the count of the number of records scraped.
Return Values
Returns void.
setFatalErrorOccurred
Description
Set the fatal error status of the scrape.
Parameters
- fatalErrorOccurred Desired fatal error status to set, as a boolean.
Return Values
Returns void.
setErrorMessage
Description
Set the current error message.
Parameters
- errorMessage Desired error message, as a string.
Return Values
Returns void.