Package | com.myflashlab.air.extensions.firebase.storage |
Class | public class StorageTask |
Inheritance | StorageTask flash.events.EventDispatcher |
Subclasses | FileDownloadTask, UploadTask |
Property | Defined By | ||
---|---|---|---|
exception : String [read-only]
Returns the exception that caused the Task to fail. | StorageTask |
Method | Defined By | ||
---|---|---|---|
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [override] | StorageTask | ||
cancel():void
Attempts to cancel the task. | StorageTask | ||
pause():void
Attempts to pause the task. | StorageTask | ||
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void [override] | StorageTask | ||
resume():void
Attempts to resume a paused task. | StorageTask | ||
updateSnapshot():void
Updates the current state of the task. | StorageTask |
exception | property |
exception:String
[read-only] Returns the exception that caused the Task to fail. Returns null if the Task is not yet complete, or completed successfully.
public function get exception():String
addEventListener | () | method |
override public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Parameters
type:String | |
listener:Function | |
useCapture:Boolean (default = false )
| |
priority:int (default = 0 )
| |
useWeakReference:Boolean (default = false )
|
cancel | () | method |
public function cancel():void
Attempts to cancel the task. A canceled task cannot be resumed later.
pause | () | method |
public function pause():void
Attempts to pause the task. A paused task can later be resumed.
NOTE: There is a known bug on the ios side explained here: https://github.com/firebase/quickstart-ios/issues/88
removeEventListener | () | method |
override public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Parameters
type:String | |
listener:Function | |
useCapture:Boolean (default = false )
|
resume | () | method |
public function resume():void
Attempts to resume a paused task.
updateSnapshot | () | method |
public function updateSnapshot():void
Updates the current state of the task. This method will return state at any point of the tasks execution and may not be the final result.