PackageInstaller.SessionInfo

INVALID_ID

public static final int INVALID_ID

A session ID that does not exist or is invalid.

Constant Value: -1 (0xffffffff)

SESSION_ACTIVATION_FAILED

public static final int SESSION_ACTIVATION_FAILED

Constant indicating that an error occurred during the activation phase of this session.

Constant Value: 2 (0x00000002)

SESSION_CONFLICT

public static final int SESSION_CONFLICT

Constant indicating that the session was in conflict with another session and had to be sacrificed for resolution.

Constant Value: 4 (0x00000004)

SESSION_NO_ERROR

public static final int SESSION_NO_ERROR

Constant indicating that no error occurred during the preparation or the activation of this session.

Constant Value: 0 (0x00000000)

SESSION_UNKNOWN_ERROR

public static final int SESSION_UNKNOWN_ERROR

Constant indicating that an unknown error occurred while processing this session.

Constant Value: 3 (0x00000003)

SESSION_VERIFICATION_FAILED

public static final int SESSION_VERIFICATION_FAILED

Constant indicating that an error occurred during the verification phase of this session.

Constant Value: 1 (0x00000001)

STAGED_SESSION_ACTIVATION_FAILED

public static final int STAGED_SESSION_ACTIVATION_FAILED

This constant was deprecated in API level 33.
use SESSION_ACTIVATION_FAILED.

Constant Value: 2 (0x00000002)

STAGED_SESSION_CONFLICT

public static final int STAGED_SESSION_CONFLICT

This constant was deprecated in API level 33.
use SESSION_CONFLICT.

Constant Value: 4 (0x00000004)

STAGED_SESSION_NO_ERROR

public static final int STAGED_SESSION_NO_ERROR

This constant was deprecated in API level 33.
use SESSION_NO_ERROR.

Constant Value: 0 (0x00000000)

STAGED_SESSION_UNKNOWN

public static final int STAGED_SESSION_UNKNOWN

This constant was deprecated in API level 33.
use SESSION_UNKNOWN_ERROR.

Constant Value: 3 (0x00000003)

STAGED_SESSION_VERIFICATION_FAILED

public static final int STAGED_SESSION_VERIFICATION_FAILED

This constant was deprecated in API level 33.
use SESSION_VERIFICATION_FAILED.

Constant Value: 1 (0x00000001)

CREATOR

public static final Creator<PackageInstaller.SessionInfo> CREATOR

createDetailsIntent

public Intent createDetailsIntent ()

Return an Intent that can be started to view details about this install session. This may surface actions such as pause, resume, or cancel.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

describeContents

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

getAppIcon

public Bitmap getAppIcon ()

Return an icon representing the app being installed. May be null if unavailable.

getAppLabel

public CharSequence getAppLabel ()

Return a label representing the app being installed. May be null if unavailable.

getAppPackageName

public String getAppPackageName ()

Return the package name this session is working with. May be null if unknown.

getChildSessionIds

public int[] getChildSessionIds ()

Returns the set of session IDs that will be committed when this session is committed if this session is a multi-package session.

getCreatedMillis

public long getCreatedMillis ()

The timestamp of the initial creation of the session.

getDontKillApp

public boolean getDontKillApp ()

Get the value set in SessionParams.setDontKillApp(boolean).

getInstallLocation

public int getInstallLocation ()

Get the value set in SessionParams.setInstallLocation(int).

getInstallReason

public int getInstallReason ()

Return the reason for installing this package.

getInstallerAttributionTag

public String getInstallerAttributionTag ()

getInstallerPackageName

public String getInstallerPackageName ()

Return the package name of the app that owns this session.

getInstallerUid

public int getInstallerUid ()

Returns the Uid of the owner of the session.

getMode

public int getMode ()

Get the mode of the session as set in the constructor of the SessionParams.

getOriginatingUid

public int getOriginatingUid ()

Get the value set in SessionParams.setOriginatingUid(int).

getOriginatingUri

public Uri getOriginatingUri ()

Get the value set in SessionParams.setOriginatingUri(Uri). Note: This value will only be non-null for the owner of the session.

getPackageSource

public int getPackageSource ()

Get the package source that was set in PackageInstaller.SessionParams.setPackageSource(int).

getParentSessionId

public int getParentSessionId ()

Returns the parent multi-package session ID if this session belongs to one, INVALID_ID otherwise.

getProgress

public float getProgress ()

Return current overall progress of this session, between 0 and 1.

Note that this progress may not directly correspond to the value reported by PackageInstaller.Session.setStagingProgress(float), as the system may carve out a portion of the overall progress to represent its own internal installation work.

getReferrerUri

public Uri getReferrerUri ()

Get the value set in SessionParams.setReferrerUri(Uri) Note: This value will only be non-null for the owner of the session.

getRequireUserAction

public int getRequireUserAction ()

Whether user action was required by the installer.

Note: a return value of USER_ACTION_NOT_REQUIRED does not guarantee that the install will not result in user action.

getSessionId

public int getSessionId ()

Return the ID for this session.

getSize

public long getSize ()

Get the value as set in SessionParams.setSize(long).

The value is a hint and does not have to match the actual size.

getStagedSessionErrorCode

public int getStagedSessionErrorCode ()

If something went wrong with a staged session, clients can check this error code to understand which kind of failure happened. Only meaningful if isStaged is true.

getStagedSessionErrorMessage

public String getStagedSessionErrorMessage ()

Text description of the error code returned by getStagedSessionErrorCode, or empty string if no error was encountered.

getUpdatedMillis

public long getUpdatedMillis ()

The timestamp of the last update that occurred to the session, including changing of states in case of staged sessions.
Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.

getUser

public UserHandle getUser ()

Return the user associated with this session.

hasParentSessionId

public boolean hasParentSessionId ()

Returns true if session has a valid parent session, otherwise false.

isActive

public boolean isActive ()

Return if this session is currently active.

A session is considered active whenever there is ongoing forward progress being made, such as the installer holding an open Session instance while streaming data into place, or the system optimizing code as the result of Session.commit(IntentSender).

If the installer closes the Session without committing, the session is considered inactive until the installer opens the session again.

isApplicationEnabledSettingPersistent

public boolean isApplicationEnabledSettingPersistent ()

Returns true if this session will keep the existing application enabled setting after installation.

isCommitted

public boolean isCommitted ()

Returns true if Session.commit(IntentSender)} was called for this session.

isMultiPackage

public boolean isMultiPackage ()

Returns true if this session is a multi-package session containing references to other sessions.

isPreApprovalRequested

public boolean isPreApprovalRequested ()

Returns whether this session has requested user pre-approval.

isRequestUpdateOwnership

public boolean isRequestUpdateOwnership ()

isSealed

public boolean isSealed ()

Return if this session is sealed.

Once sealed, no further changes may be made to the session. A session is sealed the moment Session.commit(IntentSender) is called.

isStaged

public boolean isStaged ()

Returns true if this session is a staged session.

isStagedSessionActive

public boolean isStagedSessionActive ()

Returns true if this session is an active staged session. We consider a session active if it has been committed and it is either pending verification, or will be applied at next reboot.

Staged session is active iff:

• It is committed, i.e. SessionInfo.isCommitted() is true, and
• it is not applied, i.e. SessionInfo.isStagedSessionApplied() is false, and
• it is not failed, i.e. SessionInfo.isStagedSessionFailed() is false.

In case of a multi-package session, reasoning above is applied to the parent session, since that is the one that should have been committed.

isStagedSessionApplied

public boolean isStagedSessionApplied ()

Whether the staged session has been applied successfully, meaning that all of its packages have been activated and no further action is required. Only meaningful if isStaged is true.

isStagedSessionFailed

public boolean isStagedSessionFailed ()

Whether something went wrong and the staged session is declared as failed, meaning that it will be ignored at next reboot. Only meaningful if isStaged is true.

isStagedSessionReady

public boolean isStagedSessionReady ()

Whether the staged session is ready to be applied at next reboot. Only meaningful if isStaged is true.

isUnarchival

public boolean isUnarchival ()

Returns true if the session is an unarchival.

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.