Differences

This shows you the differences between two versions of the page.

--- en:code:data:web [2011/10/01 22:54] – [toText] jmgr
+++ en:code:data:web [2024/08/11 11:46] (current) – jmgr
@@ Line 17: / Line 17: @@
     * onDownloadProgress - ([[#onDownloadProgress|onDownloadProgress]]) called when the download progresses
     * onError - ([[#onError|onError]]) called when an error has occured
-    * file - ([[en:code:data:file|File]] or string) the file or filename to use as a destination for the downloaded data
+    * file - ([[en:code:data: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
 === Example ===
@@ Line 52: / Line 52: @@
     * 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
@@ Line 64: / Line 65: @@
 === Notes ===
 This method is asynchronous, this means that it will return before the data is downloaded.
-To known when this is done use the [[#onFinished|onFinished]] event or the [[#isDownloading|isDownloading]] method.
+To know when this is done use the [[#onFinished|onFinished]] event or the [[#isDownloading|isDownloading]] method.
 ==== isDownloading ====
@@ Line 135: / Line 136: @@
 === Returns ===
   * (Web) this Web
+===== Events =====
+==== onFinished ====
+Called when the data has been downloaded.
+=== Syntax ===
+<code javascript>
+myObject.onFinished = function() {};
+</code>
+=== Example ===
+<code javascript>
+myObject.onFinished = function()
+{
+	//Event action
+};
+</code>
+==== onDownloadProgress ====
+Called when the download progression has changed.
+=== Syntax ===
+<code javascript>
+myObject.onDownloadProgress = function(bytesReceived, bytesTotal) {};
+</code>
+=== Arguments ===
+  - bytesReceived - (integer) received byte count
+  - bytesTotal - (integer) total byte count
+=== Example ===
+<code javascript>
+myObject.onDownloadProgress = function(bytesReceived, bytesTotal)
+{
+	//Event action
+};
+</code>
+==== onError ====
+Called when an error occurs.
+=== Syntax ===
+<code javascript>
+myObject.onError = function(errorText) {};
+</code>
+=== Arguments ===
+  - errorText - (string) a text describing the error
+=== Example ===
+<code javascript>
+myObject.onError = function(errorText)
+{
+	//Event action
+};
+</code>
+===== Enumerations =====
+==== Method ====
+The download method.
+=== Values ===
+  - Get: use "get" method (default)
+  - Post: use "post" method