ControllableTask

Known Direct Subclasses

StorageTask<TResult extends StorageTask.ProvideError>

Known Indirect Subclasses

FileDownloadTask, StreamDownloadTask, UploadTask

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<TState>	addOnPausedListener(Activity activity, OnPausedListener<? super TState> listener) Adds a listener that is called when the Task becomes paused.
abstract ControllableTask<TState>	addOnPausedListener(OnPausedListener<? super TState> listener) Adds a listener that is called when the Task becomes paused.
abstract ControllableTask<TState>	addOnPausedListener(Executor executor, OnPausedListener<? super TState> 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<TState>	addOnProgressListener(OnProgressListener<? super TState> listener) Adds a listener that is called periodically while the ControllableTask executes.
abstract CancellableTask<TState>	addOnProgressListener(Executor executor, OnProgressListener<? super TState> listener) Adds a listener that is called periodically while the ControllableTask executes.
abstract CancellableTask<TState>	addOnProgressListener(Activity activity, OnProgressListener<? super TState> 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<TState>	addOnCanceledListener(OnCanceledListener arg0)
Task<TState>	addOnCanceledListener(Executor arg0, OnCanceledListener arg1)
Task<TState>	addOnCanceledListener(Activity arg0, OnCanceledListener arg1)
Task<TState>	addOnCompleteListener(OnCompleteListener arg0)
Task<TState>	addOnCompleteListener(Activity arg0, OnCompleteListener arg1)
Task<TState>	addOnCompleteListener(Executor arg0, OnCompleteListener arg1)
abstract Task<TState>	addOnFailureListener(Activity arg0, OnFailureListener arg1)
abstract Task<TState>	addOnFailureListener(OnFailureListener arg0)
abstract Task<TState>	addOnFailureListener(Executor arg0, OnFailureListener arg1)
abstract Task<TState>	addOnSuccessListener(Executor arg0, OnSuccessListener arg1)
abstract Task<TState>	addOnSuccessListener(OnSuccessListener arg0)
abstract Task<TState>	addOnSuccessListener(Activity arg0, OnSuccessListener arg1)
<TContinuationResult> Task<TContinuationResult>	continueWith(Continuation arg0)
<TContinuationResult> Task<TContinuationResult>	continueWith(Executor arg0, Continuation arg1)
<TContinuationResult> Task<TContinuationResult>	continueWithTask(Continuation arg0)
<TContinuationResult> Task<TContinuationResult>	continueWithTask(Executor arg0, Continuation arg1)
abstract Exception	getException()
abstract TState	getResult()
abstract <X extends Throwable> TState	getResult(Class arg0)
abstract boolean	isCanceled()
abstract boolean	isComplete()
abstract boolean	isSuccessful()
<TContinuationResult> Task<TContinuationResult>	onSuccessTask(Executor arg0, SuccessContinuation arg1)
<TContinuationResult> Task<TContinuationResult>	onSuccessTask(SuccessContinuation 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<TState> addOnPausedListener (Activity activity, OnPausedListener<? super TState> listener)

Also: Google Play services

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<TState> addOnPausedListener (OnPausedListener<? super TState> listener)

Also: Google Play services

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

Parameters

listener

Returns

this Task

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

Also: Google Play services

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.