We use essential cookies for the website to function, as well as analytics cookies for analyzing and creating statistics of the website performance. To agree to the use of analytics cookies, click "Accept All". You can manage your preferences at any time by clicking "Cookie Settings" on the footer. More Information.

Only Essential Cookies
Accept All

OverlayModuleInfo

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

The module provides information about a module with the overlay feature. An application can obtain such information through overlay.getOverlayModuleInfo.

NOTE

The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

Collapse
Word wrap
Dark theme
Copy code
  1. import { overlay } from '@kit.AbilityKit';

OverlayModuleInfo

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

System capability: SystemCapability.BundleManager.BundleFramework.Core

Expand
Name Type Read-Only Optional Description
bundleName string Yes No Bundle name of the application to which the module with the overlay feature belongs.
moduleName string Yes No Name of the module with the overlay feature.
targetModuleName string Yes No Name of the target module specified by the overlay feature, that is, the name of the module whose resources are to be replaced by the overlay package.
priority number Yes No Priority of the module with the overlay feature. The value is an integer ranging from 1 to 100. A larger value indicates a higher priority.
state number Yes No Whether the module with the overlay feature is disabled. The value 0 means that the module with the overlay feature is disabled, and 1 means the opposite.