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

class StreamDownloadTask : StorageTask

kotlin.Any
↳	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
`interface StreamDownloadTask.StreamProcessor` A callback that is used to handle the stream download
`class StreamDownloadTask.TaskSnapshot : StorageTask.SnapshotBase` Encapsulates state about the running `StreamDownloadTask`

Protected functions
`Unit`	`onCanceled()`
`Unit`	`onProgress()`

Inherited functions

From com.google.firebase.storage.CancellableTask

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

From com.google.firebase.storage.ControllableTask

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

From com.google.firebase.storage.StorageTask

`StorageTask<ResultT!>`	`addOnCanceledListener(listener: OnCanceledListener)` Adds a listener that is called if the Task is canceled.
`StorageTask<ResultT!>`	`addOnCanceledListener(activity: Activity, listener: OnCanceledListener)` Adds an Activity-scoped listener that is called if the Task is canceled.
`StorageTask<ResultT!>`	`addOnCanceledListener(executor: Executor, listener: OnCanceledListener)` Adds a listener that is called if the Task is canceled.
`StorageTask<ResultT!>`	`addOnCompleteListener(listener: OnCompleteListener<ResultT!>)` Adds a listener that is called when the Task succeeds or fails.
`StorageTask<ResultT!>`	`addOnCompleteListener( activity: Activity, listener: OnCompleteListener<ResultT!> )` Adds a listener that is called when the Task succeeds or fails.
`StorageTask<ResultT!>`	`addOnCompleteListener( executor: Executor, listener: OnCompleteListener<ResultT!> )` Adds a listener that is called when the Task succeeds or fails.
`StorageTask<ResultT!>`	`addOnFailureListener(listener: OnFailureListener)` Adds a listener that is called if the Task fails.
`StorageTask<ResultT!>`	`addOnFailureListener(activity: Activity, listener: OnFailureListener)` Adds a listener that is called if the Task fails.
`StorageTask<ResultT!>`	`addOnFailureListener(executor: Executor, listener: OnFailureListener)` Adds a listener that is called if the Task fails.
`StorageTask<ResultT!>`	`addOnPausedListener(listener: OnPausedListener<Any!>)` Adds a listener that is called when the Task becomes paused.
`StorageTask<ResultT!>`	`addOnPausedListener(activity: Activity, listener: OnPausedListener<Any!>)` Adds a listener that is called when the Task becomes paused.
`StorageTask<ResultT!>`	`addOnPausedListener(executor: Executor, listener: OnPausedListener<Any!>)` Adds a listener that is called when the Task becomes paused.
`StorageTask<ResultT!>`	`addOnProgressListener(listener: OnProgressListener<Any!>)` Adds a listener that is called periodically while the ControllableTask executes.
`StorageTask<ResultT!>`	`addOnProgressListener( activity: Activity, listener: OnProgressListener<Any!> )` Adds a listener that is called periodically while the ControllableTask executes.
`StorageTask<ResultT!>`	`addOnProgressListener( executor: Executor, listener: OnProgressListener<Any!> )` Adds a listener that is called periodically while the ControllableTask executes.
`StorageTask<ResultT!>`	`addOnSuccessListener(listener: OnSuccessListener<Any!>)` Adds a listener that is called if the Task completes successfully.
`StorageTask<ResultT!>`	`addOnSuccessListener( activity: Activity, listener: OnSuccessListener<Any!> )` Adds a listener that is called if the Task completes successfully.
`StorageTask<ResultT!>`	`addOnSuccessListener( executor: Executor, listener: OnSuccessListener<Any!> )` Adds a listener that is called if the Task completes successfully.
`Boolean`	`cancel()` Attempts to cancel the task.
`Task<ContinuationResultT!>`	`<ContinuationResultT> continueWith( continuation: Continuation<ResultT!, ContinuationResultT!> )` Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
`Task<ContinuationResultT!>`	`<ContinuationResultT> continueWith( executor: Executor, continuation: Continuation<ResultT!, ContinuationResultT!> )` Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
`Task<ContinuationResultT!>`	`<ContinuationResultT> continueWithTask( continuation: Continuation<ResultT!, Task<ContinuationResultT!>!> )` Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
`Task<ContinuationResultT!>`	`<ContinuationResultT> continueWithTask( executor: Executor, continuation: Continuation<ResultT!, Task<ContinuationResultT!>!> )` Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
`Exception?`	`getException()` Returns the exception that caused the Task to fail.
`ResultT`	`getResult()` Gets the result of the Task, if it has already completed.
`ResultT`	`<X : Throwable?> getResult(exceptionType: Class<X!>)` Gets the result of the Task, if it has already completed.
`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.
`Unit`	`onFailure()`
`Unit`	`onPaused()`
`Unit`	`onQueued()`
`Unit`	`onSuccess()`
`Task<ContinuationResultT!>`	`<ContinuationResultT> onSuccessTask( continuation: SuccessContinuation<ResultT!, ContinuationResultT!> )` Returns a new Task that will be completed with the result of applying the specified SuccessContinuation to this Task when this Task completes successfully.
`Task<ContinuationResultT!>`	`<ContinuationResultT> onSuccessTask( executor: Executor, continuation: SuccessContinuation<ResultT!, ContinuationResultT!> )` Returns a new Task that will be completed with the result of applying the specified SuccessContinuation to this Task when this Task completes successfully.
`StorageTask<ResultT!>`	`removeOnCanceledListener(listener: OnCanceledListener)` Removes a listener.
`StorageTask<ResultT!>`	`removeOnCompleteListener(listener: OnCompleteListener<ResultT!>)` Removes a listener.
`StorageTask<ResultT!>`	`removeOnFailureListener(listener: OnFailureListener)` Removes a listener.
`StorageTask<ResultT!>`	`removeOnPausedListener(listener: OnPausedListener<Any!>)` Removes a listener.
`StorageTask<ResultT!>`	`removeOnProgressListener(listener: OnProgressListener<Any!>)` Removes a listener.
`StorageTask<ResultT!>`	`removeOnSuccessListener(listener: OnSuccessListener<Any!>)` Removes a listener.

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

`Task<TResult!>!`	`addOnCanceledListener(p: OnCanceledListener!)`
`Task<TResult!>!`	`addOnCompleteListener(p: OnCompleteListener<TResult!>!)`
`abstract Task<TResult!>!`	`addOnFailureListener(p: OnFailureListener!)`
`abstract Task<TResult!>!`	`addOnSuccessListener(p: OnSuccessListener<Any!>!)`
`Task<TContinuationResult!>!`	`<TContinuationResult> continueWith( p: Continuation<TResult!, TContinuationResult!>! )`
`Task<TContinuationResult!>!`	`<TContinuationResult> continueWithTask( p: Continuation<TResult!, Task<TContinuationResult!>!>! )`
`abstract Exception!`	`getException()`
`abstract TResult!`	`getResult()`
`abstract Boolean`	`isCanceled()`
`abstract Boolean`	`isComplete()`
`abstract Boolean`	`isSuccessful()`
`Task<TContinuationResult!>!`	`<TContinuationResult> onSuccessTask( p: SuccessContinuation<TResult!, TContinuationResult!>! )`

Inherited properties

From com.google.firebase.storage.StorageTask

Any!

syncObject

Protected functions

onCanceled

protected fun onCanceled(): Unit

onProgress

protected fun onProgress(): Unit

StreamDownloadTask

Summary

Nested types

Protected functions

Inherited functions

Inherited properties

Protected functions

onCanceled

onProgress