LoadBundleTask
public classLoadBundleTask extendsTask
Represents the task of loading a Firestore bundle. It provides progress of bundle loading, as well as task completion and error events.
Summary
Public methods | |
|---|---|
@NonNullTask<LoadBundleTaskProgress> | addOnCanceledListener(@NonNullOnCanceledListener onCanceledListener)Adds a listener that is called if the |
@NonNullTask<LoadBundleTaskProgress> | addOnCanceledListener(Adds an Activity-scoped listener that is called if the |
@NonNullTask<LoadBundleTaskProgress> | addOnCanceledListener(Adds a listener that is called if the |
@NonNullTask<LoadBundleTaskProgress> | addOnCompleteListener(Adds a listener that is called when the |
@NonNullTask<LoadBundleTaskProgress> | addOnCompleteListener(Adds a listener that is called when the |
@NonNullTask<LoadBundleTaskProgress> | addOnCompleteListener(Adds a listener that is called when the |
@NonNullTask<LoadBundleTaskProgress> | addOnFailureListener(@NonNullOnFailureListener onFailureListener)Adds a listener that is called if the |
@NonNullTask<LoadBundleTaskProgress> | addOnFailureListener(Adds a listener that is called if the |
@NonNullTask<LoadBundleTaskProgress> | addOnFailureListener(Adds a listener that is called if the |
@NonNullLoadBundleTask | Adds a listener that is called periodically while the |
@NonNullLoadBundleTask | addOnProgressListener(Adds a listener that is called periodically while the |
@NonNullLoadBundleTask | addOnProgressListener(Adds a listener that is called periodically while the |
@NonNullTask<LoadBundleTaskProgress> | addOnSuccessListener(Adds a listener that is called if the |
@NonNullTask<LoadBundleTaskProgress> | addOnSuccessListener(Adds a listener that is called if the |
@NonNullTask<LoadBundleTaskProgress> | addOnSuccessListener(Adds a listener that is called if the |
@NonNullTask<TContinuationResult> | <TContinuationResult>continueWith(Returns a new |
@NonNullTask<TContinuationResult> | <TContinuationResult>continueWith(Returns a new |
@NonNullTask<TContinuationResult> | <TContinuationResult>continueWithTask(Returns a new |
@NonNullTask<TContinuationResult> | <TContinuationResult>continueWithTask(Returns a new |
@NullableException | Returns the exception that caused the |
@NonNullLoadBundleTaskProgress | Gets the result of the |
@NonNullLoadBundleTaskProgress | Gets the result of the |
boolean | Returns |
boolean | Returns |
boolean | Returns |
@NonNullTask<TContinuationResult> | <TContinuationResult>onSuccessTask(Returns a new |
@NonNullTask<TContinuationResult> | <TContinuationResult>onSuccessTask(Returns a new |
Public methods
addOnCanceledListener
public @NonNullTask<LoadBundleTaskProgress> addOnCanceledListener(@NonNullOnCanceledListener onCanceledListener)
Adds a listener that is called if theTask is canceled.
The listener will be called on main application thread. If theTask has already been canceled, 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.
| Returns | |
|---|---|
@NonNullTask<LoadBundleTaskProgress> | this |
addOnCanceledListener
public @NonNullTask<LoadBundleTaskProgress> addOnCanceledListener(
@NonNullActivity activity,
@NonNullOnCanceledListener onCanceledListener
)
Adds an Activity-scoped listener that is called if theTask is canceled.
The listener will be called on main application thread. If the task has already been canceled, 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 duringonStop.
| Returns | |
|---|---|
@NonNullTask<LoadBundleTaskProgress> | this Task |
addOnCanceledListener
public @NonNullTask<LoadBundleTaskProgress> addOnCanceledListener(
@NonNullExecutor executor,
@NonNullOnCanceledListener onCanceledListener
)
Adds a listener that is called if theTask is canceled.
If the task has already been canceled, 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.
| Returns | |
|---|---|
@NonNullTask<LoadBundleTaskProgress> | this Task |
addOnCompleteListener
public @NonNullTask<LoadBundleTaskProgress> addOnCompleteListener(
@NonNullOnCompleteListener<LoadBundleTaskProgress> onCompleteListener
)
Adds a listener that is called when theTask succeeds or 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.
| Returns | |
|---|---|
@NonNullTask<LoadBundleTaskProgress> | this |
addOnCompleteListener
public @NonNullTask<LoadBundleTaskProgress> addOnCompleteListener(
@NonNullActivity activity,
@NonNullOnCompleteListener<LoadBundleTaskProgress> onCompleteListener
)
Adds a listener that is called when theTask succeeds or 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 | |
|---|---|
@NonNullActivity activity | When the supplied |
| Returns | |
|---|---|
@NonNullTask<LoadBundleTaskProgress> | this |
addOnCompleteListener
public @NonNullTask<LoadBundleTaskProgress> addOnCompleteListener(
@NonNullExecutor executor,
@NonNullOnCompleteListener<LoadBundleTaskProgress> onCompleteListener
)
Adds a listener that is called when theTask succeeds or 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.
| Returns | |
|---|---|
@NonNullTask<LoadBundleTaskProgress> | this |
addOnFailureListener
public @NonNullTask<LoadBundleTaskProgress> addOnFailureListener(@NonNullOnFailureListener onFailureListener)
Adds a listener that is called if theTask 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.
| Returns | |
|---|---|
@NonNullTask<LoadBundleTaskProgress> | this |
addOnFailureListener
public @NonNullTask<LoadBundleTaskProgress> addOnFailureListener(
@NonNullActivity activity,
@NonNullOnFailureListener onFailureListener
)
Adds a listener that is called if theTask 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 | |
|---|---|
@NonNullActivity activity | When the supplied |
| Returns | |
|---|---|
@NonNullTask<LoadBundleTaskProgress> | this |
addOnFailureListener
public @NonNullTask<LoadBundleTaskProgress> addOnFailureListener(
@NonNullExecutor executor,
@NonNullOnFailureListener onFailureListener
)
Adds a listener that is called if theTask 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.
| Returns | |
|---|---|
@NonNullTask<LoadBundleTaskProgress> | this |
addOnProgressListener
public @NonNullLoadBundleTask addOnProgressListener(
@NonNullOnProgressListener<LoadBundleTaskProgress> listener
)
Adds a listener that is called periodically while theLoadBundleTask executes.
The listener will be called on main application thread. If multiple listeners are added, they will be called in the order in which they were added.
The listener will be automatically removed duringonStop.
| Returns | |
|---|---|
@NonNullLoadBundleTask | this |
addOnProgressListener
public @NonNullLoadBundleTask addOnProgressListener(
@NonNullActivity activity,
@NonNullOnProgressListener<LoadBundleTaskProgress> listener
)
Adds a listener that is called periodically while theLoadBundleTask executes.
The listener will be called on main application thread. If multiple listeners are added, they will be called in the order in which they were added.
The listener will be automatically removed duringonStop.
| Parameters | |
|---|---|
@NonNullActivity activity | When the supplied |
| Returns | |
|---|---|
@NonNullLoadBundleTask | this |
addOnProgressListener
public @NonNullLoadBundleTask addOnProgressListener(
@NonNullExecutor executor,
@NonNullOnProgressListener<LoadBundleTaskProgress> listener
)
Adds a listener that is called periodically while theLoadBundleTask executes.
If multiple listeners are added, they will be called in the order in which they were added.
| Returns | |
|---|---|
@NonNullLoadBundleTask | this |
addOnSuccessListener
public @NonNullTask<LoadBundleTaskProgress> addOnSuccessListener(
@NonNullOnSuccessListener<Object> onSuccessListener
)
Adds a listener that is called if theTask 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.
| Returns | |
|---|---|
@NonNullTask<LoadBundleTaskProgress> | this |
addOnSuccessListener
public @NonNullTask<LoadBundleTaskProgress> addOnSuccessListener(
@NonNullActivity activity,
@NonNullOnSuccessListener<Object> onSuccessListener
)
Adds a listener that is called if theTask 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 | |
|---|---|
@NonNullActivity activity | When the supplied |
| Returns | |
|---|---|
@NonNullTask<LoadBundleTaskProgress> | this |
addOnSuccessListener
public @NonNullTask<LoadBundleTaskProgress> addOnSuccessListener(
@NonNullExecutor executor,
@NonNullOnSuccessListener<Object> onSuccessListener
)
Adds a listener that is called if theTask 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.
| Returns | |
|---|---|
@NonNullTask<LoadBundleTaskProgress> | this |
continueWith
public @NonNullTask<TContinuationResult> <TContinuationResult>continueWith(
@NonNullContinuation<LoadBundleTaskProgress, TContinuationResult> continuation
)
Returns a newTask that will be completed with the result of applying the specified Continuation to this Task.
TheContinuation will be called on the main application thread.
| See also | |
|---|---|
then |
continueWith
public @NonNullTask<TContinuationResult> <TContinuationResult>continueWith(
@NonNullExecutor executor,
@NonNullContinuation<LoadBundleTaskProgress, TContinuationResult> continuation
)
Returns a newTask that will be completed with the result of applying the specifiedContinuation to this Task.
| See also | |
|---|---|
then |
continueWithTask
public @NonNullTask<TContinuationResult> <TContinuationResult>continueWithTask(
@NonNullContinuation<LoadBundleTaskProgress, Task<TContinuationResult>> continuation
)
Returns a newTask that will be completed with the result of applying the specifiedContinuation to this Task.
The Continuation will be called on the main application thread.
| See also | |
|---|---|
then |
continueWithTask
public @NonNullTask<TContinuationResult> <TContinuationResult>continueWithTask(
@NonNullExecutor executor,
@NonNullContinuation<LoadBundleTaskProgress, Task<TContinuationResult>> continuation
)
Returns a newTask that will be completed with the result of applying the specifiedContinuation to this Task.
| See also | |
|---|---|
then |
getException
public @NullableException getException()
Returns the exception that caused theTask to fail. Returnsnull if the Task is not yet complete, or completed successfully.
getResult
public @NonNullLoadBundleTaskProgress getResult()
Gets the result of theTask, if it has already completed.
| Throws | |
|---|---|
java.lang.IllegalStateException java.lang.IllegalStateException | if the Task is not yet complete |
com.google.android.gms.tasks.RuntimeExecutionException com.google.android.gms.tasks.RuntimeExecutionException | if the Task failed with an exception |
getResult
public @NonNullLoadBundleTaskProgress <X extends Throwable>getResult(@NonNullClass<X> exceptionType)
Gets the result of theTask, if it has already completed.
| Throws | |
|---|---|
java.lang.IllegalStateException java.lang.IllegalStateException | if the Task is not yet complete |
X X | if the Task failed with an exception of type X |
com.google.android.gms.tasks.RuntimeExecutionException com.google.android.gms.tasks.RuntimeExecutionException | if the Task failed with an exception that was not of type X |
isSuccessful
public boolean isSuccessful()
Returnstrue if theTask has completed successfully;false otherwise.
onSuccessTask
public @NonNullTask<TContinuationResult> <TContinuationResult>onSuccessTask(
@NonNullSuccessContinuation<LoadBundleTaskProgress, TContinuationResult> successContinuation
)
Returns a newTask that will be completed with the result of applying the specifiedSuccessContinuation to thisTask when thisTask completes successfully. If the previousTask fails, theonSuccessTask completion will be skipped and failure listeners will be invoked.
TheSuccessContinuation will be called on the main application thread.
If the previousTask is canceled, the returned Task will also be canceled and theSuccessContinuation would not execute.
| See also | |
|---|---|
SuccessContinuation |
onSuccessTask
public @NonNullTask<TContinuationResult> <TContinuationResult>onSuccessTask(
@NonNullExecutor executor,
@NonNullSuccessContinuation<LoadBundleTaskProgress, TContinuationResult> successContinuation
)
Returns a newTask that will be completed with the result of applying the specifiedSuccessContinuation to thisTask when thisTask completes successfully. If the previousTask fails, the onSuccessTask completion will be skipped and failure listeners will be invoked.
If the previousTask is canceled, the returnedTask will also be canceled and theSuccessContinuation would not execute.
| See also | |
|---|---|
SuccessContinuation |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-21 UTC.