Web

This object allows you to download data.

Constructor function.

var myObject = new Web(eventsAndOptions);

1. eventsAndOptions - (object) the events that can be called
   • onFinished - (onFinished) called when the data has been downloaded
   • onDownloadProgress - (onDownloadProgress) called when the download progresses
   • onError - (onError) called when an error has occured
   • file - (File or string) the file or filename to use as a destination for the downloaded data, if this is not set the data will be stored into RAM

var myObject = new Web();

var myObject = new Web({
	onFinished: function()
	{
		Console.print("Finished!");
	},
	file: "myFile.txt"
});

Start downloading.

myObject.download(url, options);

myObject.download(url);

1. url - (string) the url of the resource to download
2. options - (object) options
   • rawHeaders - (object) raw headers to set
   • method - (Method) the method to use (get or post)
   • postData - (object) post data to send
   • rawData - (string) raw post data to send [Since version 3.11.0]
   • query - (object) query items
   • user - (string) the username to use if asked
   • password - (string) the password to use if asked

• (Web) this Web

• (OpenFileError) unable to open the destination file

This method is asynchronous, this means that it will return before the data is downloaded. To know when this is done use the onFinished event or the isDownloading method.

Returns true if the data is still being downloaded.

myObject.isDownloading();

• (boolean) true if the data is still being downloaded

Returns the downloaded data as an Image.

myObject.toImage();

• (Image) the image

You cannot use this method if you specified a destination file as no data is kept in memory.

Returns the downloaded data as text.

myObject.toText(encoding);

myObject.toText();

1. encoding - (Encoding) the encoding to use

• (string) the text

You cannot use this method if you specified a destination file as no data is kept in memory.

Returns the downloaded data as RawData.

myObject.toRawData();

• (RawData) the raw data

You cannot use this method if you specified a destination file as no data is kept in memory.

Cancel the download.

myObject.cancel();

• (Web) this Web

Called when the data has been downloaded.

myObject.onFinished = function() {};

myObject.onFinished = function()
{
	//Event action
};

Called when the download progression has changed.

myObject.onDownloadProgress = function(bytesReceived, bytesTotal) {};

1. bytesReceived - (integer) received byte count
2. bytesTotal - (integer) total byte count

myObject.onDownloadProgress = function(bytesReceived, bytesTotal)
{
	//Event action
};

Called when an error occurs.

myObject.onError = function(errorText) {};

1. errorText - (string) a text describing the error

myObject.onError = function(errorText)
{
	//Event action
};

The download method.

1. Get: use "get" method (default)
2. Post: use "post" method