public abstract class

Task

extends Object
java.lang.Object
   ↳ com.google.android.gms.tasks.Task<TResult>
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Represents an asynchronous operation.

Summary

Public Constructors
Task()
Public Methods
Task<TResult> addOnCompleteListener(OnCompleteListener<TResult> listener)
Adds a listener that is called when the Task completes.
Task<TResult> addOnCompleteListener(Activity activity, OnCompleteListener<TResult> listener)
Adds an Activity-scoped listener that is called when the Task completes.
Task<TResult> addOnCompleteListener(Executor executor, OnCompleteListener<TResult> listener)
Adds a listener that is called when the Task completes.
abstract Task<TResult> addOnFailureListener(Activity activity, OnFailureListener listener)
Adds an Activity-scoped listener that is called if the Task fails.
abstract Task<TResult> addOnFailureListener(OnFailureListener listener)
Adds a listener that is called if the Task fails.
abstract Task<TResult> addOnFailureListener(Executor executor, OnFailureListener listener)
Adds a listener that is called if the Task fails.
abstract Task<TResult> addOnSuccessListener(Executor executor, OnSuccessListener<? super TResult> listener)
Adds a listener that is called if the Task completes successfully.
abstract Task<TResult> addOnSuccessListener(OnSuccessListener<? super TResult> listener)
Adds a listener that is called if the Task completes successfully.
abstract Task<TResult> addOnSuccessListener(Activity activity, OnSuccessListener<? super TResult> listener)
Adds an Activity-scoped listener that is called if the Task completes successfully.
<TContinuationResult> Task<TContinuationResult> continueWith(Continuation<TResult, TContinuationResult> continuation)
Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
<TContinuationResult> Task<TContinuationResult> continueWith(Executor executor, Continuation<TResult, TContinuationResult> continuation)
Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
<TContinuationResult> Task<TContinuationResult> continueWithTask(Continuation<TResult, Task<TContinuationResult>> continuation)
Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
<TContinuationResult> Task<TContinuationResult> continueWithTask(Executor executor, Continuation<TResult, Task<TContinuationResult>> continuation)
Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
abstract Exception getException()
Returns the exception that caused the Task to fail.
abstract TResult getResult()
Gets the result of the Task, if it has already completed.
abstract <X extends Throwable> TResult getResult(Class<X> exceptionType)
Gets the result of the Task, if it has already completed.
abstract boolean isComplete()
Returns true if the Task is complete; false otherwise.
abstract boolean isSuccessful()
Returns true if the Task has completed successfully; false otherwise.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Task ()

Public Methods

public Task<TResult> addOnCompleteListener (OnCompleteListener<TResult> listener)

Adds a listener that is called when the Task completes.

The listener will be called on main application thread. If the Task is already complete, 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.

Parameters
listener OnCompleteListener
Returns
Task<TResult> this Task

public Task<TResult> addOnCompleteListener (Activity activity, OnCompleteListener<TResult> listener)

Adds an Activity-scoped listener that is called when the Task completes.

The listener will be called on main application thread. If the Task is already complete, 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.

The listener will be automatically removed during onStop().

Parameters
activity Activity
listener OnCompleteListener
Returns
Task<TResult> this Task

public Task<TResult> addOnCompleteListener (Executor executor, OnCompleteListener<TResult> listener)

Adds a listener that is called when the Task completes.

If the Task is already complete, 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.

Parameters
executor Executor: the executor to use to call the listener
listener OnCompleteListener
Returns
Task<TResult> this Task

public abstract Task<TResult> addOnFailureListener (Activity activity, OnFailureListener listener)

Adds an Activity-scoped 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.

The listener will be automatically removed during onStop().

Parameters
activity Activity
listener OnFailureListener
Returns
Task<TResult> this Task

public abstract Task<TResult> addOnFailureListener (OnFailureListener listener)

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.

Parameters
listener OnFailureListener
Returns
Task<TResult> this Task

public abstract Task<TResult> addOnFailureListener (Executor executor, OnFailureListener listener)

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.

Parameters
executor Executor: the executor to use to call the listener
listener OnFailureListener
Returns
Task<TResult> this Task

public abstract Task<TResult> addOnSuccessListener (Executor executor, OnSuccessListener<? super TResult> listener)

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.

Parameters
executor Executor: the executor to use to call the listener
listener OnSuccessListener
Returns
Task<TResult> this Task

public abstract Task<TResult> addOnSuccessListener (OnSuccessListener<? super TResult> listener)

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.

Parameters
listener OnSuccessListener
Returns
Task<TResult> this Task

public abstract Task<TResult> addOnSuccessListener (Activity activity, OnSuccessListener<? super TResult> listener)

Adds an Activity-scoped 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.

The listener will be automatically removed during onStop().

Parameters
activity Activity
listener OnSuccessListener
Returns
Task<TResult> this Task

public Task<TContinuationResult> continueWith (Continuation<TResult, TContinuationResult> continuation)

Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.

The Continuation will be called on the main application thread.

Parameters
continuation Continuation
Returns
Task<TContinuationResult>

See also:

public Task<TContinuationResult> continueWith (Executor executor, Continuation<TResult, TContinuationResult> continuation)

Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.

Parameters
executor Executor: the executor to use to call the Continuation
continuation Continuation
Returns
Task<TContinuationResult>

See also:

public Task<TContinuationResult> continueWithTask (Continuation<TResult, Task<TContinuationResult>> continuation)

Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.

The Continuation will be called on the main application thread.

Parameters
continuation Continuation
Returns
Task<TContinuationResult>

See also:

public Task<TContinuationResult> continueWithTask (Executor executor, Continuation<TResult, Task<TContinuationResult>> continuation)

Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.

Parameters
executor Executor: the executor to use to call the Continuation
continuation Continuation
Returns
Task<TContinuationResult>

See also:

public abstract Exception getException ()

Returns the exception that caused the Task to fail. Returns null if the Task is not yet complete, or completed successfully.

Returns
Exception

public abstract TResult getResult ()

Gets the result of the Task, if it has already completed.

Returns
TResult
Throws
IllegalStateException if the Task is not yet complete
RuntimeExecutionException if the Task failed with an exception

public abstract TResult getResult (Class<X> exceptionType)

Gets the result of the Task, if it has already completed.

Parameters
exceptionType Class
Returns
TResult
Throws
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

public abstract boolean isComplete ()

Returns true if the Task is complete; false otherwise.

Returns
boolean

public abstract boolean isSuccessful ()

Returns true if the Task has completed successfully; false otherwise.

Returns
boolean