UpdateProgress

interface UpdateProgress


Represents a progress update or a final state from updating an app.

Summary

Public functions

Long

Returns the number of bytes downloaded so far for an APK.

Long

Returns the file size of the APK file to download in bytes.

UpdateStatus

Returns the current UpdateStatus of the update.

Extension functions

operator Long

Destructuring declaration for UpdateProgress to provide apkBytesDownloaded.

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 UpdateProgress to provide apkFileTotalBytes.

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 UpdateStatus

Destructuring declaration for UpdateProgress to provide updateStatus.

operator UpdateStatus

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

Public functions

getApkBytesDownloaded

fun getApkBytesDownloaded(): Long

Returns the number of bytes downloaded so far for an APK.

the number of bytes downloaded, or -1 if called when updating to an AAB or if no new release is available.

getApkFileTotalBytes

fun getApkFileTotalBytes(): Long

Returns the file size of the APK file to download in bytes.

the file size in bytes, or -1 if called when updating to an AAB or if no new release is available.

getUpdateStatus

fun getUpdateStatus(): UpdateStatus

Returns the current UpdateStatus of the update.

Extension functions

component1

operator fun UpdateProgress.component1(): Long

Destructuring declaration for UpdateProgress to provide apkBytesDownloaded.

Returns
Long

the apkBytesDownloaded of the UpdateProgress

component1

operator fun UpdateProgress.component1(): Long

Destructuring declaration for UpdateProgress to provide apkBytesDownloaded.

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-appdistribution-api-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 apkBytesDownloaded of the UpdateProgress

component2

operator fun UpdateProgress.component2(): Long

Destructuring declaration for UpdateProgress to provide apkFileTotalBytes.

Returns
Long

the apkFileTotalBytes of the UpdateProgress

component2

operator fun UpdateProgress.component2(): Long

Destructuring declaration for UpdateProgress to provide apkFileTotalBytes.

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-appdistribution-api-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 apkFileTotalBytes of the UpdateProgress

component3

operator fun UpdateProgress.component3(): UpdateStatus

Destructuring declaration for UpdateProgress to provide updateStatus.

Returns
UpdateStatus

the updateStatus of the UpdateProgress

component3

operator fun UpdateProgress.component3(): UpdateStatus

Destructuring declaration for UpdateProgress to provide updateStatus.

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-appdistribution-api-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
UpdateStatus

the updateStatus of the UpdateProgress