FileDownloadTask.TaskSnapshot

class FileDownloadTask.TaskSnapshot : StorageTask.SnapshotBase

kotlin.Any
   ↳ com.google.firebase.storage.StorageTask.SnapshotBase
     ↳ com.google.firebase.storage.FileDownloadTask.TaskSnapshot

Encapsulates state about the running FileDownloadTask

Summary

Public functions
Long
Long

Extension functions
operator Long

Destructuring declaration for FileDownloadTask.TaskSnapshot to provide bytesTransferred.
operator Long

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

Destructuring declaration for FileDownloadTask.TaskSnapshot to provide totalByteCount.
operator Long

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

Inherited functions
From com.google.firebase.storage.StorageTask.SnapshotBase
Exception?

Returns the last error encountered.
StorageReference

Returns the target of the upload.
StorageTask<ResultT!>

Returns the StorageTask for this state.

Inherited properties
From com.google.firebase.storage.StorageTask.SnapshotBase
Exception!

Public functions

getBytesTransferred

fun getBytesTransferred(): Long
Returns
Long

the total bytes downloaded so far.

getTotalByteCount

fun getTotalByteCount(): Long
Returns
Long

the total bytes to upload..

Extension functions

component1

operator fun FileDownloadTask.TaskSnapshot.component1(): Long

Destructuring declaration for FileDownloadTask.TaskSnapshot to provide bytesTransferred.

Returns
Long

the bytesTransferred of the FileDownloadTask.TaskSnapshot

component1

operator fun FileDownloadTask.TaskSnapshot.component1(): Long

Destructuring declaration for FileDownloadTask.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 FileDownloadTask.TaskSnapshot

component2

operator fun FileDownloadTask.TaskSnapshot.component2(): Long

Destructuring declaration for FileDownloadTask.TaskSnapshot to provide totalByteCount.

Returns
Long

the totalByteCount of the FileDownloadTask.TaskSnapshot

component2

operator fun FileDownloadTask.TaskSnapshot.component2(): Long

Destructuring declaration for FileDownloadTask.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 FileDownloadTask.TaskSnapshot