• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# OverlayModuleInfo
2<!--Kit: Ability Kit-->
3<!--Subsystem: BundleManager-->
4<!--Owner: @wanghang904-->
5<!--Designer: @hanfeng6-->
6<!--Tester: @kongjing2-->
7<!--Adviser: @Brilliantry_Rui-->
8
9The module provides information about a module with the overlay feature. An application can obtain such information through [overlay.getOverlayModuleInfo](js-apis-overlay.md#overlaygetoverlaymoduleinfo).
10
11> **NOTE**
12>
13> 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.
14
15## Modules to Import
16
17``` ts
18import { overlay } from '@kit.AbilityKit';
19```
20
21## OverlayModuleInfo
22
23**System capability**: SystemCapability.BundleManager.BundleFramework.Core
24
25| Name                 | Type                                               | Read-Only| Optional| Description                                           |
26| --------------------- | ---------------------------------------------------| ---- | ---- | ---------------------------------------------- |
27| bundleName            | string                                             | Yes  | No  | Bundle name of the application to which the module with the overlay feature belongs.          |
28| moduleName            | string                                             | Yes  | No  | Name of the module with the overlay feature.                      |
29| targetModuleName      | string                                             | Yes  | No  | Name of the target module specified by the module with the overlay feature.       |
30| 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.   |
31| state                 | number                                             | Yes  | No  | Whether the module with the overlay feature is [disabled](js-apis-overlay.md#overlaysetoverlayenabled). The value **0** means that the module with the overlay feature is disabled, and **1** means the opposite.                      |
32