diff --git a/zh-cn/application-dev/reference/apis/js-apis-Bundle.md b/zh-cn/application-dev/reference/apis/js-apis-Bundle.md index e1333719ff66a34cc1b2c627195fd90e77c62de5..f3e0efd2d2f19091302084fc7f3ab0745e679430 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-Bundle.md +++ b/zh-cn/application-dev/reference/apis/js-apis-Bundle.md @@ -1,5 +1,8 @@ # Bundle模块(JS端SDK接口) +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + ## 导入模块 ``` @@ -567,7 +570,7 @@ bundle.getAbilityInfo(bundleName, abilityName, (err, data) => { }) ``` -## bundle.getAbilityLabel +## bundle.getAbilityLabel8+ getAbilityLabel(bundleName: string, abilityName: string): Promise\ @@ -607,7 +610,7 @@ bundle.getAbilityLabel(bundleName, abilityName) }) ``` -## bundle.getAbilityLabel +## bundle.getAbilityLabel8+ getAbilityLabel(bundleName: string, abilityName: string, callback : AsyncCallback\): void @@ -643,7 +646,7 @@ bundle.getAbilityLabel(bundleName, abilityName, (err, data) => { }) ``` -## bundle.isAbilityEnabled +## bundle.isAbilityEnabled8+ isAbilityEnabled(info: AbilityInfo): Promise\ @@ -684,7 +687,7 @@ bundle.isAbilityEnabled(Info) }) ``` -## bundle.isAbilityEnabled +## bundle.isAbilityEnabled8+ isAbilityEnabled(info : AbilityInfo, callback : AsyncCallback\): void @@ -721,7 +724,7 @@ bundle.isAbilityEnabled(Info, (err, data) => { }) ``` -## bundle.isApplicationEnabled +## bundle.isApplicationEnabled8+ isApplicationEnabled(bundleName: string): Promise\ @@ -759,7 +762,7 @@ bundle.isApplicationEnabled(bundleName) }) ``` -## bundle.isApplicationEnabled +## bundle.isApplicationEnabled8+ isApplicationEnabled(bundleName: string, callback : AsyncCallback\): void @@ -1071,7 +1074,7 @@ bundle.getLaunchWantForBundle(bundleName, (err, data) => { ``` -## bundle.getNameForUid +## bundle.getNameForUid8+ getNameForUid(uid: number): Promise\ @@ -1104,7 +1107,7 @@ bundle.getNameForUid(uid) }) ``` -## bundle.getNameForUid +## bundle.getNameForUid8+ getNameForUid(uid: number, callback: AsyncCallback\): void; @@ -1135,12 +1138,20 @@ bundle.getNameForUid(uid, (err, data) => { ``` -## bundle.getAbilityIcon +## bundle.getAbilityIcon8+ -function getAbilityIcon(bundleName: string, abilityName: string): Promise\<[PixelMap](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-image.md)>; +getAbilityIcon(bundleName: string, abilityName: string): Promise\<[PixelMap](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-image.md)>; 以异步方法通过bundleName和abilityName获取对应Icon的[PixelMap](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-image.md)，使用Promise形式返回结果。 +**需要权限：** + +ohos.permission.GET_BUNDLE_INFO_PRIVILEGED, ohos.permission.GET_BUNDLE_INFO + +**系统能力：** + +SystemCapability.BundleManager.BundleFramework + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -1166,12 +1177,20 @@ bundle.getAbilityIcon(bundleName, abilityName) }) ``` -## bundle.getAbilityIcon +## bundle.getAbilityIcon8+ -function getAbilityIcon(bundleName: string, abilityName: string, callback: AsyncCallback\<[PixelMap](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-image.md)>): void; +getAbilityIcon(bundleName: string, abilityName: string, callback: AsyncCallback\<[PixelMap](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-image.md)>): void; 以异步方法通过bundleName和abilityName获取对应的[PixelMap](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-image.md)，使用callback形式返回结果。 +**需要权限：** + +ohos.permission.GET_BUNDLE_INFO_PRIVILEGED, ohos.permission.GET_BUNDLE_INFO + +**系统能力：** + +SystemCapability.BundleManager.BundleFramework + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -1195,9 +1214,9 @@ bundle.getAbilityIcon(bundleName, abilityName, (err, data) => { ``` -## bundle.queryExtensionAbilityInfosByWant +## bundle.queryExtensionAbilityInfosByWant9+ -function queryExtensionAbilityInfosByWant(want: Want, extensionFlags: number, userId?: number): Promise> +queryExtensionAbilityInfosByWant(want: Want, extensionFlags: number, userId?: number): Promise> 以异步方法根据给定的意图获取ExtensionAbility信息，使用Promise形式返回结果。 @@ -1242,12 +1261,16 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, userId) -## bundle.queryExtensionAbilityInfosByWant +## bundle.queryExtensionAbilityInfosByWant9+ -function queryExtensionAbilityInfosByWant(want: Want, extensionFlags: number, userId: number, callback: AsyncCallback>): void +queryExtensionAbilityInfosByWant(want: Want, extensionFlags: number, userId: number, callback: AsyncCallback>): void 以异步方法根据给定的意图获取ExtensionAbility信息，使用callback形式返回结果。 +**需要权限：** + +ohos.permission.GET_BUNDLE_INFO_PRIVILEGED, ohos.permission.GET_BUNDLE_INFO + **系统能力：** SystemCapability.BundleManager.BundleFramework @@ -1279,12 +1302,16 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, userId, (err, data }) ``` -## bundle.queryExtensionAbilityInfosByWant +## bundle.queryExtensionAbilityInfosByWant9+ -function queryExtensionAbilityInfosByWant(want: Want, extensionFlags: number, callback: AsyncCallback>): void; +queryExtensionAbilityInfosByWant(want: Want, extensionFlags: number, callback: AsyncCallback>): void; 以异步方法根据给定的意图获取ExtensionAbility信息，使用callback形式返回结果。 +**需要权限：** + +ohos.permission.GET_BUNDLE_INFO_PRIVILEGED, ohos.permission.GET_BUNDLE_INFO + **系统能力：** SystemCapability.BundleManager.BundleFramework @@ -1314,7 +1341,6 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => { }) ``` - ## ElementName **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework @@ -1333,7 +1359,7 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => { | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ------------- | -------- | ---------------- | ---- | ------------------------------------------------------------ | -| status | 只读 | InstallErrorCode | 是 | 安装结果code
SUCCESS = 0
STATUS_INSTALL_FAILURE = 1
STATUS_INSTALL_FAILURE_ABORTED = 2,
STATUS_INSTALL_FAILURE_INVALID = 3
STATUS_INSTALL_FAILURE_CONFLICT = 4
STATUS_INSTALL_FAILURE_STORAGE = 5
STATUS_INSTALL_FAILURE_INCOMPATIBLE = 6
STATUS_UNINSTALL_FAILURE = 7
STATUS_UNINSTALL_FAILURE_BLOCKED = 8
STATUS_UNINSTALL_FAILURE_ABORTED = 9
STATUS_UNINSTALL_FAILURE_CONFLICT = 10
STATUS_INSTALL_FAILURE_DOWNLOAD_TIMEOUT = 0x0B
STATUS_INSTALL_FAILURE_DOWNLOAD_FAILED = 0x0C
STATUS_RECOVER_FAILURE_INVALID = 0x0D
STATUS_ABILITY_NOT_FOUND = 0x40
STATUS_BMS_SERVICE_ERROR = 0x41
STATUS_FAILED_NO_SPACE_LEFT = 0x42
STATUS_GRANT_REQUEST_PERMISSIONS_FAILED = 0x43
STATUS_INSTALL_PERMISSION_DENIED = 0x44
STATUS_UNINSTALL_PERMISSION_DENIED = 0x45 | +| status | 只读 | InstallErrorCode | 是 | 安装结果code
SUCCESS = 0
STATUS_INSTALL_FAILURE = 1
STATUS_INSTALL_FAILURE_ABORTED = 2,
STATUS_INSTALL_FAILURE_INVALID = 3
STATUS_INSTALL_FAILURE_CONFLICT = 4
STATUS_INSTALL_FAILURE_STORAGE = 5
STATUS_INSTALL_FAILURE_INCOMPATIBLE = 6
STATUS_UNINSTALL_FAILURE = 7
STATUS_UNINSTALL_FAILURE_BLOCKED = 8
STATUS_UNINSTALL_FAILURE_ABORTED = 9
STATUS_UNINSTALL_FAILURE_CONFLICT = 10
STATUS_INSTALL_FAILURE_DOWNLOAD_TIMEOUT = 0x0B
STATUS_INSTALL_FAILURE_DOWNLOAD_FAILED = 0x0C
STATUS_RECOVER_FAILURE_INVALID8+ = 0x0D
STATUS_ABILITY_NOT_FOUND = 0x40
STATUS_BMS_SERVICE_ERROR = 0x41
STATUS_FAILED_NO_SPACE_LEFT8+ = 0x42
STATUS_GRANT_REQUEST_PERMISSIONS_FAILED8+ = 0x43
STATUS_INSTALL_PERMISSION_DENIED8+ = 0x44
STATUS_UNINSTALL_PERMISSION_DENIED8+ = 0x45 | ## BundleFlag @@ -1349,12 +1375,12 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => { | GET_ABILITY_INFO_WITH_APPLICATION | 0x00000004 | 获取包括应用的Ability信息 | | GET_APPLICATION_INFO_WITH_PERMISSION | 0x00000008 | 获取包括权限的应用信息 | | GET_BUNDLE_WITH_REQUESTED_PERMISSION | 0x00000010 | 获取包括所需权限的包信息 | -| GET_ABILITY_INFO_WITH_METADATA | 0x00000020 | 获取ability的元数据信息 | -| GET_BUNDLE_WITH_EXTENSION_ABILITY | 0x00000020 | 获取包括Ability信息的扩展包信息 | -| GET_APPLICATION_INFO_WITH_METADATA | 0x00000040 | 获取应用的元数据信息 | -| GET_ABILITY_INFO_SYSTEMAPP_ONLY | 0x00000080 | 获取仅包括系统应用的ability信息 | -| GET_ABILITY_INFO_WITH_DISABLE | 0x00000100 | 获取包括被禁用的ability信息 | -| GET_APPLICATION_INFO_WITH_DISABLE | 0x00000200 | 获取包括被禁用的应用信息 | +| GET_ABILITY_INFO_WITH_METADATA8+ | 0x00000020 | 获取ability的元数据信息 | +| GET_BUNDLE_WITH_EXTENSION_ABILITY9+ | 0x00000020 | 获取包括Ability信息的扩展包信息 | +| GET_APPLICATION_INFO_WITH_METADATA8+ | 0x00000040 | 获取应用的元数据信息 | +| GET_ABILITY_INFO_SYSTEMAPP_ONLY8+ | 0x00000080 | 获取仅包括系统应用的ability信息 | +| GET_ABILITY_INFO_WITH_DISABLE8+ | 0x00000100 | 获取包括被禁用的ability信息 | +| GET_APPLICATION_INFO_WITH_DISABLE8+ | 0x00000200 | 获取包括被禁用的应用信息 | | GET_ALL_APPLICATION_INFO | 0xFFFF0000 | 获取应用所有的信息 | ## BundleOptions @@ -1397,8 +1423,8 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => { | isSilentInstallation | string | 是 | 否 | 是否通过静默安装 | | minCompatibleVersionCode | number | 是 | 否 | 分布式场景下的应用包兼容的最低版本 | | entryInstallationFree | boolean | 是 | 否 | Entry是否支持免安装 | -| reqPermissionStates | Array\ | 是 | 否 | 申请权限的授予状态 | -| extensionAbilityInfo | Array\ | 是 | 否 | ability的可扩展信息 | +| reqPermissionStates8+ | Array\ | 是 | 否 | 申请权限的授予状态 | +| extensionAbilityInfo9+ | Array\ | 是 | 否 | ability的可扩展信息 | ## ApplicationInfo @@ -1424,13 +1450,13 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => { | moduleInfos | Array\ | 是 | 否 | 应用程序的模块信息 | | entryDir | string | 是 | 否 | 应用程序的文件保存路径 | | customizeData | Map> | 是 | 是 | 应用程序的自定义数据 | -| codePath | string | 是 | 否 | 应用程序的安装目录 | -| metaData | Map> | 是 | 否 | 应用程序的自定义元信息 | -| metaData | Map> | 是 | 否 | 应用程序的元信息 | -| removable | boolean | 是 | 否 | 应用程序是否可以被移除 | -| accessTokenId | number | 是 | 否 | 应用程序的accessTokenId | -| uid | number | 是 | 否 | 应用程序的uid | -| entityType | string | 是 | 否 | 应用程序的实体类型 | +| codePath8+ | string | 是 | 否 | 应用程序的安装目录 | +| metaData8+ | Map> | 是 | 否 | 应用程序的自定义元信息 | +| metaData9+ | Map> | 是 | 否 | 应用程序的元信息 | +| removable8+ | boolean | 是 | 否 | 应用程序是否可以被移除 | +| accessTokenId8+ | number | 是 | 否 | 应用程序的accessTokenId | +| uid8+ | number | 是 | 否 | 应用程序的uid | +| entityType9+ | string | 是 | 否 | 应用程序的实体类型 | ## ModuleInfo @@ -1453,7 +1479,7 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => { | ----- | ------ | ---- | ---- | ---------------- | | name | string | 是 | 是 | 自定义元数据名称 | | value | string | 是 | 是 | 自定义元数据值 | -| extra | string | 是 | 是 | 自定义资源 | +| extra8+ | string | 是 | 是 | 自定义资源 | ## HapModuleInfo @@ -1479,9 +1505,9 @@ Hap模块信息 | moduleName | string | 是 | 否 | 模块名 | | mainAbilityName | string | 是 | 否 | 入口Ability名称 | | installationFree | boolean | 是 | 否 | 是否支持免安装 | -| mainElementName | string | 是 | 否 | 入口ability信息 | -| extensionAbilityInfo | Array\ | 是 | 否 | extensionAbility信息 | -| metadata | Array\ | 是 | 否 | Ability的元信息 | +| mainElementName8+ | string | 是 | 否 | 入口ability信息 | +| extensionAbilityInfo9+ | Array\ | 是 | 否 | extensionAbility信息 | +| metadata9+ | Array\ | 是 | 否 | Ability的元信息 | ## ReqPermissionDetail @@ -1540,9 +1566,9 @@ Ability信息 | uri | string | 是 | 否 | 获取Ability的统一资源标识符（URI） | | labelId | number | 是 | 否 | Ability的标签id | | subType | AbilitySubType | 是 | 否 | Ability中枚举使用的模板的子类型 | -| metaData | Array\ | 是 | 否 | ability的自定义信息 | -| metaData | Array\ | 是 | 否 | ability的元信息 | -| enabled | boolean | 是 | 否 | ability是否可用 | +| metaData8+ | Array\ | 是 | 否 | ability的自定义信息 | +| metaData9+ | Array\ | 是 | 否 | ability的元信息 | +| enabled8+ | boolean | 是 | 否 | ability是否可用 | ## AbilityType @@ -1593,7 +1619,7 @@ Ability的子类型 | CA | 1 | Ability子类型是带有 UI 的服务 | -## ExtensionAbilityType +## ExtensionAbilityType9+ ExtensionAbility的类型 @@ -1601,18 +1627,18 @@ ExtensionAbility的类型 | 名称 | 类型 | 说明 | | -------------------- | ---- | ----------------------------- | -| FORM | 0 | ExtensionAbility的类型包括卡片 | -| WORK_SCHEDULER | 1 | ExtensionAbility的类型包括行程安排 | -| INPUT_METHOD | 2 | ExtensionAbility的类型包括输入法 | -| SERVICE | 3 | ExtensionAbility的类型包括服务 | -| ACCESSIBILITY | 4 | ExtensionAbility的类型包括无障碍 | -| DATA_SHARE | 5 | ExtensionAbility的类型包括数据共享 | -| FILE_SHARE | 6 | ExtensionAbility的类型包括文件共享 | -| STATIC_SUBSCRIBER | 7 | ExtensionAbility的类型包括订阅者 | -| WALLPAPER | 8 | ExtensionAbility的类型包括墙纸 | -| UNSPECIFIED | 9 | ExtensionAbility未指定类型 | - -## ExtensionFlag +| FORM9+ | 0 | ExtensionAbility的类型包括卡片 | +| WORK_SCHEDULER9+ | 1 | ExtensionAbility的类型包括行程安排 | +| INPUT_METHOD9+ | 2 | ExtensionAbility的类型包括输入法 | +| SERVICE9+ | 3 | ExtensionAbility的类型包括服务 | +| ACCESSIBILITY9+ | 4 | ExtensionAbility的类型包括无障碍 | +| DATA_SHARE9+ | 5 | ExtensionAbility的类型包括数据共享 | +| FILE_SHARE9+ | 6 | ExtensionAbility的类型包括文件共享 | +| STATIC_SUBSCRIBER9+ | 7 | ExtensionAbility的类型包括订阅者 | +| WALLPAPER9+ | 8 | ExtensionAbility的类型包括墙纸 | +| UNSPECIFIED9+ | 9 | ExtensionAbility未指定类型 | + +## ExtensionFlag9+ 扩展标志 @@ -1620,13 +1646,13 @@ ExtensionAbility的类型 | 名称 | 默认值 | 说明 | | ------ | ------ | ------ | -| GET_EXTENSION_INFO_DEFAULT | 0x00000000 | 获取默认的extensionAbilityInfo | -| GET_EXTENSION_INFO_WITH_PERMISSION | 0x00000002 | 获取携带权限信息的extensionAbilityInfo | -| GET_EXTENSION_INFO_WITH_APPLICATION | 0x00000004 | 获取携带应用信息的extensionAbilityInfo | -| GET_EXTENSION_INFO_WITH_METADATA | 0x00000020 | 获取携带元数据信息的extensionAbilityInfo | +| GET_EXTENSION_INFO_DEFAULT9+ | 0x00000000 | 获取默认的extensionAbilityInfo | +| GET_EXTENSION_INFO_WITH_PERMISSION9+ | 0x00000002 | 获取携带权限信息的extensionAbilityInfo | +| GET_EXTENSION_INFO_WITH_APPLICATION9+ | 0x00000004 | 获取携带应用信息的extensionAbilityInfo | +| GET_EXTENSION_INFO_WITH_METADATA9+ | 0x00000020 | 获取携带元数据信息的extensionAbilityInfo | -## ExtensionAbilityInfo +## ExtensionAbilityInfo9+ ExtensionAbility信息 @@ -1634,23 +1660,23 @@ ExtensionAbility信息 | 名称 | 类型 | 可读 | 可写 | 说明 | | ------ | ------ | ------ | ------ | ------ | -| bundleName | string | 是 | 否 | 应用包名 | -| moduleName | string | 是 | 否 | ExtensionAbility所属的HAP包的名称 | -| name | string | 是 | 否 | ExtensionAbility名称 | -| labelId | number | 是 | 否 | ExtensionAbility的标签id | -| descriptionId | number | 是 | 否 | ExtensionAbility的描述id | -| iconId | number | 是 | 否 | ExtensionAbility的图标id | -| isVisible | boolean | 是 | 否 | 判断ExtensionAbility是否可以被其他应用调用 | -| extensionAbilityType | bundle.ExtensionAbilityType | 是 | 否 | ExtensionAbility类型 | -| permissions | Array\ | 是 | 否 | 被其他应用ExtensionAbility调用时需要申请的权限集合 | -| applicationInfo | ApplicationInfo | 是 | 否 | 应用程序的配置信息 | -| metaData | Array\ | 是 | 否 | ExtensionAbility的元信息 | -| enabled | boolean | 是 | 否 | ExtensionAbility是否可用 | -| readPermission | string | 是 | 否 | 读取ExtensionAbility数据所需的权限 | -| writePermission | string | 是 | 否 | 向ExtensionAbility写数据所需的权限 | - - -## Metadata +| bundleName9+ | string | 是 | 否 | 应用包名 | +| moduleName9+ | string | 是 | 否 | ExtensionAbility所属的HAP包的名称 | +| name9+ | string | 是 | 否 | ExtensionAbility名称 | +| labelId9+ | number | 是 | 否 | ExtensionAbility的标签id | +| descriptionId9+ | number | 是 | 否 | ExtensionAbility的描述id | +| iconId9+ | number | 是 | 否 | ExtensionAbility的图标id | +| isVisible9+ | boolean | 是 | 否 | 判断ExtensionAbility是否可以被其他应用调用 | +| extensionAbilityType9+ | bundle.ExtensionAbilityType | 是 | 否 | ExtensionAbility类型 | +| permissions9+ | Array\ | 是 | 否 | 被其他应用ExtensionAbility调用时需要申请的权限集合 | +| applicationInfo9+ | ApplicationInfo | 是 | 否 | 应用程序的配置信息 | +| metaData9+ | Array\ | 是 | 否 | ExtensionAbility的元信息 | +| enabled9+ | boolean | 是 | 否 | ExtensionAbility是否可用 | +| readPermission9+ | string | 是 | 否 | 读取ExtensionAbility数据所需的权限 | +| writePermission9+ | string | 是 | 否 | 向ExtensionAbility写数据所需的权限 | + + +## Metadata9+ 元数据信息 @@ -1658,6 +1684,6 @@ ExtensionAbility信息 | 名称 | 类型 | 可读 | 可写 | 说明 | | ----- | ------ | ---- | ---- | ---------------- | -| name | string | 是 | 是 | 元数据名称 | -| value | string | 是 | 是 | 元数据值 | -| resource | string | 是 | 是 | 元数据资源 | \ No newline at end of file +| name9+ | string | 是 | 是 | 元数据名称 | +| value9+ | string | 是 | 是 | 元数据值 | +| resource9+ | string | 是 | 是 | 元数据资源 | \ No newline at end of file