OverlayManager
open class OverlayManager
| kotlin.Any | |
| ↳ | 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)
Summary
| Public methods | |
|---|---|
| open Unit |
commit(transaction: OverlayManagerTransaction)Commit the overlay manager transaction. |
| open MutableList<OverlayInfo!> |
getOverlayInfosForTarget(targetPackageName: String)Get the related information of self-targeting overlays for |
Public methods
commit
open fun commit(transaction: OverlayManagerTransaction): Unit
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. |
| Exceptions | |
|---|---|
java.lang.Exception |
if not all the requests could be successfully |
getOverlayInfosForTarget
open fun getOverlayInfosForTarget(targetPackageName: String): MutableList<OverlayInfo!>
Get the related information of self-targeting overlays for targetPackageName.
| Parameters | |
|---|---|
targetPackageName |
String: the target package name This value cannot be null. |
| Return | |
|---|---|
MutableList<OverlayInfo!> |
a list of overlay information This value cannot be null. |