OverlayManagerTransaction

public final class OverlayManagerTransaction
extends Object implements Parcelable

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.

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

Summary

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<OverlayManagerTransaction>`	`CREATOR`

Public constructors
`OverlayManagerTransaction(OverlayManager overlayManager)` Get an overlay manager transaction with the specified handler.

Public methods
`void`	`commit()` Commit the overlay manager transaction to register or unregister overlays for self-targeting.
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`void`	`registerFabricatedOverlay(FabricatedOverlay overlay)` Registers the fabricated overlays with the overlay manager so it can be used to overlay the app resources in runtime.
`void`	`unregisterFabricatedOverlay(OverlayIdentifier overlay)` Unregisters the registered overlays from the overlay manager.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

Public constructors

public OverlayManagerTransaction (OverlayManager overlayManager)

Get an overlay manager transaction with the specified handler.

Parameters
`overlayManager`	`OverlayManager`: handles this transaction. This value cannot be `null`.

Public methods

commit

public void commit ()

Commit the overlay manager transaction to register or unregister overlays for self-targeting.

Applications can register overlays and unregister the registered overlays via OverlayManagerTransaction.

Throws
`IOException`	if there is a file operation error.
`PackageManager.NameNotFoundException`	if the package name is not found.

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.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

registerFabricatedOverlay

public void registerFabricatedOverlay (FabricatedOverlay overlay)

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

Returns
`void`	This value cannot be `null`.

unregisterFabricatedOverlay

public void unregisterFabricatedOverlay (OverlayIdentifier overlay)

Unregisters the registered overlays from the overlay manager.

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

Returns
`void`	This value cannot be `null`.

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES