Home

API

addHTTPHeader

scrapeableFile.addHTTPHeader( String contentType ) (enterprise edition only)
Description
In certain rare cases it may be necessary to explicitly add a custom header to the POST data of an HTTP request.

setVariable

runnableScrapingSession.setVariable( String identifier, Object value )

getVariable

Description
runnableScrapingSession.getVariable( String variableName )

getName

Description
runnableScrapingSession.getName()
Description
Returns the name of the scraping session.
Example

getName

scrapeableFile.getName()
Description
Gets the name of the current scrapeable file.
Example

setRetainNonTidiedHTML

scrapeableFile.setRetainNonTidiedHTML( boolean retainNonTidiedHTML ) (enterprise edition only)

getRetainNonTidiedHTML

Description
scrapeableFile.getRetainNonTidiedHTML() (enterprise edition only)

close

Description
XmlWriter.close() (enterprise edition only)

xmlWriter

Description
Writes out the closing root element tag and closes up the XML file.
XmlWriter Methods

Before working with the methods below, you may wish to read our documentation about Writing extracted data to XML, which contains examples of scripts that utilize these methods.

session

session Methods
Syndicate content