Home » API » Documentation » API » Scraping Engine API » scrapeableFile

setUserAgent

void scrapeableFile.setUserAgent ( String userAgent ) (professional and enterprise editions only)

Description

Explicitly state the user agent making the request.

Parameters

  • userAgent User agent name, as a string. There are a lot of possible user agents, a list is maintained by User-Agents.org. The default is Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; .NET CLR 1.1.4322).

Return Values

Returns void.

Change Log

Version Description
4.5 Available for professional and enterprise editions.

This method must be called before the file is scraped.

Examples

Set User Agent

 // In script called "Before file is scraped"

 // Causes screen-scraper to identify itself as Firefox
 // running on Linux.

 scrapeableFile.setUserAgent( "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.1) Gecko/20020826" );

See Also

  • getUserAgent() [scrapeableFile] - Returns the name of the user agent that will make the request
scraper on 07/16/2010 at 4:56 pm