• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# BundlePackInfo (系统接口)
2<!--Kit: Ability Kit-->
3<!--Subsystem: BundleManager-->
4<!--Owner: @wanghang904-->
5<!--Designer: @hanfeng6-->
6<!--Tester: @kongjing2-->
7<!--Adviser: @Brilliantry_Rui-->
8
9应用包信息,通过接口[freeInstall.getBundlePackInfo](js-apis-freeInstall-sys.md#getbundlepackinfo)获取。
10
11> **说明:**
12>
13> 本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
14>
15> 本模块为系统接口。
16
17## 导入模块
18
19```js
20import { freeInstall } from '@kit.AbilityKit';
21```
22
23## BundlePackInfo
24
25**系统接口:** 此接口为系统接口。
26
27**系统能力:** SystemCapability.BundleManager.BundleFramework.FreeInstall
28
29| 名称     | 类型                                    | 只读 | 可选 | 说明                      |
30| -------- | --------------------------------------- | ---- | ---- | ------------------------- |
31| packages | Array\<[PackageConfig](#packageconfig)> | 是   | 否   | pack.info的包信息。       |
32| summary  | [PackageSummary](#packagesummary)       | 是   | 否   | pack.info中的包摘要信息。 |
33
34## PackageConfig
35
36**系统接口:** 此接口为系统接口。
37
38**系统能力:** SystemCapability.BundleManager.BundleFramework.FreeInstall
39
40| 名称                | 类型           | 只读 | 可选 | 说明                                                         |
41| ------------------- | -------------- | ---- | ---- | ------------------------------------------------------------ |
42| deviceTypes          | Array\<string> | 是   | 否   | 包支持的设备类型。                                       |
43| name                | string         | 是   | 否   | 包的名称。                                                   |
44| moduleType          | string         | 是   | 否   | 包的module类型。                                             |
45| deliveryWithInstall | boolean        | 是   | 否   | 是否跟随应用一起安装。true表示跟随应用一起安装,false表示不跟随应用一起安装。 |
46
47## PackageSummary
48
49**系统接口:** 此接口为系统接口。
50
51**系统能力:** SystemCapability.BundleManager.BundleFramework.FreeInstall
52
53| 名称    | 类型                                          | 只读 | 可选 | 说明                 |
54| ------- | --------------------------------------------- | ---- | ---- | -------------------- |
55| app     | [BundleConfigInfo](#bundleconfiginfo)         | 是   | 否   | 包的配置信息。       |
56| modules | Array\<[ModuleConfigInfo](#moduleconfiginfo)> | 是   | 否   | 包的module配置信息。 |
57
58## BundleConfigInfo
59
60**系统接口:** 此接口为系统接口。
61
62**系统能力:** SystemCapability.BundleManager.BundleFramework.FreeInstall
63
64| 名称       | 类型                | 只读 | 可选 | 说明                                   |
65| ---------- | ------------------- | ---- | ---- | -------------------------------------- |
66| bundleName | string              | 是   | 否   | 应用Bundle名称,用于标识应用的唯一性。 |
67| version    | [Version](#version) | 是   | 否   | 包的版本。                             |
68
69## ModuleConfigInfo
70
71**系统接口:** 此接口为系统接口。
72
73**系统能力:** SystemCapability.BundleManager.BundleFramework.FreeInstall
74
75| 名称               | 类型                                              | 只读 | 可选 | 说明                               |
76| ------------------ | ------------------------------------------------- | ---- | ---- | ---------------------------------- |
77| mainAbility | string | 是 | 否 | 应用主ability的名称。 |
78| apiVersion         | [ApiVersion](#apiversion)                         | 是   | 否   | module的api版本。                  |
79| deviceTypes         | Array\<string>                                    | 是   | 否   | module的设备类型。                 |
80| distro             | [ModuleDistroInfo](#moduledistroinfo)             | 是   | 否   | module发行版信息。                 |
81| abilities          | Array\<[ModuleAbilityInfo](#moduleabilityinfo)>   | 是   | 否   | module包含的ability组件信息。               |
82| extensionAbilities | Array\<[ExtensionAbility](#extensionability)> | 是   | 否   | 描述extensionAbilities的配置信息。 |
83
84## ModuleDistroInfo
85
86**系统接口:** 此接口为系统接口。
87
88**系统能力:** SystemCapability.BundleManager.BundleFramework.FreeInstall
89
90| 名称                | 类型    | 只读 | 可选 | 说明                                                         |
91| ------------------- | ------- | ---- | ---- | ------------------------------------------------------------ |
92| deliveryWithInstall | boolean | 是   | 否   | 是否跟随应用一起安装。true表示跟随应用一起安装,false表示不跟随应用一起安装。 |
93| installationFree    | boolean | 是   | 否   | 表示当前HAP是否支持免安装特性。true表示支持免安装特性,且符合免安装约束,false表示不支持免安装特性。 |
94| moduleName          | string  | 是   | 否   | module名称。                                                 |
95| moduleType          | string  | 是   | 否   | module类型。                                                 |
96
97## ModuleAbilityInfo
98
99**系统接口:** 此接口为系统接口。
100
101**系统能力:** SystemCapability.BundleManager.BundleFramework.FreeInstall
102
103| 名称    | 类型                                        | 只读 | 可选 | 说明                                                         |
104| ------- | ------------------------------------------- | ---- | ---- | ------------------------------------------------------------ |
105| name    | string                                      | 是   | 否   | 表示当前ability的名称,该名称在整个应用要唯一。            |
106| label   | string                                      | 是   | 否   | 表示ability对用户显示的名称,标签值配置为该名称的资源索引以支持多语言。 |
107| exported | boolean                                     | 是   | 否   | 表示ability是否可以被其它应用调用。true表示可以被其它应用调用,false表示不可以被其它应用调用。 |
108| forms   | Array\<[AbilityFormInfo](#abilityforminfo)> | 是   | 否   | 卡片信息。                                                   |
109
110## ExtensionAbility
111
112**系统接口:** 此接口为系统接口。
113
114**系统能力:** SystemCapability.BundleManager.BundleFramework.FreeInstall
115
116| 名称  | 类型                                        | 只读 | 可选 | 说明                                                         |
117| ----- | ------------------------------------------- | ---- | ---- | ------------------------------------------------------------ |
118| name | string | 是 | 否 | 表示该ExtensionAbility的名称。 |
119| forms | Array\<[AbilityFormInfo](#abilityforminfo)> | 是   | 否   | 表示form卡片的规格,form卡片是可以嵌入桌面上并接收定时更新的应用简要视图。 |
120
121## AbilityFormInfo
122
123**系统接口:** 此接口为系统接口。
124
125**系统能力:** SystemCapability.BundleManager.BundleFramework.FreeInstall
126
127| 名称                | 类型           | 只读 | 可选 | 说明                                                         |
128| ------------------- | -------------- | ---- | ---- | ------------------------------------------------------------ |
129| name                | string         | 是   | 否   | 表示forms的名称。                                            |
130| type                | string         | 是   | 否   | 表示forms的类型。                                            |
131| updateEnabled       | boolean        | 是   | 否   | 表示该卡片是否支持定时刷新,true表示卡片支持定时刷新,false表示不支持。 |
132| scheduledUpdateTime | string         | 是   | 否   | 表示卡片定点刷新的时间,采用24小时计数,精确到分钟。         |
133| updateDuration      | number         | 是   | 否   | 表示卡片定时刷新的更新频率,单位为30分钟,取值为30的倍数值。卡片的最高频率为每30分钟刷新一次,和定点刷新二选一,二者都配置的情况下,定时优先。 |
134| supportDimensions   | Array\<string> | 是   | 否   | 表示卡片外观规格,取值为“1\*2”,“2\*2”,“2\*4”,“4\*4”,定义卡片时至少要指定一个卡片规格。 |
135| defaultDimension    | string         | 是   | 否   | 表示卡片默认外观规格,取值必须在supportDimensions配置的列表中。 |
136
137## ApiVersion
138
139**系统接口:** 此接口为系统接口。
140
141**系统能力:** SystemCapability.BundleManager.BundleFramework.FreeInstall
142
143| 名称        | 类型   | 只读 | 可选 | 说明                 |
144| ----------- | ------ | ---- | ---- | -------------------- |
145| releaseType | string | 是   | 否   | 版本的名称。         |
146| compatible  | number | 是   | 否   | 版本的最小兼容代码。 |
147| target      | number | 是   | 否   | 目标版本号。         |
148
149## Version
150
151**系统接口:** 此接口为系统接口。
152
153**系统能力:** SystemCapability.BundleManager.BundleFramework.FreeInstall
154
155| 名称                     | 类型   | 只读 | 可选 | 说明                                                         |
156| ------------------------ | ------ | ---- | ---- | ------------------------------------------------------------ |
157| minCompatibleVersionCode | number | 是   | 否   | 能够兼容的最低历史版本号,用于跨设备兼容性判断。该值为32位整型数值,非负整数。 |
158| name                     | string | 是   | 否   | 标识版本号的文字描述,用于向用户展示。                       |
159| code                     | number | 是   | 否   | 标识应用的版本号,值为32位非负整数。此数字仅用于确定某个版本是否比另一个版本更新,数值越大表示版本越高。 |
160