PackageInstaller.UnarchivalState


public static final class PackageInstaller.UnarchivalState
extends Object

java.lang.Object
   ↳ android.content.pm.PackageInstaller.UnarchivalState


Used to communicate the unarchival state in PackageInstaller.reportUnarchivalState(UnarchivalState).

Summary

Public methods

static PackageInstaller.UnarchivalState createGenericErrorState(int unarchiveId)

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

static PackageInstaller.UnarchivalState createInsufficientStorageState(int unarchiveId, long requiredStorageBytes, PendingIntent userActionIntent)

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

static PackageInstaller.UnarchivalState createNoConnectivityState(int unarchiveId)

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

static PackageInstaller.UnarchivalState createOkState(int unarchiveId)

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

static PackageInstaller.UnarchivalState createUserActionRequiredState(int unarchiveId, PendingIntent userActionIntent)

User action is required before commencing with the unarchival for the given unarchiveId.

Inherited methods

Public methods

createGenericErrorState

public static PackageInstaller.UnarchivalState createGenericErrorState (int unarchiveId)

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.

Returns
PackageInstaller.UnarchivalState This value cannot be null.

createInsufficientStorageState

public static PackageInstaller.UnarchivalState createInsufficientStorageState (int unarchiveId, 
                long requiredStorageBytes, 
                PendingIntent userActionIntent)

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.

Returns
PackageInstaller.UnarchivalState This value cannot be null.

createNoConnectivityState

public static PackageInstaller.UnarchivalState createNoConnectivityState (int unarchiveId)

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.

Returns
PackageInstaller.UnarchivalState This value cannot be null.

createOkState

public static PackageInstaller.UnarchivalState createOkState (int unarchiveId)

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.

Returns
PackageInstaller.UnarchivalState This value cannot be null.

createUserActionRequiredState

public static PackageInstaller.UnarchivalState createUserActionRequiredState (int unarchiveId, 
                PendingIntent userActionIntent)

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.

Returns
PackageInstaller.UnarchivalState This value cannot be null.