Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Inherited Constants](https://developer.android.com/reference/android/content/om/OverlayManagerTransaction#inhconstants) \| [Fields](https://developer.android.com/reference/android/content/om/OverlayManagerTransaction#lfields) \| [Methods](https://developer.android.com/reference/android/content/om/OverlayManagerTransaction#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/content/om/OverlayManagerTransaction#inhmethods)

# OverlayManagerTransaction

*** ** * ** ***


`
public

final

class
OverlayManagerTransaction
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


implements

https://developer.android.com/reference/android/os/Parcelable


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.content.om.OverlayManagerTransaction |

<br />

*** ** * ** ***

A container for a batch of requests to the OverlayManager.

An app can get an `https://developer.android.com/reference/android/content/om/OverlayManagerTransaction` with the specified `https://developer.android.com/reference/android/content/om/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();

<br />

**See also:**

- `https://developer.android.com/reference/android/content/om/OverlayManager`
- `https://developer.android.com/reference/android/content/om/FabricatedOverlay`

## Summary

### Inherited constants

From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`

Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that
the Parcelable object's flattened representation includes a file descriptor.


`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`

Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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 https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/content/om/OverlayManagerTransaction>` | `https://developer.android.com/reference/android/content/om/OverlayManagerTransaction#CREATOR` |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/content/om/OverlayManagerTransaction#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` static https://developer.android.com/reference/android/content/om/OverlayManagerTransaction` | ` https://developer.android.com/reference/android/content/om/OverlayManagerTransaction#newInstance()() ` Get an overlay manager transaction. |
| ` void` | ` https://developer.android.com/reference/android/content/om/OverlayManagerTransaction#registerFabricatedOverlay(android.content.om.FabricatedOverlay)(https://developer.android.com/reference/android/content/om/FabricatedOverlay overlay) ` Registers the fabricated overlays with the overlay manager so it can be used to overlay the app resources in runtime. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/content/om/OverlayManagerTransaction#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/content/om/OverlayManagerTransaction#unregisterFabricatedOverlay(android.content.om.OverlayIdentifier)(https://developer.android.com/reference/android/content/om/OverlayIdentifier overlay) ` Unregisters the registered overlays from the overlay manager. |
| ` void` | ` https://developer.android.com/reference/android/content/om/OverlayManagerTransaction#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

### Inherited methods

From class `

https://developer.android.com/reference/java/lang/Object

` `


https://developer.android.com/reference/java/lang/Object` `
https://developer.android.com/reference/java/lang/Object#clone()()
`

Creates and returns a copy of this object.


`


boolean` `
https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj)
`

Indicates whether some other object is "equal to" this one.


`


void` `
https://developer.android.com/reference/java/lang/Object#finalize()()
`

Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.


`


final

https://developer.android.com/reference/java/lang/Class<?>` `
https://developer.android.com/reference/java/lang/Object#getClass()()
`

Returns the runtime class of this `Object`.


`


int` `
https://developer.android.com/reference/java/lang/Object#hashCode()()
`

Returns a hash code value for the object.


`


final

void` `
https://developer.android.com/reference/java/lang/Object#notify()()
`

Wakes up a single thread that is waiting on this object's
monitor.


`


final

void` `
https://developer.android.com/reference/java/lang/Object#notifyAll()()
`

Wakes up all threads that are waiting on this object's monitor.


`


https://developer.android.com/reference/java/lang/String` `
https://developer.android.com/reference/java/lang/Object#toString()()
`

Returns a string representation of the object.


`


final

void` `
https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` `
https://developer.android.com/reference/java/lang/Object#wait(long)(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` `
https://developer.android.com/reference/java/lang/Object#wait()()
`

Causes the current thread to wait until it is awakened, typically
by being *notified* or *interrupted*.


From interface `

https://developer.android.com/reference/android/os/Parcelable

` `
abstract


int` `
https://developer.android.com/reference/android/os/Parcelable#describeContents()()
`

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


`
abstract


void` `
https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags)
`

Flatten this object in to a Parcel.


## Fields

### CREATOR

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

<br />

## Public methods

### describeContents

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`,
the return value of this method must include the
`https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### newInstance

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static OverlayManagerTransaction newInstance ()
```

Get an overlay manager transaction.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/content/om/OverlayManagerTransaction` | a new `https://developer.android.com/reference/android/content/om/OverlayManagerTransaction` instance. This value cannot be `null`. <br /> |

### registerFabricatedOverlay

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

| Parameters ||
|---|---|
| `overlay` | `FabricatedOverlay`: the overlay to register with the overlay manager. This value cannot be `null`. <br /> |

| Returns ||
|---|---|
| `void` | This value cannot be `null`. <br /> |

### toString

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |

### unregisterFabricatedOverlay

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void unregisterFabricatedOverlay (OverlayIdentifier overlay)
```

Unregisters the registered overlays from the overlay manager.

<br />

| Parameters ||
|---|---|
| `overlay` | `OverlayIdentifier`: the overlay to be unregistered. This value cannot be `null`. <br /> |

| Returns ||
|---|---|
| `void` | This value cannot be `null`. <br /> |

**See also:**

- `https://developer.android.com/reference/android/content/om/OverlayManager#getOverlayInfosForTarget(java.lang.String)`
- `https://developer.android.com/reference/android/content/om/OverlayInfo#getOverlayIdentifier()`

### writeToParcel

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |