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 you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

StreamDownloadTask

public class StreamDownloadTask extends StorageTask

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

A task that downloads bytes of a GCS blob.

Summary

Nested types
`public interface StreamDownloadTask.StreamProcessor` A callback that is used to handle the stream download
`public class StreamDownloadTask.TaskSnapshot extends StorageTask.SnapshotBase` Encapsulates state about the running `StreamDownloadTask`

Protected methods
`void`	`onCanceled()`
`void`	`onProgress()`

Inherited fields

From com.google.firebase.storage.StorageTask

final Object

syncObject

Inherited methods

From com.google.firebase.storage.CancellableTask

`abstract @NonNull CancellableTask<StateT>`	`addOnProgressListener(@NonNull OnProgressListener<Object> listener)` Adds a listener that is called periodically while the ControllableTask executes.
`abstract @NonNull CancellableTask<StateT>`	`addOnProgressListener( @NonNull Activity activity, @NonNull OnProgressListener<Object> listener )` Adds a listener that is called periodically while the ControllableTask executes.
`abstract @NonNull CancellableTask<StateT>`	`addOnProgressListener( @NonNull Executor executor, @NonNull OnProgressListener<Object> listener )` Adds a listener that is called periodically while the ControllableTask executes.

From com.google.firebase.storage.ControllableTask

`abstract @NonNull ControllableTask<StateT>`	`addOnPausedListener(@NonNull OnPausedListener<Object> listener)` Adds a listener that is called when the Task becomes paused.
`abstract @NonNull ControllableTask<StateT>`	`addOnPausedListener( @NonNull Activity activity, @NonNull OnPausedListener<Object> listener )` Adds a listener that is called when the Task becomes paused.
`abstract @NonNull ControllableTask<StateT>`	`addOnPausedListener( @NonNull Executor executor, @NonNull OnPausedListener<Object> listener )` Adds a listener that is called when the Task becomes paused.

From com.google.firebase.storage.StorageTask

`@NonNull StorageTask<ResultT>`	`addOnCanceledListener(@NonNull OnCanceledListener listener)` Adds a listener that is called if the Task is canceled.
`@NonNull StorageTask<ResultT>`	`addOnCanceledListener( @NonNull Activity activity, @NonNull OnCanceledListener listener )` Adds an Activity-scoped listener that is called if the Task is canceled.
`@NonNull StorageTask<ResultT>`	`addOnCanceledListener( @NonNull Executor executor, @NonNull OnCanceledListener listener )` Adds a listener that is called if the Task is canceled.
`@NonNull StorageTask<ResultT>`	`addOnCompleteListener(@NonNull OnCompleteListener<ResultT> listener)` Adds a listener that is called when the Task succeeds or fails.
`@NonNull StorageTask<ResultT>`	`addOnCompleteListener( @NonNull Activity activity, @NonNull OnCompleteListener<ResultT> listener )` Adds a listener that is called when the Task succeeds or fails.
`@NonNull StorageTask<ResultT>`	`addOnCompleteListener( @NonNull Executor executor, @NonNull OnCompleteListener<ResultT> listener )` Adds a listener that is called when the Task succeeds or fails.
`@NonNull StorageTask<ResultT>`	`addOnFailureListener(@NonNull OnFailureListener listener)` Adds a listener that is called if the Task fails.
`@NonNull StorageTask<ResultT>`	`addOnFailureListener( @NonNull Activity activity, @NonNull OnFailureListener listener )` Adds a listener that is called if the Task fails.
`@NonNull StorageTask<ResultT>`	`addOnFailureListener( @NonNull Executor executor, @NonNull OnFailureListener listener )` Adds a listener that is called if the Task fails.
`@NonNull StorageTask<ResultT>`	`addOnPausedListener(@NonNull OnPausedListener<Object> listener)` Adds a listener that is called when the Task becomes paused.
`@NonNull StorageTask<ResultT>`	`addOnPausedListener( @NonNull Activity activity, @NonNull OnPausedListener<Object> listener )` Adds a listener that is called when the Task becomes paused.
`@NonNull StorageTask<ResultT>`	`addOnPausedListener( @NonNull Executor executor, @NonNull OnPausedListener<Object> listener )` Adds a listener that is called when the Task becomes paused.
`@NonNull StorageTask<ResultT>`	`addOnProgressListener(@NonNull OnProgressListener<Object> listener)` Adds a listener that is called periodically while the ControllableTask executes.
`@NonNull StorageTask<ResultT>`	`addOnProgressListener( @NonNull Activity activity, @NonNull OnProgressListener<Object> listener )` Adds a listener that is called periodically while the ControllableTask executes.
`@NonNull StorageTask<ResultT>`	`addOnProgressListener( @NonNull Executor executor, @NonNull OnProgressListener<Object> listener )` Adds a listener that is called periodically while the ControllableTask executes.
`@NonNull StorageTask<ResultT>`	`addOnSuccessListener(@NonNull OnSuccessListener<Object> listener)` Adds a listener that is called if the Task completes successfully.
`@NonNull StorageTask<ResultT>`	`addOnSuccessListener( @NonNull Activity activity, @NonNull OnSuccessListener<Object> listener )` Adds a listener that is called if the Task completes successfully.
`@NonNull StorageTask<ResultT>`	`addOnSuccessListener( @NonNull Executor executor, @NonNull OnSuccessListener<Object> listener )` Adds a listener that is called if the Task completes successfully.
`boolean`	`cancel()` Attempts to cancel the task.
`@NonNull Task<ContinuationResultT>`	`<ContinuationResultT> continueWith( @NonNull Continuation<ResultT, ContinuationResultT> continuation )` Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
`@NonNull Task<ContinuationResultT>`	`<ContinuationResultT> continueWith( @NonNull Executor executor, @NonNull Continuation<ResultT, ContinuationResultT> continuation )` Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
`@NonNull Task<ContinuationResultT>`	`<ContinuationResultT> continueWithTask( @NonNull Continuation<ResultT, Task<ContinuationResultT>> continuation )` Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
`@NonNull Task<ContinuationResultT>`	`<ContinuationResultT> continueWithTask( @NonNull Executor executor, @NonNull Continuation<ResultT, Task<ContinuationResultT>> continuation )` Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
`@Nullable Exception`	`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(@NonNull Class<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`	`onQueued()`
`void`	`onSuccess()`
`@NonNull Task<ContinuationResultT>`	`<ContinuationResultT> onSuccessTask( @NonNull SuccessContinuation<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.
`@NonNull Task<ContinuationResultT>`	`<ContinuationResultT> onSuccessTask( @NonNull Executor executor, @NonNull SuccessContinuation<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.
`@NonNull StorageTask<ResultT>`	`removeOnCanceledListener(@NonNull OnCanceledListener listener)` Removes a listener.
`@NonNull StorageTask<ResultT>`	`removeOnCompleteListener(@NonNull OnCompleteListener<ResultT> listener)` Removes a listener.
`@NonNull StorageTask<ResultT>`	`removeOnFailureListener(@NonNull OnFailureListener listener)` Removes a listener.
`@NonNull StorageTask<ResultT>`	`removeOnPausedListener(@NonNull OnPausedListener<Object> listener)` Removes a listener.
`@NonNull StorageTask<ResultT>`	`removeOnProgressListener(@NonNull OnProgressListener<Object> listener)` Removes a listener.
`@NonNull StorageTask<ResultT>`	`removeOnSuccessListener(@NonNull OnSuccessListener<Object> listener)` Removes a listener.

From com.google.android.gms.tasks.Task

`Task<TResult>`	`addOnCanceledListener(OnCanceledListener p)`
`Task<TResult>`	`addOnCompleteListener(OnCompleteListener<TResult> p)`
`abstract Task<TResult>`	`addOnFailureListener(OnFailureListener p)`
`abstract Task<TResult>`	`addOnSuccessListener(OnSuccessListener<Object> p)`
`Task<TContinuationResult>`	`<TContinuationResult> continueWith( Continuation<TResult, TContinuationResult> p )`
`Task<TContinuationResult>`	`<TContinuationResult> continueWithTask( Continuation<TResult, Task<TContinuationResult>> p )`
`abstract Exception`	`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()

onProgress

protected void onProgress()

StreamDownloadTask

Summary

Nested types

Protected methods

Inherited fields

Inherited methods

Protected methods

onCanceled

onProgress