提交 f7de405d 编写于 作者: 张悦诶

bundleinfo.md中添加bundlepackinfo说明

Signed-off-by: N张悦诶 <zhangyue230@h-partners.com>
上级 bf5968fd
......@@ -92,6 +92,7 @@
- bundle/[PermissionDef (PermissionDef)](js-apis-bundle-PermissionDef.md)
- bundle/[RemoteAbilityInfo (RemoteAbilityInfo)](js-apis-bundle-remoteAbilityInfo.md)
- bundle/[ShortcutInfo (ShortcutInfo)](js-apis-bundle-ShortcutInfo.md)
- bundle/[PackInfo (PackInfo)](js-apis-bundle-PackInfo.md)
- UI界面
- [@ohos.animator (动画)](js-apis-animator.md)
......
......@@ -908,11 +908,11 @@ SystemCapability.BundleManager.BundleFramework
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| -------------- | ---------------------------------- | ---- | ---------------------------------------------------- |
| bundleName | string | 是 | 应用程序包名称。 |
| bundlePackFlag | pack.BundlePackFlag | 是 | 指示要查询的应用包标志 |
| callback | AsyncCallback<pack.BundlePackInfo> | 是 | 程序启动作为入参的回调函数,返回BundlePackInfo信息。 |
| 名称 | 类型 | 必填 | 描述 |
| -------------- | ------------------------------------------------------------ | ---- | ---------------------------------------------------- |
| bundleName | string | 是 | 应用程序包名称。 |
| bundlePackFlag | [pack.BundlePackFlag](js-apis-bundle-PackInfo.md) | 是 | 指示要查询的应用包标志 |
| callback | AsyncCallback<[pack.BundlePackInfo](js-apis-bundle-PackInfo.md)> | 是 | 程序启动作为入参的回调函数,返回BundlePackInfo信息。 |
## bundle.getBundlePackInfo<sup>9+</sup>
......@@ -930,16 +930,16 @@ SystemCapability.BundleManager.BundleFramework
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| -------------- | ------------------- | ---- | ---------------------- |
| bundleName | string | 是 | 应用程序包名称。 |
| bundlePackFlag | pack.BundlePackFlag | 是 | 指示要查询的应用包标志 |
| 名称 | 类型 | 必填 | 描述 |
| -------------- | ------------------------------------------------- | ---- | ---------------------- |
| bundleName | string | 是 | 应用程序包名称。 |
| bundlePackFlag | [pack.BundlePackFlag](js-apis-bundle-PackInfo.md) | 是 | 指示要查询的应用包标志 |
**返回值:**
| 类型 | 说明 |
| ---------------------------- | ----------------------------------- |
| Promise<pack.BundlePackInfo> | Promise形式返回BundlePackInfo信息。 |
| 类型 | 说明 |
| ---------------------------------------------------------- | ----------------------------------- |
| Promise<[pack.BundlePackInfo](js-apis-bundle-PackInfo.md)> | Promise形式返回BundlePackInfo信息。 |
## bundle.getDispatcherVersion<sup>9+</sup>
......@@ -2628,154 +2628,3 @@ ExtensionAbility的类型
| NOT_UPGRADE<sup>9+</sup> | 0 | 模块无需升级 |
| SINGLE_UPGRADE<sup>9+</sup> | 1 | 单个模块需要升级 |
| RELATION_UPGRADE<sup>9+</sup> | 2 | 关系模块需要升级 |
## 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> | 是 | 否 | 获取pack.info的包信息 |
| summary | 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 | 是 | 否 | 包的配置信息 |
| modules | Array<ModuleConfigInfo> | 是 | 否 | 包的module配置信息 |
## BundleConfigInfo
**系统API:** 此接口为系统接口,三方应用不支持调用
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ---------- | ------------------- | ---- | ---- | ---------------------------------- |
| bundleName | string | 是 | 否 | 应用的包名,用于标识应用的唯一性。 |
| version | [Version](#version) | 是 | 否 | 包的版本 |
## ModuleConfigInfo
**系统API:** 此接口为系统接口,三方应用不支持调用
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------ | ------------------------- | ---- | ---- | -------------------------------- |
| apiVersion | ApiVersion | 是 | 否 | module的api版本 |
| deviceType | Array<string> | 是 | 否 | module的设备类型 |
| distro | ModuleDistroInfo | 是 | 否 | module发行版信息 |
| abilities | Array<ModuleAbilityInfo> | 是 | 否 | module的元能力信息 |
| extensionAbilities | Array<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> | 是 | 否 | 卡片信息 |
## ExtensionAbilities
**系统API:** 此接口为系统接口,三方应用不支持调用
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----- | ---------------------- | ---- | ---- | ------------------------------------------------------------ |
| forms | Array<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
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | ------ | ---- | ---- | ------------------ |
| releaseType | string | 是 | 否 | 版本的最小兼容代码 |
| compatible | number | 是 | 否 | 版本的名称 |
| target | numbe | 是 | 否 | 目标版本号 |
## Version
**系统API:** 此接口为系统接口,三方应用不支持调用
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------------ | ------ | ---- | ---- | ------------------------------------------------------------ |
| minCompatibleVersionCode | number | 是 | 否 | 能够兼容的最低历史版本号,用于跨设备兼容性判断。该值为32位整型数值,非负整数。 |
| name | string | 是 | 否 | 标识版本号的文字描述,用于向用户展示。 |
| code | number | 是 | 否 | 标识应用的版本号,值为32位非负整数。此数字仅用于确定某个版本是否比另一个版本更新,数值越大表示版本越高。 |
......@@ -66,4 +66,4 @@
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------- | -------------- | ---- | ---- | ------------------------- |
| abilities | Array\<string> | 是 | 是 | 使用到该权限的Ability集合 |
| when | string | 是 | 是 | 使用该权限的时机 |
\ No newline at end of file
| when | string | 是 | 是 | 使用该权限的时机 |
# PackInfo
> ![](D:\docs_new\docs\zh-cn\application-dev\reference\apis\public_sys-resources\icon-note.gif) **说明:**
> 本模块首批接口从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
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | ------ | ---- | ---- | -------------------- |
| releaseType | string | 是 | 否 | 版本的最小兼容代码。 |
| compatible | number | 是 | 否 | 版本的名称。 |
| target | numbe | 是 | 否 | 目标版本号。 |
## Version
**系统API:** 此接口为系统接口,三方应用不支持调用
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------------ | ------ | ---- | ---- | ------------------------------------------------------------ |
| minCompatibleVersionCode | number | 是 | 否 | 能够兼容的最低历史版本号,用于跨设备兼容性判断。该值为32位整型数值,非负整数。 |
| name | string | 是 | 否 | 标识版本号的文字描述,用于向用户展示。 |
| code | number | 是 | 否 | 标识应用的版本号,值为32位非负整数。此数字仅用于确定某个版本是否比另一个版本更新,数值越大表示版本越高。 |
\ No newline at end of file
......@@ -48,7 +48,6 @@
- [资源文件的分类](ui/ui-ts-basic-resource-file-categories.md)
- [资源访问](ui/ts-resource-access.md)
- [像素单位](ui/ts-pixel-units.md)
- [类型定义](ui/ts-types.md)
- 声明式语法
- [描述规范使用说明](ui/ts-syntax-intro.md)
- 通用UI描述规范
......@@ -526,7 +525,8 @@
- [时间选择弹窗](reference/arkui-ts/ts-methods-timepicker-dialog.md)
- [文本选择弹窗](reference/arkui-ts/ts-methods-textpicker-dialog.md)
- [菜单](reference/arkui-ts/ts-methods-menu.md)
- [文档中涉及到的内置枚举值](reference/arkui-ts/ts-appendix-enums.md)
- [枚举说明](reference/arkui-ts/ts-appendix-enums.md)
- [类型说明](reference/arkui-ts/ts-types.md)
- 组件参考(基于JS扩展的类Web开发范式)
- 组件通用信息
- [通用属性](reference/arkui-js/js-components-common-attributes.md)
......@@ -757,6 +757,7 @@
- [PermissionDef (PermissionDef)](reference/apis/js-apis-bundle-PermissionDef.md)
- [RemoteAbilityInfo (RemoteAbilityInfo)](reference/apis/js-apis-bundle-remoteAbilityInfo.md)
- [ShortcutInfo (ShortcutInfo)](reference/apis/js-apis-bundle-ShortcutInfo.md)
- [PackInfo (PackInfo)](reference/apis/js-apis-bundle-PackInfo.md)
- UI界面
- [@ohos.animator (动画)](reference/apis/js-apis-animator.md)
- [@ohos.mediaquery (媒体查询)](reference/apis/js-apis-mediaquery.md)
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册