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.

UpdateProgress

interface UpdateProgress

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

Summary

Public functions
`Long`	`getApkBytesDownloaded()` Returns the number of bytes downloaded so far for an APK.
`Long`	`getApkFileTotalBytes()` Returns the file size of the APK file to download in bytes.
`UpdateStatus`	`getUpdateStatus()` Returns the current `UpdateStatus` of the update.

Extension functions
`operator Long`	`UpdateProgress.component1()` Destructuring declaration for `UpdateProgress` to provide apkBytesDownloaded.
`operator Long`	`UpdateProgress.component2()` Destructuring declaration for `UpdateProgress` to provide apkFileTotalBytes.
`operator UpdateStatus`	`UpdateProgress.component3()` Destructuring declaration for `UpdateProgress` to provide updateStatus.

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`

component2

operator fun UpdateProgress.component2(): Long

Destructuring declaration for UpdateProgress to provide apkFileTotalBytes.

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`