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