ControllableTask

Also: Google Play services

public abstract class ControllableTask extends CancellableTask<StateT>

Known Direct Subclasses StorageTask<ResultT extends StorageTask.ProvideError> StorageTask<ResultT extends StorageTask.ProvideError> A controllable Task that has a synchronized state machine.

Known Indirect Subclasses FileDownloadTask, StreamDownloadTask, UploadTask FileDownloadTask A task that downloads bytes of a GCS blob to a specified File.  StreamDownloadTask A task that downloads bytes of a GCS blob.  UploadTask An controllable task that uploads and fires events for success, progress and failure.

Represents an asynchronous operation that can be paused, resumed and canceled. This task also receives progress and other state change notifications.

Public Constructor Summary

ControllableTask()

Public Method Summary

abstract ControllableTask<StateT>	addOnPausedListener(Activity activity, OnPausedListener<? super StateT> listener) Adds a listener that is called when the Task becomes paused.
abstract ControllableTask<StateT>	addOnPausedListener(OnPausedListener<? super StateT> listener) Adds a listener that is called when the Task becomes paused.
abstract ControllableTask<StateT>	addOnPausedListener(Executor executor, OnPausedListener<? super StateT> listener) Adds a listener that is called when the Task becomes paused.
abstract boolean	isPaused()
abstract boolean	pause() Attempts to pause the task.
abstract boolean	resume() Attempts to resume this task.

Inherited Method Summary

From class com.google.firebase.storage.CancellableTask

abstract CancellableTask<StateT>	addOnProgressListener(OnProgressListener<? super StateT> listener) Adds a listener that is called periodically while the ControllableTask executes.
abstract CancellableTask<StateT>	addOnProgressListener(Activity activity, OnProgressListener<? super StateT> listener) Adds a listener that is called periodically while the ControllableTask executes.
abstract CancellableTask<StateT>	addOnProgressListener(Executor executor, OnProgressListener<? super StateT> listener) Adds a listener that is called periodically while the ControllableTask executes.
abstract boolean	cancel() Attempts to cancel the task.
abstract boolean	isCanceled()
abstract boolean	isInProgress()

From class com.google.android.gms.tasks.Task

Task<StateT>	addOnCanceledListener(OnCanceledListener arg0)
Task<StateT>	addOnCanceledListener(Executor arg0, OnCanceledListener arg1)
Task<StateT>	addOnCanceledListener(Activity arg0, OnCanceledListener arg1)
Task<StateT>	addOnCompleteListener(OnCompleteListener<StateT> arg0)
Task<StateT>	addOnCompleteListener(Activity arg0, OnCompleteListener<StateT> arg1)
Task<StateT>	addOnCompleteListener(Executor arg0, OnCompleteListener<StateT> arg1)
abstract Task<StateT>	addOnFailureListener(Activity arg0, OnFailureListener arg1)
abstract Task<StateT>	addOnFailureListener(OnFailureListener arg0)
abstract Task<StateT>	addOnFailureListener(Executor arg0, OnFailureListener arg1)
abstract Task<StateT>	addOnSuccessListener(Executor arg0, OnSuccessListener<? super TResult> arg1)
abstract Task<StateT>	addOnSuccessListener(OnSuccessListener<? super TResult> arg0)
abstract Task<StateT>	addOnSuccessListener(Activity arg0, OnSuccessListener<? super TResult> arg1)
<TContinuationResult> Task<TContinuationResult>	continueWith(Continuation<StateT, TContinuationResult> arg0)
<TContinuationResult> Task<TContinuationResult>	continueWith(Executor arg0, Continuation<StateT, TContinuationResult> arg1)
<TContinuationResult> Task<TContinuationResult>	continueWithTask(Continuation<StateT, Task<TContinuationResult>> arg0)
<TContinuationResult> Task<TContinuationResult>	continueWithTask(Executor arg0, Continuation<StateT, Task<TContinuationResult>> arg1)
abstract Exception	getException()
abstract StateT	getResult()
abstract <X extends Throwable> StateT	getResult(Class<X> arg0)
abstract boolean	isCanceled()
abstract boolean	isComplete()
abstract boolean	isSuccessful()
<TContinuationResult> Task<TContinuationResult>	onSuccessTask(Executor arg0, SuccessContinuation<StateT, TContinuationResult> arg1)
<TContinuationResult> Task<TContinuationResult>	onSuccessTask(SuccessContinuation<StateT, TContinuationResult> arg0)

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Constructors

public ControllableTask ()

Also: Google Play services

Public Methods

public abstract ControllableTask<StateT> addOnPausedListener (Activity activity, OnPausedListener<? super StateT> listener)

Adds a listener that is called when the Task becomes paused.

Parameters

activity	When the supplied Activity stops, this listener will automatically be removed.
listener

Returns

• this Task

public abstract ControllableTask<StateT> addOnPausedListener (OnPausedListener<? super StateT> listener)

Adds a listener that is called when the Task becomes paused.

Returns

• this Task

public abstract ControllableTask<StateT> addOnPausedListener (Executor executor, OnPausedListener<? super StateT> listener)

Adds a listener that is called when the Task becomes paused.

Parameters

executor	the executor to use to call the listener
listener

Returns

• this Task

public abstract boolean isPaused ()

Also: Google Play services

Returns

• true if the task has been paused.

public abstract boolean pause ()

Also: Google Play services

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

Returns

• true if this task was successfully paused or is in the process of being paused. Returns false if the task is already completed or in a state that cannot be paused.

public abstract boolean resume ()

Also: Google Play services

Attempts to resume this task.

Returns

• true if the task is successfully resumed or is in the process of being resumed. Returns false if the task is already completed or in a state that cannot be resumed.