session
SessionEventFireTime
ScriptEventFireTime
Enum
- AfterScript After a script is executed
- BeforeScript Before a script is executed
ScrapeableFileEventFireTime
ExtractorPatternEventFireTime
Enum
- BeforeExtractorPattern Before an extractor is applied (including before any scripts on it run). The returned value should be a boolean and indicates whether the extractor should be run or not. Any non-boolean result is the same as true. Also note that regardless of whether the extractor will be run or not, the event for after extractor pattern will still be fired.
EventFireTime
The EventFireTime is an interface which defines the methods that a fire time must have and so the addEventCallback method can take different types of fire times.
A number of different types of classes based on this interface have been defined for you which call out the various parts of a scrape that you can add event handlers to. Those are defined below.
getHandlerName
Description
Returns the name of the handler. This method doesn't need to be implemented but helps with debugging.
Parameters
This method does not receive any parameters.
Return Values
Returns the name of the handler. This method doesn't need to be implemented but helps with debugging.
handleEvent
Description
Processes the event, and potentially returns a useful value modifying something in the internal code as defined by the EventFireTime used to launch this event.
EventHandler
Description
Creates an EventHandler callback object which will be called when the event triggers
addEventCallback
void session.addEventCallbackWithPriority ( EventFireTime eventTime, EventHandler callback, int priority ) (professional and enterprise editions only)
isRunningInWorkbench
Description
Returns whether or not we are currently running in the workbench. This is a convenience method for doing something different in a script when running in the workbench as opposed to other modes
Parameters
This method does not receive any parameters.