Added in API level 34

OverlayManagerTransaction

class OverlayManagerTransaction : Parcelable
kotlin.Any
   ↳ android.content.om.OverlayManagerTransaction

A container for a batch of requests to the OverlayManager.

An app can get an OverlayManagerTransaction with the specified OverlayManager to handle the transaction. The app can register multiple overlays and unregister multiple registered overlays in one transaction commitment.

The below example is registering a updatingOverlay and unregistering a deprecatedOverlay in one transaction commitment. 

<code>final OverlayManager overlayManager = ctx.getSystemService(OverlayManager.class);
  final OverlayManagerTransaction transaction = new OverlayManagerTransaction(overlayManager);
  transaction.registerFabricatedOverlay(updatingOverlay);
  transaction.unregisterFabricatedOverlay(deprecatedOverlay)
  transaction.commit();
  </code>

Summary

Inherited constants
Public methods
Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
static OverlayManagerTransaction

Get an overlay manager transaction.
Unit

Registers the fabricated overlays with the overlay manager so it can be used to overlay the app resources in runtime.
Unit

Unregisters the registered overlays from the overlay manager.
Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<OverlayManagerTransaction!>

Public methods

describeContents

Added in API level 34
fun describeContents(): Int

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.

Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

newInstance

Added in API level 34
static fun newInstance(): OverlayManagerTransaction

Get an overlay manager transaction.

Return
OverlayManagerTransaction a new OverlayManagerTransaction instance. This value cannot be null.

registerFabricatedOverlay

Added in API level 34
fun registerFabricatedOverlay(overlay: FabricatedOverlay): Unit

Registers the fabricated overlays with the overlay manager so it can be used to overlay the app resources in runtime.

If an overlay is re-registered the existing overlay will be replaced by the newly registered overlay. The registered overlay will be left unchanged until the target package or target overlayable is changed.

Parameters
overlay FabricatedOverlay: the overlay to register with the overlay manager This value cannot be null.
Return
Unit This value cannot be null.

unregisterFabricatedOverlay

Added in API level 34
fun unregisterFabricatedOverlay(overlay: OverlayIdentifier): Unit

Unregisters the registered overlays from the overlay manager.

Parameters
overlay OverlayIdentifier: the overlay to be unregistered This value cannot be null.
Return
Unit This value cannot be null.

writeToParcel

Added in API level 34
fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.
flags Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 34
static val CREATOR: Parcelable.Creator<OverlayManagerTransaction!>