| java.lang.Object | ||||
| ↳ | com.google.android.gms.tasks.Task<TResult extends com.google.firebase.storage.StorageTask.ProvideError> | |||
| ↳ | com.google.firebase.storage.CancellableTask<TResult extends com.google.firebase.storage.StorageTask.ProvideError> | |||
| ↳ | com.google.firebase.storage.ControllableTask<TResult extends com.google.firebase.storage.StorageTask.ProvideError> | |||
| ↳ | com.google.firebase.storage.StorageTask<TResult extends com.google.firebase.storage.StorageTask.ProvideError> | |||
Known Direct Subclasses
|
A controllable Task that has a synchronized state machine.
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| StorageTask.ProvideError | an object that returns an exception. | ||||||||||
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| mSyncObject | |||||||||||
| Protected Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Adds a listener that is called if the Task fails.
| |||||||||||
Adds a listener that is called if the Task fails.
| |||||||||||
Adds a listener that is called if the Task fails.
| |||||||||||
Adds a listener that is called when the Task becomes paused.
| |||||||||||
Adds a listener that is called when the Task becomes paused.
| |||||||||||
Adds a listener that is called when the Task becomes paused.
| |||||||||||
Adds a listener that is called periodically while the ControllableTask executes.
| |||||||||||
Adds a listener that is called periodically while the ControllableTask executes.
| |||||||||||
Adds a listener that is called periodically while the ControllableTask executes.
| |||||||||||
Adds a listener that is called if the Task completes successfully.
| |||||||||||
Adds a listener that is called if the Task completes successfully.
| |||||||||||
Adds a listener that is called if the Task completes successfully.
| |||||||||||
Attempts to cancel the task.
| |||||||||||
Returns the exception that caused the Task to fail.
| |||||||||||
Gets the result of the Task, if it has already completed.
| |||||||||||
Gets the result of the Task, if it has already completed.
| |||||||||||
Returns
true if the Task is complete; false otherwise. | |||||||||||
Returns
true if the Task has completed successfully; false otherwise. | |||||||||||
Attempts to pause the task.
| |||||||||||
Removes a listener.
| |||||||||||
Removes a listener.
| |||||||||||
Removes a listener.
| |||||||||||
Removes a listener.
| |||||||||||
Attempts to resume a paused task.
| |||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.google.firebase.storage.ControllableTask
| |||||||||||
From class
com.google.firebase.storage.CancellableTask
| |||||||||||
From class
com.google.android.gms.tasks.Task
| |||||||||||
From class
java.lang.Object
| |||||||||||
Adds a listener that is called if the Task fails.
If the task has already failed, a call to the listener will be immediately scheduled. If multiple listeners are added, they will be called in the order in which they were added.
| activity | When the supplied Activity stops, this listener will automatically
be removed. |
|---|
Adds a listener that is called if the Task fails.
The listener will be called on main application thread. If the task has already failed, a call to the listener will be immediately scheduled. If multiple listeners are added, they will be called in the order in which they were added.
Adds a listener that is called if the Task fails.
If the task has already failed, a call to the listener will be immediately scheduled. If multiple listeners are added, they will be called in the order in which they were added.
| executor | the executor to use to call the listener |
|---|
Adds a listener that is called when the Task becomes paused.
| executor | the executor to use to call the listener |
|---|
Adds a listener that is called when the Task becomes paused.
| activity | When the supplied Activity stops, this listener will automatically
be removed. |
|---|
Adds a listener that is called when the Task becomes paused.
Adds a listener that is called periodically while the ControllableTask executes.
| executor | the executor to use to call the listener |
|---|
Adds a listener that is called periodically while the ControllableTask executes.
Adds a listener that is called periodically while the ControllableTask executes.
| activity | When the supplied Activity stops, this listener will automatically
be removed. |
|---|
Adds a listener that is called if the Task completes successfully.
The listener will be called on the main application thread. If the task has already completed successfully, a call to the listener will be immediately scheduled. If multiple listeners are added, they will be called in the order in which they were added.
Adds a listener that is called if the Task completes successfully.
If multiple listeners are added, they will be called in the order in which they were added. If the task has already completed successfully, a call to the listener will be immediately scheduled.
| activity | When the supplied Activity stops, this listener will automatically
be removed. |
|---|
Adds a listener that is called if the Task completes successfully.
If multiple listeners are added, they will be called in the order in which they were added. If the task has already completed successfully, a call to the listener will be immediately scheduled.
| executor | the executor to use to call the listener |
|---|
Attempts to cancel the task. A canceled task cannot be resumed later.
Returns the exception that caused the Task to fail. Returns null
if the Task is not yet complete, or completed successfully.
Gets the result of the Task, if it has already completed.
| IllegalStateException | if the Task is not yet complete |
|---|---|
| RuntimeExecutionException | if the Task failed with an exception |
Gets the result of the Task, if it has already completed.
| IllegalStateException | if the Task is not yet complete |
|---|---|
| if the Task failed with an exception of type X | |
| RuntimeExecutionException | if the Task failed with an exception that was not of type X |
| Throwable |
Returns true if the Task is complete; false otherwise.
Returns true if the Task has completed successfully; false otherwise.
Attempts to pause the task. A paused task can later be resumed.
Removes a listener.
Removes a listener.
Removes a listener.
Removes a listener.
Attempts to resume a paused task.