• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# PluginBundleInfo (System API)
2<!--Kit: Ability Kit-->
3<!--Subsystem: BundleManager-->
4<!--Owner: @wanghang904-->
5<!--Designer: @hanfeng6-->
6<!--Tester: @kongjing2-->
7<!--Adviser: @Brilliantry_Rui-->
8
9The module defines plugin information, which is obtained through the [bundleManager.getAllPluginInfo](js-apis-bundleManager-sys.md#bundlemanagergetallplugininfo19) API.
10
11> **NOTE**
12>
13> The initial APIs of this module are supported since API version 19. Newly added APIs will be marked with a superscript to indicate their earliest API version.
14>
15> The APIs provided by this module are system APIs.
16
17## Modules to Import
18
19```ts
20import { bundleManager } from '@kit.AbilityKit';
21```
22
23## PluginBundleInfo
24Defines the plugin information.
25
26**System capability**: SystemCapability.BundleManager.BundleFramework.Core
27
28**System API**: This is a system API.
29
30| Name          | Type  | Read-Only| Optional| Description          |
31| -------------- | ------ | ---- | ---- | -------------- |
32| label   | string | Yes  | No  | Plugin name.  |
33| labelId   | number | Yes  | No  | Resource ID of the plugin name.  |
34| icon   | string | Yes  | No  | Plugin icon.  |
35| iconId   | number | Yes  | No  | Resource ID of the plugin icon.  |
36| pluginBundleName   | string | Yes  | No  | Bundle name of the application for which the plugin is installed.  |
37| versionCode   | string | Yes  | No  | Version number of the plugin.  |
38| versionName   | string | Yes  | No  | Version name of the plugin.  |
39| pluginModuleInfos   | Array<[PluginModuleInfo](js-apis-bundleManager-pluginBundleInfo-sys.md#pluginmoduleinfo)> | Yes  | No  | Module information of the plugin.  |
40
41## PluginModuleInfo
42Defines the module information of a plugin.
43
44**System capability**: SystemCapability.BundleManager.BundleFramework.Core
45
46**System API**: This is a system API.
47
48| Name          | Type  | Read-Only| Optional| Description          |
49| -------------- | ------ | ---- | ---- | -------------- |
50| moduleName   | string | Yes  | No  |  Module name of the plugin. |
51| descriptionId   | number | Yes  | No  |  Resource ID of the module description. |
52| description   | string | Yes  | No  |  Description of the module. |
53