CancellableTask

Known Direct Subclasses

ControllableTask<TState>

Known Indirect Subclasses

FileDownloadTask, StorageTask<TResult extends StorageTask.ProvideError>, StreamDownloadTask, UploadTask

Represents an asynchronous operation that can be canceled.

Public Constructor Summary

CancellableTask()

Public Method Summary

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

Inherited Method Summary

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

Also: Google Play services

Public Methods

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

Also: Google Play services

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

Parameters

listener

Returns

this Task

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

Also: Google Play services

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 CancellableTask<TState> addOnProgressListener (Activity activity, OnProgressListener<? super TState> listener)

Also: Google Play services

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