Difference between revisions of "UrlLoader"

 
(21 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
'''Supported platforms:''' android, ios, mac, pc<br/>
+
<languages />
'''Available since:''' Gideros 2012.2.2<br/>
+
<!-- GIDEROSOBJ:UrlLoader -->
=== Description ===
+
'''<translate>Supported platforms</translate>:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]][[File:Platform html5.png]][[File:Platform winrt.png]][[File:Platform win32.png]]<br/>
<br />
+
'''<translate>Available since</translate>:''' Gideros 2012.2.2<br/>
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.<br />
+
'''<translate>Inherits from</translate>:''' [[Special:MyLanguage/Object|Object]]<br/>
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.<br />
+
 
 +
=== <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.
 +
 
 +
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> ===
 +
'''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:'''
 +
<source lang="lua">
 +
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)
 +
</source>
 +
 
 +
'''Uploading a file:'''
 +
<source lang="lua">
 +
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)
 +
</source>
  
<h3>HTTP Request Methods</h3><br />
 
<br />
 
UrlLoader supports GET, POST, PUT and DELETE methods. These are defined by these string constants:<br />
 
<br />
 
<ul><br />
 
<li>`UrlLoader.GET = "get"`</li><br />
 
<li>`UrlLoader.POST = "post"`</li><br />
 
<li>`UrlLoader.PUT = "put"`</li><br />
 
<li>`UrlLoader.DELETE = "delete"`</li><br />
 
</ul><br />
 
<br />
 
 
{|-
 
{|-
| style="width: 50%;"|
+
| style="width: 50%; vertical-align:top;"|
=== Methods ===
+
=== <translate>Methods</translate> ===
[[UrlLoader.new]] - creates a new UrlLoader object<br/>
+
[[Special:MyLanguage/UrlLoader.new|UrlLoader.new]] ''<translate>creates a new UrlLoader object</translate>''<br/><!-- GIDEROSMTD:UrlLoader.new(url,method,headers,body) creates a new UrlLoader object -->
[[UrlLoader:close]] - terminates the current loading operation<br/>
+
[[Special:MyLanguage/UrlLoader:close|UrlLoader:close]] ''<translate>terminates the current loading operation</translate>''<br/><!-- GIDEROSMTD:UrlLoader:close() terminates the current loading operation -->
[[UrlLoader:ignoreSslErrors]] - Ignores SSL certificate related errors<br/>
+
[[Special:MyLanguage/UrlLoader:ignoreSslErrors|UrlLoader:ignoreSslErrors]] ''<translate>Ignores SSL certificate related errors</translate>''<br/><!-- GIDEROSMTD:UrlLoader:ignoreSslErrors() Ignores SSL certificate related errors -->
[[UrlLoader:load]] - loads data from the specified URL<br/>
+
[[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%;"|
+
 
=== Events ===
+
| style="width: 50%; vertical-align:top;"|
[[Event.COMPLETE]]<br/>
+
=== <translate>Events</translate> ===
[[Event.ERROR]]<br/>
+
<!--[[Special:MyLanguage/Event.COMPLETE|Event.COMPLETE]]<br/>-->
[[Event.PROGRESS]]<br/>
+
[[Special:MyLanguage/UrlLoader_Event.COMPLETE|UrlLoader_Event.COMPLETE]]<br/>
=== Constants ===
+
<!-- GIDEROSEVT:Event.COMPLETE complete-->
[[UrlLoader.DELETE]]<br/>
+
[[Special:MyLanguage/Event.ERROR|Event.ERROR]]<br/>
[[UrlLoader.GET]]<br/>
+
<!-- GIDEROSEVT:Event.ERROR error-->
[[UrlLoader.POST]]<br/>
+
[[Special:MyLanguage/Event.PROGRESS|Event.PROGRESS]]<br/>
[[UrlLoader.PUT]]<br/>
+
<!-- GIDEROSEVT:Event.PROGRESS progress-->
 +
=== <translate>Constants</translate> ===
 +
[[Special:MyLanguage/UrlLoader.DELETE|UrlLoader.DELETE]]<br/><!-- GIDEROSCST:UrlLoader.DELETE delete-->
 +
[[Special:MyLanguage/UrlLoader.GET|UrlLoader.GET]]<br/><!-- GIDEROSCST:UrlLoader.GET get-->
 +
[[Special:MyLanguage/UrlLoader.POST|UrlLoader.POST]]<br/><!-- GIDEROSCST:UrlLoader.POST post-->
 +
[[Special:MyLanguage/UrlLoader.PUT|UrlLoader.PUT]]<br/><!-- GIDEROSCST:UrlLoader.PUT put-->
 
|}
 
|}
 +
 +
{{GIDEROS IMPORTANT LINKS}}

Latest revision as of 21:06, 11 February 2020


Supported platforms: Platform android.pngPlatform ios.pngPlatform mac.pngPlatform pc.pngPlatform html5.pngPlatform winrt.pngPlatform win32.png
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)

Methods

UrlLoader.new creates a new UrlLoader object
UrlLoader:close terminates the current loading operation
UrlLoader:ignoreSslErrors Ignores SSL certificate related errors
UrlLoader:load loads data from the specified URL

Events

UrlLoader_Event.COMPLETE
Event.ERROR
Event.PROGRESS

Constants

UrlLoader.DELETE
UrlLoader.GET
UrlLoader.POST
UrlLoader.PUT