StreamDownloadTask.TaskSnapshot

public class StreamDownloadTask.TaskSnapshot extends StorageTask.SnapshotBase

java.lang.Object
↳	com.google.firebase.storage.StorageTask.SnapshotBase
	↳	com.google.firebase.storage.StreamDownloadTask.TaskSnapshot

---

Encapsulates state about the running StreamDownloadTask

Summary

Public methods
long	getBytesTransferred()
@NonNull InputStream	getStream()
long	getTotalByteCount()

Extension functions
final long	StorageKt.component1(@NonNull StreamDownloadTask.TaskSnapshot receiver) Destructuring declaration for StreamDownloadTask.TaskSnapshot to provide bytesTransferred.
final long	StorageKt.component1(@NonNull StreamDownloadTask.TaskSnapshot receiver) This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.
final long	StorageKt.component2(@NonNull StreamDownloadTask.TaskSnapshot receiver) Destructuring declaration for StreamDownloadTask.TaskSnapshot to provide totalByteCount.
final long	StorageKt.component2(@NonNull StreamDownloadTask.TaskSnapshot receiver) This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.
final @NonNull InputStream	StorageKt.component3(@NonNull StreamDownloadTask.TaskSnapshot receiver) Destructuring declaration for StreamDownloadTask.TaskSnapshot to provide its stream.
final @NonNull InputStream	StorageKt.component3(@NonNull StreamDownloadTask.TaskSnapshot receiver) This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.

Inherited fields
From com.google.firebase.storage.StorageTask.SnapshotBase final Exception error

Inherited methods
From com.google.firebase.storage.StorageTask.SnapshotBase @Nullable Exception getError() Returns the last error encountered. @NonNull StorageReference getStorage() Returns the target of the upload. @NonNull StorageTask<ResultT> getTask() Returns the StorageTask for this state.

Public methods

getBytesTransferred

public long getBytesTransferred()

Returns
long	the total bytes downloaded so far.

getStream

public @NonNull InputStream getStream()

Returns
@NonNull InputStream	The stream that represents downloaded bytes from Storage. This stream should be closed either in doInBackground or in OnSuccessListener, OnFailureListener

getTotalByteCount

public long getTotalByteCount()

Returns
long	the total bytes of the download.

Extension functions

StorageKt.component1

public final long StorageKt.component1(@NonNull StreamDownloadTask.TaskSnapshot receiver)

Destructuring declaration for StreamDownloadTask.TaskSnapshot to provide bytesTransferred.

Returns
long	the bytesTransferred of the StreamDownloadTask.TaskSnapshot

StorageKt.component1

public final long StorageKt.component1(@NonNull StreamDownloadTask.TaskSnapshot receiver)

This method is deprecated.
Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.

Destructuring declaration for StreamDownloadTask.TaskSnapshot to provide bytesTransferred.

Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.

Returns
long	the bytesTransferred of the StreamDownloadTask.TaskSnapshot

StorageKt.component2

public final long StorageKt.component2(@NonNull StreamDownloadTask.TaskSnapshot receiver)

Destructuring declaration for StreamDownloadTask.TaskSnapshot to provide totalByteCount.

Returns
long	the totalByteCount of the StreamDownloadTask.TaskSnapshot

StorageKt.component2

public final long StorageKt.component2(@NonNull StreamDownloadTask.TaskSnapshot receiver)

This method is deprecated.
Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.

Destructuring declaration for StreamDownloadTask.TaskSnapshot to provide totalByteCount.

Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.

Returns
long	the totalByteCount of the StreamDownloadTask.TaskSnapshot

StorageKt.component3

public final @NonNull InputStream StorageKt.component3(@NonNull StreamDownloadTask.TaskSnapshot receiver)

Destructuring declaration for StreamDownloadTask.TaskSnapshot to provide its stream.

Returns
@NonNull InputStream	the stream of the StreamDownloadTask.TaskSnapshot

StorageKt.component3

public final @NonNull InputStream StorageKt.component3(@NonNull StreamDownloadTask.TaskSnapshot receiver)

This method is deprecated.
Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.

Destructuring declaration for StreamDownloadTask.TaskSnapshot to provide its stream.

Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.

Returns
@NonNull InputStream	the stream of the StreamDownloadTask.TaskSnapshot