Packagecom.distriqt.extension.firebase.storage
Interfacepublic interface DownloadTask extends flash.events.IEventDispatcher

A task that downloads bytes of a Storage reference.


Public Methods
 MethodDefined By
  
cancel():Boolean
Attempts to cancel the task.
DownloadTask
  
getResult():DownloadTaskSnapshot
Gets the result of the Task, if it has already completed.
DownloadTask
  
getSnapshot():DownloadTaskSnapshot
Returns the current state of the task.
DownloadTask
  
isCanceled():Boolean
Returns true if the task has been canceled.
DownloadTask
  
isComplete():Boolean
Returns true if the Task is complete; false otherwise.
DownloadTask
  
isInProgress():Boolean
Returns true if the task is currently running.
DownloadTask
  
isPaused():Boolean
Returns true if the task has been paused.
DownloadTask
  
isSuccessful():Boolean
Returns true if the Task has completed successfully; false otherwise.
DownloadTask
  
pause():Boolean
Attempts to pause the task.
DownloadTask
  
resume():Boolean
Attempts to resume a paused task.
DownloadTask
Events
 Event Summary Defined By
  
downloadtask:complete
 DownloadTask
  
downloadtask:error
 DownloadTask
  
downloadtask:paused
 DownloadTask
  
downloadtask:progress
 DownloadTask
  
downloadtask:success
 DownloadTask
Method Detail
cancel()method
public function cancel():Boolean

Attempts to cancel the task. A canceled task cannot be resumed later.

Returns
Boolean — true if this task is successfully being canceled.
getResult()method 
public function getResult():DownloadTaskSnapshot

Gets the result of the Task, if it has already completed.

Returns
DownloadTaskSnapshot —
getSnapshot()method 
public function getSnapshot():DownloadTaskSnapshot

Returns 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..

Returns
DownloadTaskSnapshot —
isCanceled()method 
public function isCanceled():Boolean

Returns true if the task has been canceled.

Returns
Boolean —
isComplete()method 
public function isComplete():Boolean

Returns true if the Task is complete; false otherwise.

Returns
Boolean —
isInProgress()method 
public function isInProgress():Boolean

Returns true if the task is currently running.

Returns
Boolean — true if the task is currently running
isPaused()method 
public function isPaused():Boolean

Returns true if the task has been paused.

Returns
Boolean — true if the task has been paused
isSuccessful()method 
public function isSuccessful():Boolean

Returns true if the Task has completed successfully; false otherwise.

Returns
Boolean —
pause()method 
public function pause():Boolean

Attempts to pause the task. A paused task can later be resumed.

Returns
Boolean — true if this task is successfully being paused. Note that a task may not be immediately paused if it was executing another action and can still fail or complete.
resume()method 
public function resume():Boolean

Attempts to resume a paused task.

Returns
Boolean — true if the task is successfully resumed. false if the task has an unrecoverable error or has entered another state that precludes resume
Event Detail
downloadtask:complete Event
Event Object Type: com.distriqt.extension.firebase.storage.events.DownloadTaskEvent
DownloadTaskEvent.type property = com.distriqt.extension.firebase.storage.events.DownloadTaskEvent.COMPLETE

downloadtask:error Event  
Event Object Type: com.distriqt.extension.firebase.storage.events.DownloadTaskEvent
DownloadTaskEvent.type property = com.distriqt.extension.firebase.storage.events.DownloadTaskEvent.ERROR

downloadtask:paused Event  
Event Object Type: com.distriqt.extension.firebase.storage.events.DownloadTaskEvent
DownloadTaskEvent.type property = com.distriqt.extension.firebase.storage.events.DownloadTaskEvent.PAUSED

downloadtask:progress Event  
Event Object Type: com.distriqt.extension.firebase.storage.events.DownloadTaskEvent
DownloadTaskEvent.type property = com.distriqt.extension.firebase.storage.events.DownloadTaskEvent.PROGRESS

downloadtask:success Event  
Event Object Type: com.distriqt.extension.firebase.storage.events.DownloadTaskEvent
DownloadTaskEvent.type property = com.distriqt.extension.firebase.storage.events.DownloadTaskEvent.SUCCESS





Thu Feb 13 2025, 11:18 AM +10:00