UnarchivalState

Kotlin |Java

class UnarchivalState

kotlin.Any
↳	android.content.pm.PackageInstaller.UnarchivalState

Used to communicate the unarchival state in reportUnarchivalState.

Summary

Public methods
static PackageInstaller.UnarchivalState	`createGenericErrorState(unarchiveId: Int)` Generic error state for all cases that are not covered by other methods in this class.
static PackageInstaller.UnarchivalState	`createInsufficientStorageState(unarchiveId: Int, requiredStorageBytes: Long, userActionIntent: PendingIntent?)` There is not enough storage to start the unarchival for the given `unarchiveId`.
static PackageInstaller.UnarchivalState	`createNoConnectivityState(unarchiveId: Int)` The device has no data connectivity and unarchival cannot be started for the given `unarchiveId`.
static PackageInstaller.UnarchivalState	`createOkState(unarchiveId: Int)` The caller is able to facilitate the unarchival for the given `unarchiveId`.
static PackageInstaller.UnarchivalState	`createUserActionRequiredState(unarchiveId: Int, userActionIntent: PendingIntent)` User action is required before commencing with the unarchival for the given `unarchiveId`.

Public methods

createGenericErrorState

Added in API level 35

static fun createGenericErrorState(unarchiveId: Int): PackageInstaller.UnarchivalState

Generic error state for all cases that are not covered by other methods in this class.

Parameters
`unarchiveId`	Int: the ID provided by the system as part of the intent.action.UNARCHIVE broadcast with EXTRA_UNARCHIVE_ID.

Return
`PackageInstaller.UnarchivalState`	This value cannot be `null`.

createInsufficientStorageState

Added in API level 35

static fun createInsufficientStorageState(
    unarchiveId: Int, 
    requiredStorageBytes: Long, 
    userActionIntent: PendingIntent?
): PackageInstaller.UnarchivalState

There is not enough storage to start the unarchival for the given unarchiveId.

Parameters
`unarchiveId`	Int: the ID provided by the system as part of the intent.action.UNARCHIVE broadcast with EXTRA_UNARCHIVE_ID.
`requiredStorageBytes`	Long: ff the error is UNARCHIVAL_ERROR_INSUFFICIENT_STORAGE this field should be set to specify how many additional bytes of storage are required to unarchive the app.
`userActionIntent`	PendingIntent?: can optionally be set to provide a custom storage-clearing action. This value may be `null`.

Return
`PackageInstaller.UnarchivalState`	This value cannot be `null`.

createNoConnectivityState

Added in API level 35

static fun createNoConnectivityState(unarchiveId: Int): PackageInstaller.UnarchivalState

The device has no data connectivity and unarchival cannot be started for the given unarchiveId.

Parameters
`unarchiveId`	Int: the ID provided by the system as part of the intent.action.UNARCHIVE broadcast with EXTRA_UNARCHIVE_ID.

Return
`PackageInstaller.UnarchivalState`	This value cannot be `null`.

createOkState

Added in API level 35

static fun createOkState(unarchiveId: Int): PackageInstaller.UnarchivalState

The caller is able to facilitate the unarchival for the given unarchiveId.

Parameters
`unarchiveId`	Int: the ID provided by the system as part of the intent.action.UNARCHIVE broadcast with EXTRA_UNARCHIVE_ID.

Return
`PackageInstaller.UnarchivalState`	This value cannot be `null`.

createUserActionRequiredState

Added in API level 35

static fun createUserActionRequiredState(
    unarchiveId: Int, 
    userActionIntent: PendingIntent
): PackageInstaller.UnarchivalState

User action is required before commencing with the unarchival for the given unarchiveId. E.g., this could be used if it's necessary for the user to sign-in first.

Parameters
`unarchiveId`	Int: the ID provided by the system as part of the intent.action.UNARCHIVE broadcast with EXTRA_UNARCHIVE_ID.
`userActionIntent`	PendingIntent: optional intent to start a follow up action required to facilitate the unarchival flow (e.g. user needs to log in). This value cannot be `null`.

Return
`PackageInstaller.UnarchivalState`	This value cannot be `null`.