IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that youmigrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

FileDownloadTask

public classFileDownloadTask extendsStorageTask

java.lang.Object
↳	com.google.android.gms.tasks.Task
	↳	com.google.firebase.storage.CancellableTask
		↳	com.google.firebase.storage.ControllableTask
			↳	com.google.firebase.storage.StorageTask
				↳	com.google.firebase.storage.FileDownloadTask

A task that downloads bytes of a GCS blob to a specified File.

Summary

Nested types
`public classFileDownloadTask.TaskSnapshot extendsStorageTask.SnapshotBase` Encapsulates state about the running`FileDownloadTask`

Protected methods
`void`	`onCanceled()`

Inherited fields

Fromcom.google.firebase.storage.StorageTask

finalObject

syncObject

Inherited methods

Fromcom.google.firebase.storage.CancellableTask

`abstract @NonNullCancellableTask<StateT>`	`addOnProgressListener(@NonNullOnProgressListener<Object> listener)` Adds a listener that is called periodically while the ControllableTask executes.
`abstract @NonNullCancellableTask<StateT>`	`addOnProgressListener( @NonNullActivity activity, @NonNullOnProgressListener<Object> listener )` Adds a listener that is called periodically while the ControllableTask executes.
`abstract @NonNullCancellableTask<StateT>`	`addOnProgressListener( @NonNullExecutor executor, @NonNullOnProgressListener<Object> listener )` Adds a listener that is called periodically while the ControllableTask executes.

Fromcom.google.firebase.storage.ControllableTask

`abstract @NonNullControllableTask<StateT>`	`addOnPausedListener(@NonNullOnPausedListener<Object> listener)` Adds a listener that is called when the Task becomes paused.
`abstract @NonNullControllableTask<StateT>`	`addOnPausedListener( @NonNullActivity activity, @NonNullOnPausedListener<Object> listener )` Adds a listener that is called when the Task becomes paused.
`abstract @NonNullControllableTask<StateT>`	`addOnPausedListener( @NonNullExecutor executor, @NonNullOnPausedListener<Object> listener )` Adds a listener that is called when the Task becomes paused.

Fromcom.google.firebase.storage.StorageTask

`@NonNullStorageTask<ResultT>`	`addOnCanceledListener(@NonNullOnCanceledListener listener)` Adds a listener that is called if the Task is canceled.
`@NonNullStorageTask<ResultT>`	`addOnCanceledListener( @NonNullActivity activity, @NonNullOnCanceledListener listener )` Adds an Activity-scoped listener that is called if the Task is canceled.
`@NonNullStorageTask<ResultT>`	`addOnCanceledListener( @NonNullExecutor executor, @NonNullOnCanceledListener listener )` Adds a listener that is called if the Task is canceled.
`@NonNullStorageTask<ResultT>`	`addOnCompleteListener(@NonNullOnCompleteListener<ResultT> listener)` Adds a listener that is called when the Task succeeds or fails.
`@NonNullStorageTask<ResultT>`	`addOnCompleteListener( @NonNullActivity activity, @NonNullOnCompleteListener<ResultT> listener )` Adds a listener that is called when the Task succeeds or fails.
`@NonNullStorageTask<ResultT>`	`addOnCompleteListener( @NonNullExecutor executor, @NonNullOnCompleteListener<ResultT> listener )` Adds a listener that is called when the Task succeeds or fails.
`@NonNullStorageTask<ResultT>`	`addOnFailureListener(@NonNullOnFailureListener listener)` Adds a listener that is called if the Task fails.
`@NonNullStorageTask<ResultT>`	`addOnFailureListener( @NonNullActivity activity, @NonNullOnFailureListener listener )` Adds a listener that is called if the Task fails.
`@NonNullStorageTask<ResultT>`	`addOnFailureListener( @NonNullExecutor executor, @NonNullOnFailureListener listener )` Adds a listener that is called if the Task fails.
`@NonNullStorageTask<ResultT>`	`addOnPausedListener(@NonNullOnPausedListener<Object> listener)` Adds a listener that is called when the Task becomes paused.
`@NonNullStorageTask<ResultT>`	`addOnPausedListener( @NonNullActivity activity, @NonNullOnPausedListener<Object> listener )` Adds a listener that is called when the Task becomes paused.
`@NonNullStorageTask<ResultT>`	`addOnPausedListener( @NonNullExecutor executor, @NonNullOnPausedListener<Object> listener )` Adds a listener that is called when the Task becomes paused.
`@NonNullStorageTask<ResultT>`	`addOnProgressListener(@NonNullOnProgressListener<Object> listener)` Adds a listener that is called periodically while the ControllableTask executes.
`@NonNullStorageTask<ResultT>`	`addOnProgressListener( @NonNullActivity activity, @NonNullOnProgressListener<Object> listener )` Adds a listener that is called periodically while the ControllableTask executes.
`@NonNullStorageTask<ResultT>`	`addOnProgressListener( @NonNullExecutor executor, @NonNullOnProgressListener<Object> listener )` Adds a listener that is called periodically while the ControllableTask executes.
`@NonNullStorageTask<ResultT>`	`addOnSuccessListener(@NonNullOnSuccessListener<Object> listener)` Adds a listener that is called if the Task completes successfully.
`@NonNullStorageTask<ResultT>`	`addOnSuccessListener( @NonNullActivity activity, @NonNullOnSuccessListener<Object> listener )` Adds a listener that is called if the Task completes successfully.
`@NonNullStorageTask<ResultT>`	`addOnSuccessListener( @NonNullExecutor executor, @NonNullOnSuccessListener<Object> listener )` Adds a listener that is called if the Task completes successfully.
`boolean`	`cancel()` Attempts to cancel the task.
`@NonNullTask<ContinuationResultT>`	`<ContinuationResultT>continueWith( @NonNullContinuation<ResultT, ContinuationResultT> continuation )` Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
`@NonNullTask<ContinuationResultT>`	`<ContinuationResultT>continueWith( @NonNullExecutor executor, @NonNullContinuation<ResultT, ContinuationResultT> continuation )` Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
`@NonNullTask<ContinuationResultT>`	`<ContinuationResultT>continueWithTask( @NonNullContinuation<ResultT, Task<ContinuationResultT>> continuation )` Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
`@NonNullTask<ContinuationResultT>`	`<ContinuationResultT>continueWithTask( @NonNullExecutor executor, @NonNullContinuation<ResultT, Task<ContinuationResultT>> continuation )` Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
`@NullableException`	`getException()` Returns the exception that caused the Task to fail.
`@NonNull ResultT`	`getResult()` Gets the result of the Task, if it has already completed.
`@NonNull ResultT`	`<X extends Throwable>getResult(@NonNullClass<X> exceptionType)` Gets the result of the Task, if it has already completed.
`@NonNull ResultT`	`getSnapshot()` Returns the current state of the task.
`boolean`	`isCanceled()` Returns`true` if the task has been canceled.
`boolean`	`isComplete()` Returns`true` if the Task is complete;`false` otherwise.
`boolean`	`isInProgress()` Returns`true` if the task is currently running.
`boolean`	`isPaused()` Returns`true` if the task has been paused.
`boolean`	`isSuccessful()` Returns`true` if the Task has completed successfully;`false` otherwise.
`void`	`onFailure()`
`void`	`onPaused()`
`void`	`onProgress()`
`void`	`onQueued()`
`void`	`onSuccess()`
`@NonNullTask<ContinuationResultT>`	`<ContinuationResultT>onSuccessTask( @NonNullSuccessContinuation<ResultT, ContinuationResultT> continuation )` Returns a new Task that will be completed with the result of applying the specified SuccessContinuation to this Task when this Task completes successfully.
`@NonNullTask<ContinuationResultT>`	`<ContinuationResultT>onSuccessTask( @NonNullExecutor executor, @NonNullSuccessContinuation<ResultT, ContinuationResultT> continuation )` Returns a new Task that will be completed with the result of applying the specified SuccessContinuation to this Task when this Task completes successfully.
`boolean`	`pause()` Attempts to pause the task.
`@NonNullStorageTask<ResultT>`	`removeOnCanceledListener(@NonNullOnCanceledListener listener)` Removes a listener.
`@NonNullStorageTask<ResultT>`	`removeOnCompleteListener(@NonNullOnCompleteListener<ResultT> listener)` Removes a listener.
`@NonNullStorageTask<ResultT>`	`removeOnFailureListener(@NonNullOnFailureListener listener)` Removes a listener.
`@NonNullStorageTask<ResultT>`	`removeOnPausedListener(@NonNullOnPausedListener<Object> listener)` Removes a listener.
`@NonNullStorageTask<ResultT>`	`removeOnProgressListener(@NonNullOnProgressListener<Object> listener)` Removes a listener.
`@NonNullStorageTask<ResultT>`	`removeOnSuccessListener(@NonNullOnSuccessListener<Object> listener)` Removes a listener.
`boolean`	`resume()` Attempts to resume a paused task.

Fromcom.google.android.gms.tasks.Task

`Task<TResult>`	`addOnCanceledListener(OnCanceledListener p)`
`Task<TResult>`	`addOnCompleteListener(OnCompleteListener<TResult> p)`
`abstractTask<TResult>`	`addOnFailureListener(OnFailureListener p)`
`abstractTask<TResult>`	`addOnSuccessListener(OnSuccessListener<Object> p)`
`Task<TContinuationResult>`	`<TContinuationResult>continueWith( Continuation<TResult, TContinuationResult> p )`
`Task<TContinuationResult>`	`<TContinuationResult>continueWithTask( Continuation<TResult, Task<TContinuationResult>> p )`
`abstractException`	`getException()`
`abstract TResult`	`getResult()`
`abstract boolean`	`isCanceled()`
`abstract boolean`	`isComplete()`
`abstract boolean`	`isSuccessful()`
`Task<TContinuationResult>`	`<TContinuationResult>onSuccessTask( SuccessContinuation<TResult, TContinuationResult> p )`

Protected methods

onCanceled

protected void onCanceled()

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.

Movatterモバイル変換

FileDownloadTask

Summary

Nested types

Protected methods

Inherited fields

Inherited methods

Protected methods

onCanceled