Difference between revisions of "UrlLoader.new"

Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
'''<translate>Available since</translate>:''' Gideros 2012.2.2<br/>
 
'''<translate>Available since</translate>:''' Gideros 2012.2.2<br/>
 +
'''<translate>Class</translate>:''' [[Special:MyLanguage/UrlLoader|UrlLoader]]<br/>
 
=== <translate>Description</translate> ===
 
=== <translate>Description</translate> ===
 
<translate><br />
 
<translate><br />
Creates a new [[Special:MyLanguage/UrlLoader|UrlLoader]] object.<br />
+
Creates a new `UrlLoader` object.<br />
 
<br />
 
<br />
[[Special:MyLanguage/url|url]] parameter specifies the URL to download. This parameter is optional and if specified loading starts immediately.<br />
+
`url` parameter specifies the URL to download. This parameter is optional and if specified loading starts immediately.<br />
 
<br />
 
<br />
[[Special:MyLanguage/method|method]] parameter specifies the HTTP request method. It can be one of the values of [[Special:MyLanguage/UrlLoader.GET|UrlLoader.GET]], [[Special:MyLanguage/UrlLoader.POST|UrlLoader.POST]], [[Special:MyLanguage/UrlLoader.PUT|UrlLoader.PUT]] or [[Special:MyLanguage/UrlLoader.DELETE|UrlLoader.DELETE]].<br />
+
`method` parameter specifies the HTTP request method. It can be one of the values of `UrlLoader.GET`, `UrlLoader.POST`, `UrlLoader.PUT` or `UrlLoader.DELETE`.<br />
The default HTTP method is [[Special:MyLanguage/UrlLoader.GET|UrlLoader.GET]].<br />
+
The default HTTP method is `UrlLoader.GET`.<br />
 
<br />
 
<br />
[[Special:MyLanguage/body|body]] parameter specifies the HTTP body data. This parameter is used only when the HTTP method is [[Special:MyLanguage/UrlLoader.POST|UrlLoader.POST]] or or [[Special:MyLanguage/UrlLoader.PUT|UrlLoader.PUT]].<br />
+
`body` parameter specifies the HTTP body data. This parameter is used only when the HTTP method is `UrlLoader.POST` or or `UrlLoader.PUT`.<br />
 
<br />
 
<br />
After loading is finished, loaded data is stored at [[Special:MyLanguage/event.data|event.data]] field of [[Special:MyLanguage/Event.COMPLETE|Event.COMPLETE]] event as string.<br />
+
After loading is finished, loaded data is stored at `event.data` field of `Event.COMPLETE` event as string.<br />
 
<br /></translate>
 
<br /></translate>
 
<source lang="lua">
 
<source lang="lua">

Revision as of 09:28, 24 August 2018

Available since: Gideros 2012.2.2
Class: UrlLoader

Description


Creates a new `UrlLoader` object.

`url` parameter specifies the URL to download. This parameter is optional and if specified loading starts immediately.

`method` parameter specifies the HTTP request method. It can be one of the values of `UrlLoader.GET`, `UrlLoader.POST`, `UrlLoader.PUT` or `UrlLoader.DELETE`.
The default HTTP method is `UrlLoader.GET`.

`body` parameter specifies the HTTP body data. This parameter is used only when the HTTP method is `UrlLoader.POST` or or `UrlLoader.PUT`.

After loading is finished, loaded data is stored at `event.data` field of `Event.COMPLETE` event as string.

 UrlLoader.new(url,method,headers,body)

Parameters

url: (string, optional) URL to download. This parameter is optional and if specified loading starts immediately.
method: (string, default = "get") HTTP request method.
headers: (table, optional) HTTP headers.
body: (string, optional) HTTP body data. This data is sent as the message body of a request.

Examples

Example

local url = &quot;http://www.[yourDomain].com/application.php?userid=gideros&amp;login=guest&quot;

local loader1 = UrlLoader.new(url)
local loader2 = UrlLoader.new(url, UrlLoader.GET) -- same as the previous line
local loader3 = UrlLoader.new(url, UrlLoader.POST, &quot;my post data&quot;)
local loader4 = UrlLoader.new(url, UrlLoader.PUT, &quot;my put data&quot;)
local loader5 = UrlLoader.new(url, UrlLoader.DELETE)

local headers = {
	[&quot;Content-Type&quot;] = &quot;application/x-www-form-urlencoded&quot;,
	[&quot;User-Agent&quot;] = &quot;Gideros Browser&quot;,
}
local loader6 = UrlLoader.new(url, UrlLoader.PUT, headers, &quot;key=value&quot;)