blob: 4fdfa3c758f253cc886cb760603e75de898b7a57 [file] [log] [blame]
{ "type": "class",
"qname": "org.apache.royale.net.URLUploadStream",
"baseClassname": "org.apache.royale.net.URLStream"
,
"description": "The URLUploadStream extends the URLStream class to support upload progress events. This class is only used for JS implementations because Flash upload events need to be handled differently. In Flash, URLLoader does not dispatch upload events. It only dispatches download events. To get upload events in Flash, you need to use File/FileReference.upload() and attach event listeners to that. Care should be taken when using this class because it attaches a progress listener to the xhr.upload object. Doing so causes browsers to send OPTIONS requests. This will return an unauthorized response from servers not configured to allow CORS OPTIONS requests. See this S.O. post for details. https://stackoverflow.com/a/17057853",
"tags": [
{ "tagName": "see",
"values": ["URLStream"]},
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.9.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"members": [
{ "type": "method",
"qname": "org.apache.royale.net.URLUploadStream",
"namespace": "",
"bindable": [],
"details": [],
"deprecated": {},
"return": "",
"params": []}
,
{ "type": "method",
"qname": "cleanupCallbacks",
"namespace": "protected",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "Cleanup all callbacks.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.7.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": []}
,
{ "type": "field",
"qname": "onUploadProgress",
"return": "Function",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Callback for upload progress event.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.7.0"]},
{ "tagName": "langversion",
"values": ["3.0"]},
{ "tagName": "royalesuppresspublicvarwarning",
"values": []} ]},
{ "type": "method",
"qname": "uploadProgress",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Convenience function for upload progress event to allow chaining.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.7.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "org.apache.royale.net.URLStream",
"params": [{ "name": "callback", "type": "Function"}]}
]
}