PackageInstaller.Session

abandon

 public void abandon ()

Completely abandon this session, destroying all staged data and rendering it invalid. Abandoned sessions will be reported to SessionCallback listeners as failures. This is equivalent to PackageInstaller.abandonSession(int).

If the parent is abandoned, all children will also be abandoned. Any written data would be destroyed and the created Session information will be discarded.

addChildSessionId

 public void addChildSessionId (int sessionId)

Adds a session ID to the set of sessions that will be committed atomically when this session is committed.

If the parent is staged or has rollback enabled, all children must have the same properties.

If the parent is abandoned, all children will also be abandoned.

close

 public void close ()

Release this session object. You can open the session again if it hasn't been finalized.

commit

 public void commit (IntentSender statusReceiver)

Attempt to commit everything staged in this session. This may require user intervention, and so it may not happen immediately. The final result of the commit will be reported through the given callback.

Once this method is called, the session is sealed and no additional mutations may be performed on the session. In case of device reboot or data loader transient failure before the session has been finalized, you may commit the session again.

If the installer is the device owner, the affiliated profile owner, or has received user pre-approval of this session, there will be no user intervention.

fsync

 public void fsync (OutputStream out)

Ensure that any outstanding data for given stream has been committed to disk. This is only valid for streams returned from openWrite(java.lang.String, long, long).

getAppMetadata

 public PersistableBundle getAppMetadata ()

getChildSessionIds

 public int[] getChildSessionIds ()

getNames

 public String[] getNames ()

Return all APK names contained in this session.

This returns all names which have been previously written through openWrite(java.lang.String, long, long) as part of this session.

getParentSessionId

 public int getParentSessionId ()

isApplicationEnabledSettingPersistent

 public boolean isApplicationEnabledSettingPersistent ()

isMultiPackage

 public boolean isMultiPackage ()

isRequestUpdateOwnership

 public boolean isRequestUpdateOwnership ()

isStaged

 public boolean isStaged ()

openRead

 public InputStream openRead (String name)

Open a stream to read an APK file from the session.

This is only valid for names which have been previously written through openWrite(java.lang.String, long, long) as part of this session. For example, this stream may be used to calculate a MessageDigest of a written APK before committing.

openWrite

 public OutputStream openWrite (String name,                  long offsetBytes,                  long lengthBytes)

Open a stream to write an APK file into the session.

The returned stream will start writing data at the requested offset in the underlying file, which can be used to resume a partially written file. If a valid file length is specified, the system will preallocate the underlying disk space to optimize placement on disk. It's strongly recommended to provide a valid file length when known.

You can write data into the returned stream, optionally call fsync(java.io.OutputStream) as needed to ensure bytes have been persisted to disk, and then close when finished. All streams must be closed before calling commit(android.content.IntentSender).

removeChildSessionId

 public void removeChildSessionId (int sessionId)

Removes a session ID from the set of sessions that will be committed atomically when this session is committed.

removeSplit

 public void removeSplit (String splitName)

Removes a split.

Split removals occur prior to adding new APKs. If upgrading a feature split, it is not expected nor desirable to remove the split prior to upgrading.

When split removal is bundled with new APKs, the packageName must be identical.

requestChecksums

 public void requestChecksums (String name,                  int required,                  List<Certificate> trustedInstallers,                  Executor executor,                  PackageManager.OnChecksumsReadyListener onChecksumsReadyListener)

Requests checksums for the APK file in session.

A possible use case is replying to Intent.ACTION_PACKAGE_NEEDS_VERIFICATION broadcast. The checksums will be returned asynchronously via onChecksumsReadyListener.

By default returns all readily available checksums:

• enforced by platform,
• enforced by the installer.

Caution: Android can not verify installer-provided checksums. Make sure you specify trusted installers.

requestUserPreapproval

 public void requestUserPreapproval (PackageInstaller.PreapprovalDetails details,                  IntentSender statusReceiver)

Attempt to request the approval before committing this session. For installers that have been granted the REQUEST_INSTALL_PACKAGES permission, they can request the approval from users before Session.commit(IntentSender) is called. This may require user intervention as well. When user intervention is required, installers will receive a PackageInstaller.STATUS_PENDING_USER_ACTION callback, and PackageInstaller.STATUS_SUCCESS otherwise. In case that requesting user pre-approval is not available, installers will receive PackageInstaller.STATUS_FAILURE_BLOCKED instead. Note that if the users decline the request, this session will be abandoned. If user intervention is required but never resolved, or requesting user pre-approval is not available, you may still call Session.commit(IntentSender) as the typical installation.

setAppMetadata

 public void setAppMetadata (PersistableBundle data)

Optionally set the app metadata. The size of this data cannot exceed the maximum allowed. Any existing data from the previous install will not be retained even if no data is set for the current install session. Setting data to null or an empty PersistableBundle will remove any metadata that has previously been set in the same session.

setChecksums

 public void setChecksums (String name,                  List<Checksum> checksums,                  byte[] signature)

This method was deprecated in API level 31.
do not use installer-provided checksums, use platform-enforced checksums e.g. Checksum.TYPE_WHOLE_MERKLE_ROOT_4K_SHA256 in PackageManager.requestChecksums.

Sets installer-provided checksums for the APK file in session.

DataOutputStream dos;                   dos.writeInt(checksum.getType());                   dos.writeInt(checksum.getValue().length);                   dos.write(checksum.getValue());

setStagingProgress

 public void setStagingProgress (float progress)

Set current progress of staging this session. Valid values are anywhere between 0 and 1.

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

transfer

 public void transfer (String packageName)

Transfer the session to a new owner.

Only sessions that update the installing app can be transferred.

After the transfer to a package with a different uid all method calls on the session will cause SecurityExceptions.

Once this method is called, the session is sealed and no additional mutations beside committing it may be performed on the session.