Difference between revisions of "UrlLoader.new"
From GiderosMobile
m (Text replacement - "<source" to "<syntaxhighlight") |
|||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
'''Available since:''' Gideros 2012.2.2<br/> | '''Available since:''' Gideros 2012.2.2<br/> | ||
| + | '''Class:''' [[UrlLoader]]<br/> | ||
| + | |||
=== Description === | === Description === | ||
| − | + | Creates a new '''UrlLoader''' object. | |
| − | Creates a new | + | <syntaxhighlight lang="lua"> |
| − | + | UrlLoader.new(url,method,headers,body) | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | < | ||
| − | |||
</source> | </source> | ||
| + | |||
| + | |||
| + | ''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 '''UrlLoader.PUT''' | ||
| + | |||
| + | |||
| + | After loading is finished, loaded data is stored as a string in the ''event.data'' field of [[Event.COMPLETE]] event. | ||
| + | |||
=== Parameters === | === Parameters === | ||
| − | '''url''': (string, optional) | + | '''url''': (string, optional) URL to download. This parameter is optional and if specified loading starts immediately<br/> |
| − | '''method''': (string, default = | + | '''method''': (string, default = "get") HTTP request method<br/> |
| − | '''headers''': (table, optional) | + | '''headers''': (table, optional) HTTP headers<br/> |
| − | '''body''': (string, optional) | + | '''body''': (string, optional) HTTP body data. This data is sent as the message body of a request<br/> |
| + | |||
=== Examples === | === Examples === | ||
| − | + | <syntaxhighlight 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}} | ||
Latest revision as of 14:32, 13 July 2023
Available since: Gideros 2012.2.2
Class: UrlLoader
Description
Creates a new UrlLoader object. <syntaxhighlight lang="lua"> UrlLoader.new(url,method,headers,body) </source>
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 UrlLoader.PUT
After loading is finished, loaded data is stored as a string in the event.data field of Event.COMPLETE event.
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
<syntaxhighlight lang="lua"> 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") </source>
