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.
Stay organized with collections
Save and categorize content based on your preferences.
UpdateProgress
public interface UpdateProgress
Represents a progress update or a final state from updating an app.
Summary
Public methods |
abstract long |
Returns the number of bytes downloaded so far for an APK.
|
abstract long |
Returns the file size of the APK file to download in bytes.
|
abstract @NonNull UpdateStatus |
Returns the current UpdateStatus of the update.
|
Extension functions |
default final long |
Destructuring declaration for UpdateProgress to provide apkBytesDownloaded.
|
default final long |
Destructuring declaration for UpdateProgress to provide apkFileTotalBytes.
|
default final @NonNull UpdateStatus |
Destructuring declaration for UpdateProgress to provide updateStatus.
|
Public methods
getApkBytesDownloaded
abstract long getApkBytesDownloaded()
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
abstract long getApkFileTotalBytes()
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-21 UTC.
[null,null,["Last updated 2025-07-21 UTC."],[],[],null,["UpdateProgress\n\n\n```\npublic interface UpdateProgress\n```\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nRepresents a progress update or a final state from updating an app.\n\nSummary \n\nPublic methods \n\ngetApkBytesDownloaded \n\n```\nabstract long getApkBytesDownloaded()\n```\n\nReturns the number of bytes downloaded so far for an APK.\n\nthe number of bytes downloaded, or -1 if called when updating to an AAB or if no new release is available. \n\ngetApkFileTotalBytes \n\n```\nabstract long getApkFileTotalBytes()\n```\n\nReturns the file size of the APK file to download in bytes.\n\nthe file size in bytes, or -1 if called when updating to an AAB or if no new release is available. \n\ngetUpdateStatus \n\n```\nabstract @NonNull UpdateStatus getUpdateStatus()\n```\n\nReturns the current [UpdateStatus](/docs/reference/android/com/google/firebase/appdistribution/UpdateStatus) of the update. \n\nExtension functions \n\nFirebaseAppDistributionKt.component1 \n\n```\ndefault final long FirebaseAppDistributionKt.component1(@NonNull UpdateProgress receiver)\n```\n\nDestructuring declaration for [UpdateProgress](/docs/reference/android/com/google/firebase/appdistribution/UpdateProgress) to provide apkBytesDownloaded. \n\nFirebaseAppDistributionKt.component1 \n\n```\ndefault final long FirebaseAppDistributionKt.[component1](/docs/reference/android/com/google/firebase/appdistribution/UpdateProgress#(com.google.firebase.appdistribution.UpdateProgress).component1())(@NonNull UpdateProgress receiver)\n```\n| **This method is deprecated.** \n| Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.\n\nDestructuring declaration for [UpdateProgress](/docs/reference/android/com/google/firebase/appdistribution/UpdateProgress) to provide apkBytesDownloaded.\n\n**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.](https://firebase.google.com/docs/android/kotlin-migration) \n\nFirebaseAppDistributionKt.component2 \n\n```\ndefault final long FirebaseAppDistributionKt.component2(@NonNull UpdateProgress receiver)\n```\n\nDestructuring declaration for [UpdateProgress](/docs/reference/android/com/google/firebase/appdistribution/UpdateProgress) to provide apkFileTotalBytes. \n\nFirebaseAppDistributionKt.component2 \n\n```\ndefault final long FirebaseAppDistributionKt.[component2](/docs/reference/android/com/google/firebase/appdistribution/UpdateProgress#(com.google.firebase.appdistribution.UpdateProgress).component2())(@NonNull UpdateProgress receiver)\n```\n| **This method is deprecated.** \n| Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.\n\nDestructuring declaration for [UpdateProgress](/docs/reference/android/com/google/firebase/appdistribution/UpdateProgress) to provide apkFileTotalBytes.\n\n**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.](https://firebase.google.com/docs/android/kotlin-migration) \n\nFirebaseAppDistributionKt.component3 \n\n```\ndefault final @NonNull UpdateStatus FirebaseAppDistributionKt.component3(@NonNull UpdateProgress receiver)\n```\n\nDestructuring declaration for [UpdateProgress](/docs/reference/android/com/google/firebase/appdistribution/UpdateProgress) to provide updateStatus. \n\nFirebaseAppDistributionKt.component3 \n\n```\ndefault final @NonNull UpdateStatus FirebaseAppDistributionKt.[component3](/docs/reference/android/com/google/firebase/appdistribution/UpdateProgress#(com.google.firebase.appdistribution.UpdateProgress).component3())(@NonNull UpdateProgress receiver)\n```\n| **This method is deprecated.** \n| Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.\n\nDestructuring declaration for [UpdateProgress](/docs/reference/android/com/google/firebase/appdistribution/UpdateProgress) to provide updateStatus.\n\n**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.](https://firebase.google.com/docs/android/kotlin-migration)"]]
