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