Difference between revisions of "UrlLoader.new"
(9 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
− | '''Available since:''' Gideros 2012.2.2<br/> | + | <languages /> |
− | === Description === | + | '''<translate>Available since</translate>:''' Gideros 2012.2.2<br/> |
+ | '''<translate>Class</translate>:''' [[Special:MyLanguage/UrlLoader|UrlLoader]]<br/> | ||
+ | === <translate>Description</translate> === | ||
+ | <translate><br /> | ||
+ | Creates a new [[Special:MyLanguage/UrlLoader|UrlLoader]] object.<br /> | ||
<br /> | <br /> | ||
− | + | ''url'' parameter specifies the URL to download. This parameter is optional and if specified loading starts immediately.<br /> | |
<br /> | <br /> | ||
− | + | ''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 /> | |
+ | The default HTTP method is [[Special:MyLanguage/UrlLoader.GET|UrlLoader.GET]].<br /> | ||
<br /> | <br /> | ||
− | + | ''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 /> | |
− | |||
− | |||
− | |||
− | |||
− | |||
<br /> | <br /> | ||
+ | After loading is finished, loaded data is stored at ''event.data'' field of [[Special:MyLanguage/Event.COMPLETE|Event.COMPLETE]] event as string.<br /> | ||
+ | <br /></translate> | ||
<source lang="lua"> | <source lang="lua"> | ||
UrlLoader.new(url,method,headers,body) | UrlLoader.new(url,method,headers,body) | ||
</source> | </source> | ||
− | === Parameters === | + | === <translate>Parameters</translate> === |
− | '''url''': (string, optional) URL to download. This parameter is optional and if specified loading starts immediately. <br/> | + | '''url''': (string, optional) <translate>URL to download. This parameter is optional and if specified loading starts immediately.</translate> <br/> |
− | '''method''': (string, default = | + | '''method''': (string, default = "get") <translate>HTTP request method.</translate> <br/> |
− | '''headers''': (table, optional) HTTP headers. <br/> | + | '''headers''': (table, optional) <translate>HTTP headers.</translate> <br/> |
− | '''body''': (string, optional) HTTP body data. This data is sent as the message body of a request. <br/> | + | '''body''': (string, optional) <translate>HTTP body data. This data is sent as the message body of a request.</translate> <br/> |
− | === Examples === | + | === <translate>Examples</translate> === |
'''Example'''<br/> | '''Example'''<br/> | ||
− | <source lang="lua">local url = | + | <source lang="lua">local url = "http://www.[yourDomain].com/application.php?userid=gideros&login=guest" |
− | + | ||
− | local loader1 = UrlLoader.new(url) | + | local loader1 = UrlLoader.new(url) |
− | local loader2 = UrlLoader.new(url, UrlLoader.GET) -- same as the previous line | + | local loader2 = UrlLoader.new(url, UrlLoader.GET) -- same as the previous line |
− | local loader3 = UrlLoader.new(url, UrlLoader.POST, | + | local loader3 = UrlLoader.new(url, UrlLoader.POST, "my post data") |
− | local loader4 = UrlLoader.new(url, UrlLoader.PUT, | + | local loader4 = UrlLoader.new(url, UrlLoader.PUT, "my put data") |
− | local loader5 = UrlLoader.new(url, UrlLoader.DELETE) | + | local loader5 = UrlLoader.new(url, UrlLoader.DELETE) |
− | + | ||
− | local headers = { | + | local headers = { |
− | [ | + | ["Content-Type"] = "application/x-www-form-urlencoded", |
− | [ | + | ["User-Agent"] = "Gideros Browser", |
− | } | + | } |
− | local loader6 = UrlLoader.new(url, UrlLoader.PUT, headers, | + | local loader6 = UrlLoader.new(url, UrlLoader.PUT, headers, "key=value")</source> |
+ | |||
+ | {{UrlLoader}} |
Revision as of 02:49, 4 December 2019
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 = "http://www.[yourDomain].com/application.php?userid=gideros&login=guest"
local loader1 = UrlLoader.new(url)
local loader2 = UrlLoader.new(url, UrlLoader.GET) -- same as the previous line
local loader3 = UrlLoader.new(url, UrlLoader.POST, "my post data")
local loader4 = UrlLoader.new(url, UrlLoader.PUT, "my put data")
local loader5 = UrlLoader.new(url, UrlLoader.DELETE)
local headers = {
["Content-Type"] = "application/x-www-form-urlencoded",
["User-Agent"] = "Gideros Browser",
}
local loader6 = UrlLoader.new(url, UrlLoader.PUT, headers, "key=value")