Stay organized with collections
Save and categorize content based on your preferences.
OverlayManager
public
class
OverlayManager
extends Object
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.
Summary
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
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 |
getOverlayInfosForTarget
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. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# OverlayManager\n\nAdded in [API level 34](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nSummary: [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nOverlayManager\n==============\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/content/om/OverlayManager \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\n\n\nclass\nOverlayManager\n`\n\n\n`\n\nextends `[Object](/reference/java/lang/Object)`\n\n\n`\n\n`\n\n\n`\n\n|---|-----------------------------------|\n| [java.lang.Object](/reference/java/lang/Object) ||\n| ↳ | android.content.om.OverlayManager |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nOverlayManager gives apps the ability to create an [OverlayManagerTransaction](/reference/android/content/om/OverlayManagerTransaction) to\nmaintain the overlays and list the registered fabricated runtime resources overlays(FRROs).\n\nOverlayManager returns the list of overlays to the app calling [getOverlayInfosForTarget(java.lang.String)](/reference/android/content/om/OverlayManager#getOverlayInfosForTarget(java.lang.String)). The app starts an [OverlayManagerTransaction](/reference/android/content/om/OverlayManagerTransaction) to manage\nthe overlays. The app can achieve the following by using [OverlayManagerTransaction](/reference/android/content/om/OverlayManagerTransaction).\n\n- register overlays\n- unregister overlays\n- execute multiple operations in one commitment by calling [commit(android.content.om.OverlayManagerTransaction)](/reference/android/content/om/OverlayManager#commit(android.content.om.OverlayManagerTransaction))\n\n\u003cbr /\u003e\n\n**See also:**\n\n- [OverlayManagerTransaction](/reference/android/content/om/OverlayManagerTransaction)\n\nSummary\n-------\n\n| ### Public methods ||\n|----------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` void` | ` `[commit](/reference/android/content/om/OverlayManager#commit(android.content.om.OverlayManagerTransaction))`(`[OverlayManagerTransaction](/reference/android/content/om/OverlayManagerTransaction)` transaction) ` Commit the overlay manager transaction. |\n| ` `[List](/reference/java/util/List)`\u003c`[OverlayInfo](/reference/android/content/om/OverlayInfo)`\u003e` | ` `[getOverlayInfosForTarget](/reference/android/content/om/OverlayManager#getOverlayInfosForTarget(java.lang.String))`(`[String](/reference/java/lang/String)` targetPackageName) ` Get the related information of self-targeting overlays for `targetPackageName`. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` `[java.lang.Object](/reference/java/lang/Object)` ` |---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](/reference/java/lang/Object) | ` `[clone](/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](/reference/java/lang/Object)` obj) ` Indicates whether some other object is \"equal to\" this one. | | ` void` | ` `[finalize](/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 `[Class](/reference/java/lang/Class)`\u003c?\u003e` | ` `[getClass](/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this `Object`. | | ` int` | ` `[hashCode](/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](/reference/java/lang/String) | ` `[toString](/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](/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` | ` `[wait](/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` | ` `[wait](/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||\n\nPublic methods\n--------------\n\n### commit\n\nAdded in [API level 34](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic void commit (OverlayManagerTransaction transaction)\n```\n\nCommit the overlay manager transaction.\n\nApplications can register overlays and unregister the registered overlays in an atomic\noperation via [OverlayManagerTransaction](/reference/android/content/om/OverlayManagerTransaction).\n\n\u003cbr /\u003e\n\n| Parameters ||\n|---------------|--------------------------------------------------------------------------------------------------------------------|\n| `transaction` | `OverlayManagerTransaction`: the series of overlay related requests to perform This value cannot be `null`. \u003cbr /\u003e |\n\n| Throws ||\n|---------------------------------------------|-----------------------------------------------|\n| [Exception](/reference/java/lang/Exception) | if not all the requests could be successfully |\n\n**See also:**\n\n- [OverlayManagerTransaction](/reference/android/content/om/OverlayManagerTransaction) \n\n### getOverlayInfosForTarget\n\nAdded in [API level 34](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic List\u003cOverlayInfo\u003e getOverlayInfosForTarget (String targetPackageName)\n```\n\nGet the related information of self-targeting overlays for `targetPackageName`.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|---------------------|-----------------------------------------------------------------------|\n| `targetPackageName` | `String`: the target package name This value cannot be `null`. \u003cbr /\u003e |\n\n| Returns ||\n|-------------------------------------------------------------------------------------------------|-------------------------------------------------------------------|\n| [List](/reference/java/util/List)`\u003c`[OverlayInfo](/reference/android/content/om/OverlayInfo)`\u003e` | a list of overlay information This value cannot be `null`. \u003cbr /\u003e |"]]
