Session

abandon

open fun abandon(): Unit

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 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

open fun addChildSessionId(sessionId: Int): Unit

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

open fun close(): Unit

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

commit

open fun commit(statusReceiver: IntentSender): Unit

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

open fun fsync(out: OutputStream): Unit

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

open fun getAppMetadata(): PersistableBundle

getChildSessionIds

open fun getChildSessionIds(): IntArray

getNames

open fun getNames(): Array<String!>

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

open fun getParentSessionId(): Int

isApplicationEnabledSettingPersistent

open fun isApplicationEnabledSettingPersistent(): Boolean

isMultiPackage

open fun isMultiPackage(): Boolean

isRequestUpdateOwnership

open fun isRequestUpdateOwnership(): Boolean

isStaged

open fun isStaged(): Boolean

openRead

open fun openRead(name: String): InputStream

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

open fun openWrite(
    name: String, 
    offsetBytes: Long, 
    lengthBytes: Long
): OutputStream

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

open fun removeChildSessionId(sessionId: Int): Unit

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

removeSplit

open fun removeSplit(splitName: String): Unit

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

open fun requestChecksums(
    name: String, 
    required: Int, 
    trustedInstallers: MutableList<Certificate!>, 
    executor: Executor, 
    onChecksumsReadyListener: PackageManager.OnChecksumsReadyListener
): Unit

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

open fun requestUserPreapproval(
    details: PackageInstaller.PreapprovalDetails, 
    statusReceiver: IntentSender
): Unit

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 STATUS_PENDING_USER_ACTION callback, and STATUS_SUCCESS otherwise. In case that requesting user pre-approval is not available, installers will receive 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

open fun setAppMetadata(data: PersistableBundle?): Unit

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

open fun setChecksums(
    name: String, 
    checksums: MutableList<Checksum!>, 
    signature: ByteArray?
): Unit

Deprecated: 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.

<code>DataOutputStream dos;
                   dos.writeInt(checksum.getType());
                   dos.writeInt(checksum.getValue().length);
                   dos.write(checksum.getValue());</code>

setStagingProgress

open fun setStagingProgress(progress: Float): Unit

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.