js-apis-bundle-PackInfo.md 10.8 KB
Newer Older
1 2
# PackInfo

Z
zengyawen 已提交
3
> **说明:**
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
> 本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

应用包信息,通过接口[bundle.getBundlePackInfo](js-apis-Bundle.md)获取。

## BundlePackFlag

**系统API:** 此接口为系统接口,三方应用不支持调用

**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework

| 名称               | 值         | 说明                               |
| ------------------ | ---------- | ---------------------------------- |
| GET_PACK_INFO_ALL  | 0x00000000 | 获取应用包pack.info的所有信息。    |
| GET_PACKAGES       | 0x00000001 | 获取应用包pack.info的package信息。 |
| GET_BUNDLE_SUMMARY | 0x00000002 | 获取应用包pack.info的bundle摘要。  |
| GET_MODULE_SUMMARY | 0x00000004 | 获取应用包pack.info的module摘要。  |

## BundlePackInfo

**系统API:** 此接口为系统接口,三方应用不支持调用

**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework

| 名称     | 类型                                    | 可读 | 可写 | 说明                          |
| -------- | --------------------------------------- | ---- | ---- | ----------------------------- |
| packages | Array\<[PackageConfig](#packageconfig)> | 是   | 否   | 获取pack.info的包信息。       |
| summary  | [PackageSummary](#packagesummary)       | 是   | 否   | 获取pack.info中的包摘要信息。 |

## PackageConfig

**系统API:** 此接口为系统接口,三方应用不支持调用

**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework

| 名称                | 类型           | 可读 | 可写 | 说明                                                         |
| ------------------- | -------------- | ---- | ---- | ------------------------------------------------------------ |
| deviceType          | Array\<string> | 是   | 否   | 包支持的设备类型。                                           |
| name                | string         | 是   | 否   | 包的名称。                                                   |
| moduleType          | string         | 是   | 否   | 包的module类型。                                             |
| deliveryWithInstall | boolean        | 是   | 否   | 是否在用户主动安装的时候安装,true表示主动安装时安装,false表示主动安装时不安装。 |

## PackageSummary 

**系统API:** 此接口为系统接口,三方应用不支持调用

**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework

| 名称    | 类型                                          | 可读 | 可写 | 说明                 |
| ------- | --------------------------------------------- | ---- | ---- | -------------------- |
| app     | [BundleConfigInfo](#bundleconfiginfo)         | 是   | 否   | 包的配置信息。       |
| modules | Array\<[ModuleConfigInfo](#moduleconfiginfo)> | 是   | 否   | 包的module配置信息。 |

## BundleConfigInfo

**系统API:** 此接口为系统接口,三方应用不支持调用

**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework

| 名称       | 类型                | 可读 | 可写 | 说明                               |
| ---------- | ------------------- | ---- | ---- | ---------------------------------- |
| bundleName | string              | 是   | 否   | 应用的包名,用于标识应用的唯一性。 |
| version    | [Version](#version) | 是   | 否   | 包的版本。                         |

## ModuleConfigInfo

**系统API:** 此接口为系统接口,三方应用不支持调用

**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework

| 名称               | 类型                                              | 可读 | 可写 | 说明                               |
| ------------------ | ------------------------------------------------- | ---- | ---- | ---------------------------------- |
| apiVersion         | [ApiVersion](#apiversion)                         | 是   | 否   | module的api版本。                  |
| deviceType         | Array\<string>                                    | 是   | 否   | module的设备类型。                 |
| distro             | [ModuleDistroInfo](#moduledistroinfo)             | 是   | 否   | module发行版信息。                 |
| abilities          | Array\<[ModuleAbilityInfo](#moduleabilityinfo)>   | 是   | 否   | module的元能力信息。               |
| extensionAbilities | Array\<[ExtensionAbilities](#extensionabilities)> | 是   | 否   | 描述extensionAbilities的配置信息。 |

## ModuleDistroInfo 

**系统API:** 此接口为系统接口,三方应用不支持调用

**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework

| 名称                | 类型    | 可读 | 可写 | 说明                                                         |
| ------------------- | ------- | ---- | ---- | ------------------------------------------------------------ |
| mainAbility         | string  | 是   | 否   | 主要能力的名称。                                             |
| deliveryWithInstall | boolean | 是   | 否   | 是否在用户主动安装的时候安装,true表示主动安装时安装,false表示主动安装时不安装。 |
| installationFree    | boolean | 是   | 否   | 表示当前HAP是否支持免安装特性。true表示支持免安装特性,且符合免安装约束,false表示不支持免安装特性。 |
| moduleName          | string  | 是   | 否   | module名称。                                                 |
| moduleType          | string  | 是   | 否   | module类型。                                                 |

## ModuleAbilityInfo 

**系统API:** 此接口为系统接口,三方应用不支持调用

**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework

| 名称    | 类型                                        | 可读 | 可写 | 说明                                                         |
| ------- | ------------------------------------------- | ---- | ---- | ------------------------------------------------------------ |
| name    | string                                      | 是   | 否   | 表示当前ability的逻辑名,该名称在整个应用要唯一。            |
| label   | string                                      | 是   | 否   | 表示ability对用户显示的名称,标签值配置为该名称的资源索引以支持多语言。 |
| visible | boolean                                     | 是   | 否   | 表示ability是否可以被其它应用调用,true表示可以被其它应用调用,false表示不可以被其它应用调用。 |
| forms   | Array\<[AbilityFormInfo](#abilityforminfo)> | 是   | 否   | 卡片信息。                                                   |

## ExtensionAbilities

**系统API:** 此接口为系统接口,三方应用不支持调用

**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework

| 名称  | 类型                                        | 可读 | 可写 | 说明                                                         |
| ----- | ------------------------------------------- | ---- | ---- | ------------------------------------------------------------ |
| forms | Array\<[AbilityFormInfo](#abilityforminfo)> | 是   | 否   | 表示form卡片的规格,form卡片是可以嵌入桌面上并接收定时更新的应用简要视图。 |

## AbilityFormInfo

**系统API:** 此接口为系统接口,三方应用不支持调用

**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework

| 名称                | 类型           | 可读 | 可写 | 说明                                                         |
| ------------------- | -------------- | ---- | ---- | ------------------------------------------------------------ |
| name                | string         | 是   | 否   | 表示forms的名称。                                            |
| type                | string         | 是   | 否   | 表示forms的类型。                                            |
| updateEnabled       | boolean        | 是   | 否   | 表示该卡片是否支持定时刷新,true表示卡片支持定时刷新,false表示不支持。 |
| scheduledUpdateTime | string         | 是   | 否   | 表示卡片定点刷新的时间,采用24小时计数,精确到分钟。         |
| updateDuration      | number         | 是   | 否   | 表示卡片定时刷新的更新频率,单位为30分钟,取值为30的倍数值。卡片的最高频率为每30分钟刷新一次,和定点刷新二选一,二者都配置的情况下,定时优先。 |
| supportDimensions   | Array\<number> | 是   | 否   | 表示卡片外观规格,取值为“1\*2”,“2\*2”,“2\*4”,“4\*4”,定义卡片时至少要指定一个卡片规格。 |
| defaultDimension    | number         | 是   | 否   | 表示卡片默认外观规格,取值必须在supportDimensions配置的列表中。 |

## ApiVersion

**系统API:** 此接口为系统接口,三方应用不支持调用

**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework

| 名称        | 类型   | 可读 | 可写 | 说明                 |
| ----------- | ------ | ---- | ---- | -------------------- |
张悦诶 已提交
142 143
| releaseType | string | 是   | 否   | 版本的名称。         |
| compatible  | number | 是   | 否   | 版本的最小兼容代码。 |
144 145 146 147 148 149 150 151 152 153 154 155 156
| target      | numbe  | 是   | 否   | 目标版本号。         |

## Version

**系统API:** 此接口为系统接口,三方应用不支持调用

**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework

| 名称                     | 类型   | 可读 | 可写 | 说明                                                         |
| ------------------------ | ------ | ---- | ---- | ------------------------------------------------------------ |
| minCompatibleVersionCode | number | 是   | 否   | 能够兼容的最低历史版本号,用于跨设备兼容性判断。该值为32位整型数值,非负整数。 |
| name                     | string | 是   | 否   | 标识版本号的文字描述,用于向用户展示。                       |
| code                     | number | 是   | 否   | 标识应用的版本号,值为32位非负整数。此数字仅用于确定某个版本是否比另一个版本更新,数值越大表示版本越高。 |