OverlayManager

Kotlin |Java

public class OverlayManager
extends Object

java.lang.Object
↳	android.content.om.OverlayManager

OverlayManager gives apps the ability to create an OverlayManagerTransaction to maintain the overlays and list the registered fabricated runtime resources overlays(FRROs).

OverlayManager returns the list of overlays to the app calling getOverlayInfosForTarget(java.lang.String). The app starts an OverlayManagerTransaction to manage the overlays. The app can achieve the following by using OverlayManagerTransaction.

register overlays
unregister overlays
execute multiple operations in one commitment by calling commit(android.content.om.OverlayManagerTransaction)

See also:

OverlayManagerTransaction

Summary

Public methods
`void`	`commit(OverlayManagerTransaction transaction)` Commit the overlay manager transaction.
`List<OverlayInfo>`	`getOverlayInfosForTarget(String targetPackageName)` Get the related information of self-targeting overlays for `targetPackageName`.

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.

Public methods

commit

Added in API level 34

public void commit (OverlayManagerTransaction transaction)

Commit the overlay manager transaction.

Applications can register overlays and unregister the registered overlays in an atomic operation via OverlayManagerTransaction.

Parameters
`transaction`	`OverlayManagerTransaction`: the series of overlay related requests to perform This value cannot be `null`.

Throws
`Exception`	if not all the requests could be successfully

See also:

OverlayManagerTransaction

getOverlayInfosForTarget

Added in API level 34

public List<OverlayInfo> getOverlayInfosForTarget (String targetPackageName)

Get the related information of self-targeting overlays for targetPackageName.

Parameters
`targetPackageName`	`String`: the target package name This value cannot be `null`.

Returns
`List<OverlayInfo>`	a list of overlay information This value cannot be `null`.