CancellableTask

Also: Google Play services

public abstract class CancellableTask extends Task<StateT>

Known Direct Subclasses ControllableTask<StateT> ControllableTask<StateT> Represents an asynchronous operation that can be paused, resumed and canceled.

Known Indirect Subclasses FileDownloadTask, StorageTask<ResultT extends StorageTask.ProvideError>, StreamDownloadTask, UploadTask FileDownloadTask A task that downloads bytes of a GCS blob to a specified File.  StorageTask<ResultT extends StorageTask.ProvideError> A controllable Task that has a synchronized state machine.  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 canceled.

Public Constructor Summary

CancellableTask()

Public Method Summary

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()

Inherited Method Summary

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 CancellableTask ()

Also: Google Play services

Public Methods

public abstract CancellableTask<StateT> addOnProgressListener (OnProgressListener<? super StateT> listener)

Adds a listener that is called periodically while the ControllableTask executes.

Returns

• this Task

public abstract CancellableTask<StateT> addOnProgressListener (Activity activity, OnProgressListener<? super StateT> listener)

Adds a listener that is called periodically while the ControllableTask executes.

Parameters

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

Returns

• this Task

public abstract CancellableTask<StateT> addOnProgressListener (Executor executor, OnProgressListener<? super StateT> listener)

Adds a listener that is called periodically while the ControllableTask executes.

Parameters

executor	the executor to use to call the listener
listener

Returns

• this Task

public abstract boolean cancel ()

Also: Google Play services

Attempts to cancel the task. A canceled task cannot be resumed later. A canceled task calls back on listeners subscribed to addOnFailureListener(OnFailureListener) with an exception that indicates the task was canceled.

Returns

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

public abstract boolean isCanceled ()

Also: Google Play services

Returns

• true if the task has been canceled.

public abstract boolean isInProgress ()

Also: Google Play services

Returns

• true if the task is currently running.