UnarchivalState
class UnarchivalState
Used to communicate the unarchival state in reportUnarchivalState
.
Summary
Public methods
createGenericErrorState
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. |
createInsufficientStorageState
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 . |
createNoConnectivityState
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. |
createOkState
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. |
createUserActionRequiredState
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 . |