Difference between revisions of "UrlLoader"
(4 intermediate revisions by the same user not shown) | |||
Line 5: | Line 5: | ||
'''<translate>Available since</translate>:''' Gideros 2012.2.2<br/> | '''<translate>Available since</translate>:''' Gideros 2012.2.2<br/> | ||
'''<translate>Inherits from</translate>:''' [[Special:MyLanguage/Object|Object]]<br/> | '''<translate>Inherits from</translate>:''' [[Special:MyLanguage/Object|Object]]<br/> | ||
+ | |||
=== <translate>Description</translate> === | === <translate>Description</translate> === | ||
− | + | The [[Special:MyLanguage/UrlLoader|UrlLoader]] class is used to download data from an URL. It can be used to download (and optionally save) text files, XML files, JSON files, image files or binary files, etc. | |
− | The [[Special:MyLanguage/UrlLoader|UrlLoader]] class is used to download data from an URL. It can be used to download (and optionally save) text files, XML files, JSON files, image files or binary files, etc. | + | |
− | Downloaded data is delivered at ''event.data'' field of [[Special:MyLanguage/Event.COMPLETE|Event.COMPLETE]] event as string. Lua is eight-bit clean and so strings may contain characters with any numeric value, including embedded zeros. That means that you can store any binary data into a string.< | + | Downloaded data is delivered at ''event.data'' field of [[Special:MyLanguage/Event.COMPLETE|Event.COMPLETE]] event as string. Lua is eight-bit clean and so strings may contain characters with any numeric value, including embedded zeros. That means that you can store any binary data into a string. |
+ | |||
+ | ==== HTTP Request Methods ==== | ||
+ | UrlLoader supports GET, POST, PUT and DELETE methods. These are defined by these string constants: | ||
+ | <ul> | ||
+ | <li>''UrlLoader.GET = "get"''</li> | ||
+ | <li>''UrlLoader.POST = "post"''</li> | ||
+ | <li>''UrlLoader.PUT = "put"''</li> | ||
+ | <li>''UrlLoader.DELETE = "delete"''</li> | ||
+ | </ul> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
=== <translate>Examples</translate> === | === <translate>Examples</translate> === | ||
− | '''The example below shows downloading an image file from an URL, saving it to the documents folder and displaying it | + | '''The example below shows downloading an image file from an URL, saving it to the documents folder and displaying it on the stage. This example also shows downloading progress and handling errors:''' |
− | on the stage. This example also shows downloading progress and handling errors | + | <source lang="lua"> |
− | + | local loader = UrlLoader.new("http://example.com/image.png") | |
− | <source lang="lua">local loader = UrlLoader.new("http://example.com/image.png") | ||
local function onComplete(event) | local function onComplete(event) | ||
Line 46: | Line 44: | ||
loader:addEventListener(Event.COMPLETE, onComplete) | loader:addEventListener(Event.COMPLETE, onComplete) | ||
loader:addEventListener(Event.ERROR, onError) | loader:addEventListener(Event.ERROR, onError) | ||
− | loader:addEventListener(Event.PROGRESS, onProgress)</source> | + | loader:addEventListener(Event.PROGRESS, onProgress) |
− | '''Uploading a file''' | + | </source> |
− | <source lang="lua">local filename = "crate.png" | + | |
+ | '''Uploading a file:''' | ||
+ | <source lang="lua"> | ||
+ | local filename = "crate.png" | ||
local file = io.open(filename, "rb") | local file = io.open(filename, "rb") | ||
local contents = file:read( "*a" ) | local contents = file:read( "*a" ) | ||
Line 69: | Line 70: | ||
loader:addEventListener(Event.COMPLETE, function(e) | loader:addEventListener(Event.COMPLETE, function(e) | ||
print(e.data) | print(e.data) | ||
− | end)</source> | + | end) |
+ | </source> | ||
+ | |||
{|- | {|- | ||
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
Line 77: | Line 80: | ||
[[Special:MyLanguage/UrlLoader:ignoreSslErrors|UrlLoader:ignoreSslErrors]] ''<translate>Ignores SSL certificate related errors</translate>''<br/><!-- GIDEROSMTD:UrlLoader:ignoreSslErrors() Ignores SSL certificate related errors --> | [[Special:MyLanguage/UrlLoader:ignoreSslErrors|UrlLoader:ignoreSslErrors]] ''<translate>Ignores SSL certificate related errors</translate>''<br/><!-- GIDEROSMTD:UrlLoader:ignoreSslErrors() Ignores SSL certificate related errors --> | ||
[[Special:MyLanguage/UrlLoader:load|UrlLoader:load]] ''<translate>loads data from the specified URL</translate>''<br/><!-- GIDEROSMTD:UrlLoader:load(url,method,headers,body) loads data from the specified URL --> | [[Special:MyLanguage/UrlLoader:load|UrlLoader:load]] ''<translate>loads data from the specified URL</translate>''<br/><!-- GIDEROSMTD:UrlLoader:load(url,method,headers,body) loads data from the specified URL --> | ||
+ | |||
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
=== <translate>Events</translate> === | === <translate>Events</translate> === | ||
− | [[Special:MyLanguage/Event.COMPLETE|Event.COMPLETE]]<br/><!-- GIDEROSEVT:Event.COMPLETE complete--> | + | <!--[[Special:MyLanguage/Event.COMPLETE|Event.COMPLETE]]<br/>--> |
− | [[Special:MyLanguage/Event.ERROR|Event.ERROR]]<br/><!-- GIDEROSEVT:Event.ERROR error--> | + | [[Special:MyLanguage/UrlLoader_Event.COMPLETE|UrlLoader_Event.COMPLETE]]<br/> |
− | [[Special:MyLanguage/Event.PROGRESS|Event.PROGRESS]]<br/><!-- GIDEROSEVT:Event.PROGRESS progress--> | + | <!-- GIDEROSEVT:Event.COMPLETE complete--> |
+ | [[Special:MyLanguage/Event.ERROR|Event.ERROR]]<br/> | ||
+ | <!-- GIDEROSEVT:Event.ERROR error--> | ||
+ | [[Special:MyLanguage/Event.PROGRESS|Event.PROGRESS]]<br/> | ||
+ | <!-- GIDEROSEVT:Event.PROGRESS progress--> | ||
=== <translate>Constants</translate> === | === <translate>Constants</translate> === | ||
[[Special:MyLanguage/UrlLoader.DELETE|UrlLoader.DELETE]]<br/><!-- GIDEROSCST:UrlLoader.DELETE delete--> | [[Special:MyLanguage/UrlLoader.DELETE|UrlLoader.DELETE]]<br/><!-- GIDEROSCST:UrlLoader.DELETE delete--> | ||
Line 89: | Line 97: | ||
|} | |} | ||
− | {{ | + | {{GIDEROS IMPORTANT LINKS}} |
Revision as of 20:06, 11 February 2020
Supported platforms:
Available since: Gideros 2012.2.2
Inherits from: Object
Description
The UrlLoader class is used to download data from an URL. It can be used to download (and optionally save) text files, XML files, JSON files, image files or binary files, etc.
Downloaded data is delivered at event.data field of Event.COMPLETE event as string. Lua is eight-bit clean and so strings may contain characters with any numeric value, including embedded zeros. That means that you can store any binary data into a string.
HTTP Request Methods
UrlLoader supports GET, POST, PUT and DELETE methods. These are defined by these string constants:
- UrlLoader.GET = "get"
- UrlLoader.POST = "post"
- UrlLoader.PUT = "put"
- UrlLoader.DELETE = "delete"
Examples
The example below shows downloading an image file from an URL, saving it to the documents folder and displaying it on the stage. This example also shows downloading progress and handling errors:
local loader = UrlLoader.new("http://example.com/image.png")
local function onComplete(event)
local out = io.open("|D|image.png", "wb")
out:write(event.data)
out:close()
local b = Bitmap.new(Texture.new("|D|image.png"))
stage:addChild(b)
end
local function onError()
print("error")
end
local function onProgress(event)
print("progress: " .. event.bytesLoaded .. " of " .. event.bytesTotal)
end
loader:addEventListener(Event.COMPLETE, onComplete)
loader:addEventListener(Event.ERROR, onError)
loader:addEventListener(Event.PROGRESS, onProgress)
Uploading a file:
local filename = "crate.png"
local file = io.open(filename, "rb")
local contents = file:read( "*a" )
local boundary = "somerndstring"
local send = "--"..boundary..
"\r\nContent-Disposition: form-data; "..
"name="..filename.."; filename="..filename..
"\r\nContent-type: image/png"..
"\r\n\r\n"..contents..
"\r\n--"..boundary.."--\r\n";
local headers = {
["Content-Type"] = "multipart/form-data; boundary="..boundary,
["Content-Length"] = #send,
}
local loader = UrlLoader.new("http://localhost/gideros.php", UrlLoader.POST, headers, send)
loader:addEventListener(Event.COMPLETE, function(e)
print(e.data)
end)
MethodsUrlLoader.new creates a new UrlLoader object |
EventsUrlLoader_Event.COMPLETE Constants |