Browshot.BrowshotClient Class Reference

c# client to interact with the Browshot API. See http://browshot.com/api/documentation for information about the API. More...

Public Member Functions
Constructors
	BrowshotClient (string key)
	Constructor
	BrowshotClient (string key, bool debug)
	Constructor
	BrowshotClient (string key, bool debug, string baseUrl)
	Constructor
Screenshot API
Dictionary< string, object >	ScreenshotCreate (string url, Hashtable arguments)
	Create a custom browser. See http://browshot.com/api/documentation#browser_create for the response format
Dictionary< string, object >	ScreenshotInfo (int id)
	Get information about a screenshot requested previously. See http://browshot.com/api/documentation#screenshot_info for the response format.
Dictionary< string, object >	ScreenshotList (int limit=100)
	Get details about screenshots requested. See http://browshot.com/api/documentation#screenshot_list for the response format.
Dictionary< string, object >	ScreenshotHost (int id, Hashtable arguments)
	Host a screenshot or thumbnail. See http://browshot.com/api/documentation#screenshot_host for the response format.
Image	Thumbnail (int id, Hashtable arguments)
	Retrieve the screenshot, or a thumbnail. See http://browshot.com/api/documentation#screenshot_thumbnail for the response format.
Dictionary< string, object >	ScreenshotShare (int id, Hashtable arguments)
	Share a screenshot. See http://browshot.com/api/documentation#screenshot_share for the response format.
Dictionary< string, object >	ScreenshotDelete (int id, Hashtable arguments)
	Delete details of a screenshot. See http://browshot.com/api/documentation#screenshot_delete for the response format.
Account API
Dictionary< string, object >	AccountInfo ()
	Return information about the user account. See http://browshot.com/api/documentation#account_info for the response format.
Instance API
Dictionary< string, object >	InstanceList ()
	Return the list of instances as a hash reference. See http://browshot.com/api/documentation#instance_list for the response format.
Dictionary< string, object >	InstanceInfo (int id)
	Return the details of an instance. See http://browshot.com/api/documentation#instance_info for the response format.
Dictionary< string, object >	InstanceCreate (Hashtable arguments)
	Create a private instance. See http://browshot.com/api/documentation#instance_create for the response format.
Browser API
Dictionary< string, object >	BrowserList ()
	Return the list of browsers as a hash reference. See http://browshot.com/api/documentation#browser_list for the response format.
Dictionary< string, object >	BrowserInfo (int id)
	Return the details of a browser. See http://browshot.com/api/documentation#browser_info for the response format.
Dictionary< string, object >	BrowserCreate (Hashtable arguments)
	Create a custom browser. See http://browshot.com/api/documentation#browser_create for the response format.
Simple API
Image	Simple (string url, Hashtable arguments)
	Retrieve a screenshot in one function. Note: by default, screenshots are cached for 24 hours. You can tune this value with the cache=X parameter.

Properties
Version
Version	APIVersion [get]
	API version managed by this library.

Properties
string	Key [get, set]
	API key
string	BaseUrl [get, set]
	Base url of the Browshot API.
bool	Debug [get, set]
	Debug flag (not used currently)
string	baseUrl = "https://api.browshot.com/api/v1/"

Private methods
Object	GenericError (string message)
Uri	MakeUrl (string action, Hashtable arguments)

Detailed Description

c# client to interact with the Browshot API. See http://browshot.com/api/documentation for information about the API.

Constructor & Destructor Documentation

Browshot.BrowshotClient.BrowshotClient

(

string

key

)

Constructor

Parameters

key

API Key

Browshot.BrowshotClient.BrowshotClient	(	string	key,
		bool	debug
	)

Constructor

Parameters

key	API Key
debug	Debug flag (not used curently)

Browshot.BrowshotClient.BrowshotClient	(	string	key,
		bool	debug,
		string	baseUrl
	)

Constructor

Parameters

key	API Key
debug	Debug flag (not used curently)
baseUrl	Change URL to conect to he Browshot API

Member Function Documentation

Dictionary<string, object> Browshot.BrowshotClient.AccountInfo

(

)

Return information about the user account. See http://browshot.com/api/documentation#account_info for the response format.

Returns

JSON output

Dictionary<string, object> Browshot.BrowshotClient.BrowserCreate

(

Hashtable

arguments

)

Create a custom browser. See http://browshot.com/api/documentation#browser_create for the response format.

Parameters

arguments

See http://browshot.com/api/documentation#browser_create for the full list of possible arguments.

Returns

JSON output

Dictionary<string, object> Browshot.BrowshotClient.BrowserInfo

(

int

id

)

Return the details of a browser. See http://browshot.com/api/documentation#browser_info for the response format.

Parameters

id	Browser ID

Returns

JSON output

Dictionary<string, object> Browshot.BrowshotClient.BrowserList

(

)

Return the list of browsers as a hash reference. See http://browshot.com/api/documentation#browser_list for the response format.

Returns

JSON output

Dictionary<string, object> Browshot.BrowshotClient.InstanceCreate

(

Hashtable

arguments

)

Create a private instance. See http://browshot.com/api/documentation#instance_create for the response format.

Parameters

arguments

See http://browshot.com/api/documentation#instance_create for the full list of possible arguments.

Returns

JSON output

Dictionary<string, object> Browshot.BrowshotClient.InstanceInfo

(

int

id

)

Return the details of an instance. See http://browshot.com/api/documentation#instance_info for the response format.

Parameters

id	Instance ID

Returns

JSON output

Dictionary<string, object> Browshot.BrowshotClient.InstanceList

(

)

Return the list of instances as a hash reference. See http://browshot.com/api/documentation#instance_list for the response format.

Returns

JSON output

Dictionary<string, object> Browshot.BrowshotClient.ScreenshotCreate	(	string	url,
		Hashtable	arguments
	)

Create a custom browser. See http://browshot.com/api/documentation#browser_create for the response format

Parameters

url	URL of the website to create a screenshot of.
arguments	See http://browshot.com/api/documentation#screenshot_create for the full list of possible arguments.

Returns

JSON output

Dictionary<string, object> Browshot.BrowshotClient.ScreenshotDelete	(	int	id,
		Hashtable	arguments
	)

Delete details of a screenshot. See http://browshot.com/api/documentation#screenshot_delete for the response format.

Parameters

id	Screenshot ID
arguments	See http://browshot.com/api/documentation#screenshot_delete for the full list of possible arguments.

Returns

JSON output

Dictionary<string, object> Browshot.BrowshotClient.ScreenshotHost	(	int	id,
		Hashtable	arguments
	)

Host a screenshot or thumbnail. See http://browshot.com/api/documentation#screenshot_host for the response format.

Parameters

id	Screenshot ID
arguments	See http://browshot.com/api/documentation#screenshot_host for the full list of possible arguments.

Returns

JSON output

Dictionary<string, object> Browshot.BrowshotClient.ScreenshotInfo

(

int

id

)

Get information about a screenshot requested previously. See http://browshot.com/api/documentation#screenshot_info for the response format.

Parameters

id	Screenshot ID

Returns

JSON output

Dictionary<string, object> Browshot.BrowshotClient.ScreenshotList

(

int

limit = 100

)

Get details about screenshots requested. See http://browshot.com/api/documentation#screenshot_list for the response format.

Parameters

limit

Number of screenshots tolist.

Returns

JSON output

Dictionary<string, object> Browshot.BrowshotClient.ScreenshotShare	(	int	id,
		Hashtable	arguments
	)

Share a screenshot. See http://browshot.com/api/documentation#screenshot_share for the response format.

Parameters

id	Screenshot ID
arguments	See http://browshot.com/api/documentation#screenshot_share for the full list of possible arguments.

Returns

JSON output

Image Browshot.BrowshotClient.Simple	(	string	url,
		Hashtable	arguments
	)

Retrieve a screenshot in one function. Note: by default, screenshots are cached for 24 hours. You can tune this value with the cache=X parameter.

Parameters

url	URL of the website to create a screenshot of.
arguments	>See http://browshot.com/api/documentation#screenshot_create for the full list of possible arguments.

Returns

Thumbnail image

Image Browshot.BrowshotClient.Thumbnail	(	int	id,
		Hashtable	arguments
	)

Retrieve the screenshot, or a thumbnail. See http://browshot.com/api/documentation#screenshot_thumbnail for the response format.

Parameters

id	Screenshot ID
arguments	See http://browshot.com/api/documentation#screenshot_thumbnail for the full list of possible arguments.

Returns

Thumbnail bitmap

Property Documentation

Version Browshot.BrowshotClient.APIVersion

get

API version managed by this library.

string Browshot.BrowshotClient.BaseUrl

getset

Base url of the Browshot API.

bool Browshot.BrowshotClient.Debug

getset

Debug flag (not used currently)

string Browshot.BrowshotClient.Key

getset

API key

---

The documentation for this class was generated from the following file:

• E:/Browshot/Client.cs