UpdateProgress

public interface UpdateProgress

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

Summary

Public methods
`abstract long`	`getApkBytesDownloaded()` Returns the number of bytes downloaded so far for an APK.
`abstract long`	`getApkFileTotalBytes()` Returns the file size of the APK file to download in bytes.
`abstract @NonNull UpdateStatus`	`getUpdateStatus()` Returns the current `UpdateStatus` of the update.

Extension functions
`default final long`	`FirebaseAppDistributionKt.component1(@NonNull UpdateProgress receiver)` Destructuring declaration for `UpdateProgress` to provide apkBytesDownloaded.
`default final long`	`FirebaseAppDistributionKt.component1(@NonNull UpdateProgress receiver)` This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.
`default final long`	`FirebaseAppDistributionKt.component2(@NonNull UpdateProgress receiver)` Destructuring declaration for `UpdateProgress` to provide apkFileTotalBytes.
`default final long`	`FirebaseAppDistributionKt.component2(@NonNull UpdateProgress receiver)` This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.
`default final @NonNull UpdateStatus`	`FirebaseAppDistributionKt.component3(@NonNull UpdateProgress receiver)` Destructuring declaration for `UpdateProgress` to provide updateStatus.
`default final @NonNull UpdateStatus`	`FirebaseAppDistributionKt.component3(@NonNull UpdateProgress receiver)` This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.

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.

getUpdateStatus

abstract @NonNull UpdateStatus getUpdateStatus()

Returns the current UpdateStatus of the update.

Extension functions

FirebaseAppDistributionKt.component1

default final long FirebaseAppDistributionKt.component1(@NonNull UpdateProgress receiver)

Destructuring declaration for UpdateProgress to provide apkBytesDownloaded.

Returns
`long`	the apkBytesDownloaded of the `UpdateProgress`

FirebaseAppDistributionKt.component1

default final long FirebaseAppDistributionKt.component1(@NonNull UpdateProgress receiver)

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`

FirebaseAppDistributionKt.component2

default final long FirebaseAppDistributionKt.component2(@NonNull UpdateProgress receiver)

Destructuring declaration for UpdateProgress to provide apkFileTotalBytes.

Returns
`long`	the apkFileTotalBytes of the `UpdateProgress`

FirebaseAppDistributionKt.component2

default final long FirebaseAppDistributionKt.component2(@NonNull UpdateProgress receiver)

Destructuring declaration for UpdateProgress to provide apkFileTotalBytes.

Returns
`long`	the apkFileTotalBytes of the `UpdateProgress`

FirebaseAppDistributionKt.component3

default final @NonNull UpdateStatus FirebaseAppDistributionKt.component3(@NonNull UpdateProgress receiver)

Destructuring declaration for UpdateProgress to provide updateStatus.

Returns
`@NonNull UpdateStatus`	the updateStatus of the `UpdateProgress`

FirebaseAppDistributionKt.component3

default final @NonNull UpdateStatus FirebaseAppDistributionKt.component3(@NonNull UpdateProgress receiver)

Destructuring declaration for UpdateProgress to provide updateStatus.

Returns
`@NonNull UpdateStatus`	the updateStatus of the `UpdateProgress`