diff --git a/zh-cn/application-dev/reference/apis/js-apis-Bundle-BundleStatusCallback.md b/zh-cn/application-dev/reference/apis/js-apis-Bundle-BundleStatusCallback.md index 85ec2c54a6baab341b8678cee43787a178bfafaa..3dd1b1b4f8efd79a1fb5808c2fb828bf2f8f8a57 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-Bundle-BundleStatusCallback.md +++ b/zh-cn/application-dev/reference/apis/js-apis-Bundle-BundleStatusCallback.md @@ -1,7 +1,7 @@ -# bundleStatusCallback - -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API version 9开始不再支持。建议使用[bundleMonitor](js-apis-bundleMonitor.md)替代。 +# BundleStatusCallback +> ![icon-note.gif](public_sys-resources/icon-note.gif) +> **说明:** +> 本模块首批接口从API version 8 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 应用状态回调的信息,通过接口[innerBundleManager.on](js-apis-Bundle-InnerBundleManager.md)获取。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-Bundle-InnerBundleManager.md b/zh-cn/application-dev/reference/apis/js-apis-Bundle-InnerBundleManager.md index 69a1083779c9f4cef700bf5e78bbf33e198b60f4..5eb66da20089228c061b53a5cd75e15443b885d4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-Bundle-InnerBundleManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-Bundle-InnerBundleManager.md @@ -22,7 +22,7 @@ SystemCapability.BundleManager.BundleFramework getLauncherAbilityInfos(bundleName: string, userId: number, callback: AsyncCallback<Array<LauncherAbilityInfo>>) : void; 以异步方法根据给定的包名获取LauncherAbilityInfos,使用callback形式返回结果。 -> 从API version 9开始不再支持。建议使用[launcherBundleManager#getLauncherAbilityInfo](js-apis-launcherBundleManager.md)替代。 +> 从API version 9开始不再支持。建议使用[launcherBundleManager.getLauncherAbilityInfo](js-apis-launcherBundleManager.md#launcherbundlemanagergetlauncherabilityinfo9)替代。 **需要权限:** @@ -50,7 +50,7 @@ SystemCapability.BundleManager.BundleFramework getLauncherAbilityInfos(bundleName: string, userId: number) : Promise<Array<LauncherAbilityInfo>> 以异步方法根据给定的包名获取LauncherAbilityInfos,使用Promise形式返回结果。 -> 从API version 9开始不再支持。建议使用[launcherBundleManager#getLauncherAbilityInfo](js-apis-launcherBundleManager.md)替代。 +> 从API version 9开始不再支持。建议使用[launcherBundleManager.getLauncherAbilityInfo](js-apis-launcherBundleManager.md#launcherbundlemanagergetlauncherabilityinfo9)替代。 **需要权限:** @@ -82,7 +82,7 @@ SystemCapability.BundleManager.BundleFramework on(type:"BundleStatusChange", bundleStatusCallback : BundleStatusCallback, callback: AsyncCallback<string>) : void; 注册Callback。 -> 从API version 9开始不再支持。建议使用[bundleMonitor#on](js-apis-bundleMonitor.md)替代。 +> 从API version 9开始不再支持。建议使用[bundleMonitor.on](js-apis-bundleMonitor.md#bundlemonitoron)替代。 **需要权限:** @@ -109,7 +109,7 @@ SystemCapability.BundleManager.BundleFramework on(type:"BundleStatusChange", bundleStatusCallback : BundleStatusCallback) : Promise<string> 注册Callback。 -> 从API version 9开始不再支持。建议使用[bundleMonitor#on](js-apis-bundleMonitor.md)替代。 +> 从API version 9开始不再支持。建议使用[bundleMonitor.on](js-apis-bundleMonitor.md#bundlemonitoron)替代。 **需要权限:** @@ -141,7 +141,7 @@ SystemCapability.BundleManager.BundleFramework off(type:"BundleStatusChange", callback: AsyncCallback<string>) : void; 取消注册Callback。 -> 从API version 9开始不再支持。建议使用[bundleMonitor#off](js-apis-bundleMonitor.md)替代。 +> 从API version 9开始不再支持。建议使用[bundleMonitor.off](js-apis-bundleMonitor.md#bundlemonitoroff)替代。 **需要权限:** @@ -167,7 +167,7 @@ SystemCapability.BundleManager.BundleFramework off(type:"BundleStatusChange") : Promise<string> 取消注册Callback。 -> 从API version 9开始不再支持。建议使用[bundleMonitor#off](js-apis-bundleMonitor.md)替代。 +> 从API version 9开始不再支持。建议使用[bundleMonitor.off](js-apis-bundleMonitor.md#bundlemonitoroff)替代。 **需要权限:** @@ -198,7 +198,7 @@ SystemCapability.BundleManager.BundleFramework getAllLauncherAbilityInfos(userId: number, callback: AsyncCallback<Array<LauncherAbilityInfo>>) : void; 以异步方法获取所有的LauncherAbilityInfos,使用callback形式返回结果。 -> 从API version 9开始不再支持。建议使用[launcherBundleManager#getAllLauncherAbilityInfo](js-apis-launcherBundleManager.md)替代。 +> 从API version 9开始不再支持。建议使用[launcherBundleManager.getAllLauncherAbilityInfo](js-apis-launcherBundleManager.md#launcherbundlemanagergetalllauncherabilityinfo9)替代。 **需要权限:** @@ -224,7 +224,7 @@ SystemCapability.BundleManager.BundleFramework getAllLauncherAbilityInfos(userId: number) : Promise<Array<LauncherAbilityInfo>> 以异步方法获取LauncherAbilityInfos,使用Promise形式返回结果。 -> 从API version 9开始不再支持。建议使用[launcherBundleManager#getAllLauncherAbilityInfo](js-apis-launcherBundleManager.md)替代。 +> 从API version 9开始不再支持。建议使用[launcherBundleManager.getAllLauncherAbilityInfo](js-apis-launcherBundleManager.md#launcherbundlemanagergetalllauncherabilityinfo9)替代。 **需要权限:** @@ -255,7 +255,7 @@ SystemCapability.BundleManager.BundleFramework getShortcutInfos(bundleName :string, callback: AsyncCallback<Array<ShortcutInfo>>) : void; 以异步方法根据给定的包名获取快捷方式信息,使用callback形式返回结果。 -> 从API version 9开始不再支持。建议使用[launcherBundleManager#getShortcutInfo](js-apis-launcherBundleManager.md)替代。 +> 从API version 9开始不再支持。建议使用[launcherBundleManager.getShortcutInfo](js-apis-launcherBundleManager.md#launcherbundlemanagergetshortcutinfo9)替代。 **需要权限:** @@ -281,7 +281,7 @@ SystemCapability.BundleManager.BundleFramework getShortcutInfos(bundleName : string) : Promise<Array<ShortcutInfo>> 以异步方法根据给定的包名获取快捷方式信息,使用Promise形式返回结果。 -> 从API version 9开始不再支持。建议使用[launcherBundleManager#getShortcutInfo](js-apis-launcherBundleManager.md)替代。 +> 从API version 9开始不再支持。建议使用[launcherBundleManager.getShortcutInfo](js-apis-launcherBundleManager.md#launcherbundlemanagergetshortcutinfo9)替代。 **需要权限:** 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 194ef81047203ba2ba9bf8975d46ba3e1db4c5bc..6179c5c2ef17caeec9618fbc6e49d7efbb79e8f1 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-Bundle.md +++ b/zh-cn/application-dev/reference/apis/js-apis-Bundle.md @@ -1,6 +1,5 @@ # @ohos.bundle (Bundle模块) - 本模块提供应用信息查询能力,支持[包信息](js-apis-bundle-BundleInfo.md)、[应用信息](js-apis-bundle-ApplicationInfo.md)、[Ability组件信息](js-apis-bundle-AbilityInfo.md)等信息的查询,以及应用禁用状态的查询、设置等。 > **说明:** @@ -92,7 +91,7 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | bundleName | string | 是 | 要查询的应用程序包名称。 | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中应用信息相关flag。 | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflagdeprecated)中应用信息相关flag。 | | userId | number | 是 | 用户ID。取值范围:大于等于0。 | | callback | AsyncCallback\<[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)> | 是 | 程序启动作为入参的回调函数,返回应用程序信息。 | @@ -135,7 +134,7 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | bundleName | string | 是 | 要查询的应用程序包名称。 | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中应用信息相关flag。 | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflagdeprecated)中应用信息相关flag。 | | callback | AsyncCallback\<[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)> | 是 | 程序启动作为入参的回调函数,返回应用程序信息。 | **示例:** @@ -173,7 +172,7 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ---------- | ---------- | ---- | ------------------------------------------------------------ | -| bundleFlag | BundleFlag | 是 | 用于指定返回的包信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag。 | +| bundleFlag | BundleFlag | 是 | 用于指定返回的包信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflagdeprecated)中包信息相关flag。 | | userId | number | 否 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | **返回值:** @@ -216,7 +215,7 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| bundleFlag | BundleFlag | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag。 | +| bundleFlag | BundleFlag | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflagdeprecated)中包信息相关flag。 | | callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数,返回所有可用的BundleInfo。 | **示例:** @@ -253,7 +252,7 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | |------------|-------------------------------------------------------------------|-----|---------------------------------------------------------------------| -| bundleFlag | BundleFlag | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag。 | +| bundleFlag | BundleFlag | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflagdeprecated)中包信息相关flag。 | | userId | number | 是 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | | callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数,返回指定用户下所有包的BundleInfo。 | | @@ -296,8 +295,8 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ----------- | ------------- | ---- |---------------------------------------------------------------------| | bundleName | string | 是 | 要查询的应用程序包名称。 | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag。 | -| options | [BundleOptions](#bundleoptions) | 否 | 包含userid的查询选项。 | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflagdeprecated)中包信息相关flag。 | +| options | [BundleOptions](#bundleoptionsdeprecated) | 否 | 包含userid的查询选项。 | **返回值:** @@ -344,7 +343,7 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ----------- | ---------------------------------------------------------- | ---- |---------------------------------------------------------------------| | bundleName | string | 是 | 需要查询的应用程序包名称。 | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag。 | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflagdeprecated)中包信息相关flag。 | | callback | AsyncCallback\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 是 | 程序启动作为入参的回调函数,返回包信息。 | **示例:** @@ -385,8 +384,8 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ----------- | ---------------------------------------------------------- | ---- | ------------------------------------------------------------ | | bundleName | string | 是 | 要查询的应用包名。 | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag。 | -| options | [BundleOptions](#bundleoptions) | 是 | 包含userid。 | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflagdeprecated)中包信息相关flag。 | +| options | [BundleOptions](#bundleoptionsdeprecated) | 是 | 包含userid。 | | callback | AsyncCallback\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 是 | 程序启动作为入参的回调函数,返回包信息。 | **示例:** @@ -761,7 +760,7 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------ | | permissionName | string | 是 | 需要查询的权限的名称。 | -| callback | AsyncCallback<[PermissionDef](js-apis-bundle-PermissionDef)> | 是 | 程序启动作为入参的回调函数,返回定义的权限信息。 | +| callback | AsyncCallback<[PermissionDef](js-apis-bundle-PermissionDef.md)> | 是 | 程序启动作为入参的回调函数,返回定义的权限信息。 | **示例:** @@ -806,7 +805,7 @@ SystemCapability.BundleManager.BundleFramework | 类型 | 说明 | | ------------------------------------------------------ | ------------------------------------------------------ | -| Promise<[PermissionDef](js-apis-bundle-PermissionDef)> | Promise对象,获取成功时返回权限详细信息。 | +| Promise<[PermissionDef](js-apis-bundle-PermissionDef.md)> | Promise对象,获取成功时返回权限详细信息。 | **示例:** @@ -839,7 +838,7 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ----------- | ------ | ---- | ------------------------------------------------------------ | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中应用信息相关flag。 | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflagdeprecated)中应用信息相关flag。 | | userId | number | 否 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | **返回值:** @@ -881,7 +880,7 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中应用信息相关flag。 | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflagdeprecated)中应用信息相关flag。 | | userId | number | 是 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | | callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数,返回应用信息列表。 | @@ -920,7 +919,7 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中应用信息相关flag。 | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflagdeprecated)中应用信息相关flag。 | | callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数,返回应用信息列表。 | **示例:** @@ -953,7 +952,7 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------ | ---- | ------------ | | hapFilePath | string | 是 | HAP存放路径。支持当前应用程序的绝对路径和数据目录沙箱路径。 | -| bundleFlags | number | 是 | 用于指定要返回的BundleInfo对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag。 | +| bundleFlags | number | 是 | 用于指定要返回的BundleInfo对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflagdeprecated)中包信息相关flag。 | **返回值:** | 类型 | 说明 | @@ -990,7 +989,7 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------ | ---- | ------------ | | hapFilePath | string | 是 | HAP存放路径,支持当前应用程序的绝对路径和数据目录沙箱路径。 | -| bundleFlags | number | 是 | 用于指定要返回的BundleInfo对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag。 | +| bundleFlags | number | 是 | 用于指定要返回的BundleInfo对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflagdeprecated)中包信息相关flag。 | | callback| AsyncCallback\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 是 | 程序启动作为入参的回调函数,返回HAP包中包含的应用程序包的信息。| **示例:** @@ -1340,7 +1339,7 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ----------- | ------ | ---- | ------------------------------------- | | want | [Want](js-apis-application-want.md) | 是 | 包含要查询的应用程序包名称的意图。 | -| bundleFlags | number | 是 | 用于指定返回abilityInfo信息。取值范围:参考[BundleFlag说明](#bundleflag)中Ability信息相关flag。 | +| bundleFlags | number | 是 | 用于指定返回abilityInfo信息。取值范围:参考[BundleFlag说明](#bundleflagdeprecated)中Ability信息相关flag。 | | userId | number | 否 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | **返回值:** @@ -1391,7 +1390,7 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | |-------------|---------------------------------------------------------------------|-----|-------------------------------------------------------------------------| | want | [Want](js-apis-application-want.md) | 是 | 指示包含要查询的应用程序包名称的意图。 | -| bundleFlags | number | 是 | 用于指定返回abilityInfo信息。取值范围:参考[BundleFlag说明](#bundleflag)中Ability信息相关flag。 | +| bundleFlags | number | 是 | 用于指定返回abilityInfo信息。取值范围:参考[BundleFlag说明](#bundleflagdeprecated)中Ability信息相关flag。 | | userId | number | 是 | 用户ID。取值范围:大于等于0。 | | callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数,返回Ability信息。 | @@ -1436,7 +1435,7 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | |-------------|---------------------------------------------------------------------|-----|-------------------------------------------------------------------------| | want | [Want](js-apis-application-want.md) | 是 | 指示包含要查询的应用程序包名称的意图。 | -| bundleFlags | number | 是 | 用于指定返回abilityInfo信息。取值范围:参考[BundleFlag说明](#bundleflag)中Ability信息相关flag。 | +| bundleFlags | number | 是 | 用于指定返回abilityInfo信息。取值范围:参考[BundleFlag说明](#bundleflagdeprecated)中Ability信息相关flag。 | | callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数,返回Ability信息。 | **示例:** diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundle-AbilityInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundle-AbilityInfo.md index 9765d8792dbe200ebe2cb45c50f078478c9be888..d25eee6d2c6daa1250a9f2e50128efd300bab161 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundle-AbilityInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundle-AbilityInfo.md @@ -3,9 +3,7 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > 本模块首批接口从API version 7 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 - - -Ability信息,未做特殊说明的属性,均通过[GET_BUNDLE_DEFAULT](js-apis-Bundle.md)获取。 +Ability信息,未做特殊说明的属性,均通过[bundle.getAbilityInfo](js-apis-Bundle.md#bundlegetabilityinfodeprecated)获取。 ## AbilityInfo(deprecated) @@ -31,14 +29,14 @@ Ability信息,未做特殊说明的属性,均通过[GET_BUNDLE_DEFAULT](js-a | type | AbilityType | 是 | 否 | Ability类型。
此属性仅可在FA模型下使用。 | | orientation | [DisplayOrientation](js-apis-Bundle.md#displayorientationdeprecated) | 是 | 否 | Ability的显示模式。 | | launchMode | [LaunchMode](js-apis-Bundle.md#launchmodedeprecated) | 是 | 否 | Ability的启动模式。 | -| permissions | Array\ | 是 | 否 | 被其他应用Ability调用时需要申请的权限集合。
通过传入GET_ABILITY_INFO_WITH_PERMISSION获取。 | +| permissions | Array\ | 是 | 否 | 被其他应用Ability调用时需要申请的权限集合。
通过调用[bundle.getAbilityInfo](js-apis-Bundle.md#bundlegetabilityinfodeprecated)接口时,传入GET_ABILITY_INFO_WITH_PERMISSION获取。 | | deviceTypes | Array\ | 是 | 否 | Ability支持的设备类型。 | | deviceCapabilities | Array\ | 是 | 否 | Ability需要的设备能力。 | | readPermission | string | 是 | 否 | 读取Ability数据所需的权限。
此属性仅可在FA模型下使用。| | writePermission | string | 是 | 否 | 向Ability写数据所需的权限。
此属性仅可在FA模型下使用。 | -| applicationInfo | [ApplicationInfo](js-apis-bundle-ApplicationInfo.md) | 是 | 否 | 应用程序的配置信息。
通过传入[GET_ABILITY_INFO_WITH_APPLICATION](js-apis-Bundle.md)获取。 | +| applicationInfo | [ApplicationInfo](js-apis-bundle-ApplicationInfo.md) | 是 | 否 | 应用程序的配置信息。
通过调用[bundle.getAbilityInfo](js-apis-Bundle.md#bundlegetabilityinfodeprecated)接口时,传入GET_ABILITY_INFO_WITH_APPLICATION获取。 | | uri | string | 是 | 否 | 获取Ability的统一资源标识符(URI)。
此属性仅可在FA模型下使用。 | | labelId | number | 是 | 否 | Ability的标签id。 | | subType | AbilitySubType | 是 | 否 | Ability中枚举使用的模板的子类型。
此属性仅可在FA模型下使用。 | -| metadata8+ | Array\<[CustomizeData](js-apis-bundle-CustomizeData.md)> | 是 | 否 | ability的元信息。
通过传入GET_ABILITY_INFO_WITH_METADATA获取。 | +| metadata8+ | Array\<[CustomizeData](js-apis-bundle-CustomizeData.md)> | 是 | 否 | ability的元信息。
通过调用[bundle.getAbilityInfo](js-apis-Bundle.md#bundlegetabilityinfodeprecated)接口时,传入GET_ABILITY_INFO_WITH_METADATA获取。 | | enabled8+ | boolean | 是 | 否 | ability是否可用。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundle-ApplicationInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundle-ApplicationInfo.md index da062d8939dc979288e0c1dd20bdf30cc55804bf..1fd6e8e96ac8ece72070ea885d415e2aef6e6aea 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundle-ApplicationInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundle-ApplicationInfo.md @@ -1,9 +1,9 @@ -# applicationInfo +# ApplicationInfo > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > 本模块首批接口从API version 7 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 -应用程序信息,未做特殊说明的属性,均通过[GET_BUNDLE_DEFAULT](js-apis-Bundle.md)获取。 +应用程序信息,未做特殊说明的属性,均通过[bundle.getApplicationInfo](js-apis-Bundle.md#bundlegetapplicationinfodeprecated)获取。 ## ApplicationInfo(deprecated) @@ -11,8 +11,6 @@ **系统能力**: 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework - - | 名称 | 类型 | 可读 | 可写 | 说明 | |----------------------------|------------------------------------------------------------------------|-----|-----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| | name | string | 是 | 否 | 应用程序的名称。 | @@ -27,11 +25,11 @@ | process | string | 是 | 否 | 应用程序的进程,如果不设置,默认为包的名称。 | | supportedModes | number | 是 | 否 | 标识应用支持的运行模式,当前只定义了驾驶模式(drive)。该标签只适用于车机。 | | moduleSourceDirs | Array\ | 是 | 否 | 应用程序的资源存放的相对路径。 | -| permissions | Array\ | 是 | 否 | 访问应用程序所需的权限。
通过传入[GET_APPLICATION_INFO_WITH_PERMISSION](js-apis-Bundle.md)获取。 | +| permissions | Array\ | 是 | 否 | 访问应用程序所需的权限。
通过调用[bundle.getApplicationInfo](js-apis-Bundle.md#bundlegetapplicationinfodeprecated)接口时,传入GET_APPLICATION_INFO_WITH_PERMISSION获取。 | | moduleInfos | Array\<[ModuleInfo](js-apis-bundle-ModuleInfo.md)> | 是 | 否 | 应用程序的模块信息。 | | entryDir | string | 是 | 否 | 应用程序的文件保存路径。 | | codePath8+ | string | 是 | 否 | 应用程序的安装目录。 | -| metaData8+ | Map\> | 是 | 否 | 应用程序的自定义元信息。
通过传入[GET_APPLICATION_INFO_WITH_METADATA](js-apis-Bundle.md)获取。 | +| metaData8+ | Map\> | 是 | 否 | 应用程序的自定义元信息。
通过调用[bundle.getApplicationInfo](js-apis-Bundle.md#bundlegetapplicationinfodeprecated)接口时,传入GET_APPLICATION_INFO_WITH_METADATA获取。 | | removable8+ | boolean | 是 | 否 | 应用程序是否可以被移除。 | | accessTokenId8+ | number | 是 | 否 | 应用程序的accessTokenId。 | | uid8+ | number | 是 | 否 | 应用程序的uid。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundle-BundleInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundle-BundleInfo.md index e9fc5fad74a9b885d062fb37c2ab1ff8e3b8a90b..37c6b0099b392f4229ad470672988ef5b1406f49 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundle-BundleInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundle-BundleInfo.md @@ -1,9 +1,9 @@ -# bundleInfo +# BundleInfo > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > 本模块首批接口从API version 7 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 -应用包的信息,未做特殊说明的属性,均通过[GET_BUNDLE_DEFAULT](js-apis-Bundle.md)获取。 +应用包的信息,通过[bundle.getBundleInfo](js-apis-Bundle.md#bundlegetbundleinfodeprecated)获取。 ## BundleInfo(deprecated) @@ -20,9 +20,9 @@ | installTime | number | 是 | 否 | HAP包安装时间。 | | updateTime | number | 是 | 否 | HAP包更新时间。 | | appInfo | [ApplicationInfo](js-apis-bundle-ApplicationInfo.md) | 是 | 否 | 应用程序的配置信息。 | -| abilityInfos | Array\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 是 | 否 | Ability的配置信息
通过传入GET_BUNDLE_WITH_ABILITIES获取。 | -| reqPermissions | Array\ | 是 | 否 | 应用运行时需向系统申请的权限集合
通过传入GET_BUNDLE_WITH_REQUESTED_PERMISSION获取。 | -| reqPermissionDetails | Array\<[ReqPermissionDetail](#reqpermissiondetaildeprecated)> | 是 | 否 | 应用运行时需向系统申请的权限集合的详细信息
通过传入GET_BUNDLE_WITH_REQUESTED_PERMISSION获取。 | +| abilityInfos | Array\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 是 | 否 | Ability的配置信息
通过调用[bundle.getBundleInfo](js-apis-Bundle.md#bundlegetbundleinfodeprecated)接口时,传入GET_BUNDLE_WITH_ABILITIES获取。 | +| reqPermissions | Array\ | 是 | 否 | 应用运行时需向系统申请的权限集合
通过调用[bundle.getBundleInfo](js-apis-Bundle.md#bundlegetbundleinfodeprecated)接口时,传入GET_BUNDLE_WITH_REQUESTED_PERMISSION获取。 | +| reqPermissionDetails | Array\<[ReqPermissionDetail](#reqpermissiondetaildeprecated)> | 是 | 否 | 应用运行时需向系统申请的权限集合的详细信息
通过调用[bundle.getBundleInfo](js-apis-Bundle.md#bundlegetbundleinfodeprecated)接口时,传入GET_BUNDLE_WITH_REQUESTED_PERMISSION获取。 | | vendor | string | 是 | 否 | 应用包的供应商。 | | versionCode | number | 是 | 否 | 应用包的版本号。 | | versionName | string | 是 | 否 | 应用包的版本文本描述信息。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundle-BundleInstaller.md b/zh-cn/application-dev/reference/apis/js-apis-bundle-BundleInstaller.md index e318444a8546eba71974be22e3feb6ee096c04a4..c0d953dfd155000f859be1ad24b5d2fc1ecf1a5b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundle-BundleInstaller.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundle-BundleInstaller.md @@ -1,13 +1,13 @@ -# bundleInstaller +# BundleInstaller -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 本模块首批接口从API version 7 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 本模块提供设备上安装、升级和卸载应用的能力。 ## BundleInstaller.install(deprecated) -> 从API version 9开始不再维护,建议使用[install](js-apis-installer.md)替代。 +> 从API version 9开始不再维护,建议使用[@ohos.bundle.installer.install](js-apis-installer.md)替代。 install(bundleFilePaths: Array<string>, param: InstallParam, callback: AsyncCallback<InstallStatus>): void; @@ -25,10 +25,10 @@ SystemCapability.BundleManager.BundleFramework **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| --------------- | ---------------------------------------------------- | ---- | ------------------------------------------------------------ | -| bundleFilePaths | Array<string> | 是 | 指示存储hap包的沙箱路径。沙箱路径的获取方法参见[获取应用的沙箱路径](#获取应用的沙箱路径)。| -| param | [InstallParam](#installparamdeprecated) | 是 | 指定安装所需的其他参数。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| bundleFilePaths | Array<string> | 是 | 指示存储HAP的沙箱路径。沙箱路径的获取方法参见[获取应用的沙箱路径](#获取应用的沙箱路径)。 | +| param | [InstallParam](#installparamdeprecated) | 是 | 指定安装所需的其他参数。 | | callback | AsyncCallback<[InstallStatus](#installstatusdeprecated)> | 是 | 程序启动作为入参的回调函数,返回安装状态信息。 | **示例:** @@ -42,7 +42,7 @@ let installParam = { installFlag: 1, }; -bundle.getBundleInstaller().then(installer=>{ +bundle.getBundleInstaller().then(installer => { installer.install(hapFilePaths, installParam, err => { if (err) { console.error('install failed:' + JSON.stringify(err)); @@ -75,10 +75,10 @@ SystemCapability.BundleManager.BundleFramework **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ---------------------------------------------------- | ---- | ---------------------------------------------- | -| bundleName | string | 是 | 应用包名。 | -| param | [InstallParam](#installparamdeprecated) | 是 | 指定卸载所需的其他参数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------------------------------------------------------------ | ---- | ---------------------------------------------- | +| bundleName | string | 是 | 应用Bundle名称。 | +| param | [InstallParam](#installparamdeprecated) | 是 | 指定卸载所需的其他参数。 | | callback | AsyncCallback<[InstallStatus](#installstatusdeprecated)> | 是 | 程序启动作为入参的回调函数,返回安装状态信息。 | **示例:** @@ -92,7 +92,7 @@ let installParam = { installFlag: 1, }; -bundle.getBundleInstaller().then(installer=>{ +bundle.getBundleInstaller().then(installer => { installer.uninstall(bundleName, installParam, err => { if (err) { console.error('uninstall failed:' + JSON.stringify(err)); @@ -124,10 +124,10 @@ SystemCapability.BundleManager.BundleFramework **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ---------------------------------------------------- | ---- | ---------------------------------------------- | -| bundleName | string | 是 | 应用包名。 | -| param | [InstallParam](#installparamdeprecated) | 是 | 指定应用恢复所需的其他参数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------------------------------------------------------------ | ---- | -------------------------------------------------- | +| bundleName | string | 是 | 应用Bundle名称。 | +| param | [InstallParam](#installparamdeprecated) | 是 | 指定应用恢复所需的其他参数。 | | callback | AsyncCallback<[InstallStatus](#installstatusdeprecated)> | 是 | 程序启动作为入参的回调函数,返回应用恢复状态信息。 | **示例:** @@ -142,7 +142,7 @@ let installParam = { installFlag: 1, }; -bundle.getBundleInstaller().then(installer=>{ +bundle.getBundleInstaller().then(installer => { installer.recover(bundleName, installParam, err => { if (err) { console.error('recover failed:' + JSON.stringify(err)); @@ -165,9 +165,9 @@ bundle.getBundleInstaller().then(installer=>{ | 名称 | 类型 | 可读 | 可写 | 说明 | | ----------- | ------- | ---- | ---- | ------------------ | -| userId | number | 是 | 否 | 指示用户id | -| installFlag | number | 是 | 否 | 指示安装标志 | -| isKeepData | boolean | 是 | 否 | 指示参数是否有数据 | +| userId | number | 是 | 是 | 指示用户id, 默认值:调用方的userId | +| installFlag | number | 是 | 是 | 指示安装标志, 默认值:1, 取值范围:
1: 覆盖安装,
16: 免安装| +| isKeepData | boolean | 是 | 是 | 指示参数是否有数据,默认值:false | ## InstallStatus(deprecated) @@ -179,8 +179,8 @@ bundle.getBundleInstaller().then(installer=>{ | 名称 | 类型 | 可读 | 可写 | 说明 | | ------------- | ------------------------------------------------------------ | ---- | ---- | ------------------------------ | -| status | bundle.[InstallErrorCode](js-apis-Bundle.md#installerrorcode) | 是 | 否 | 表示安装或卸载错误状态码。 | -| statusMessage | string | 是 | 否 | 表示安装或卸载的字符串结果信息。 | +| status | bundle.[InstallErrorCode](js-apis-Bundle.md#installerrorcode) | 是 | 否 | 表示安装或卸载错误状态码。取值范围:枚举值[InstallErrorCode](js-apis-Bundle.md#installerrorcode) | +| statusMessage | string | 是 | 否 | 表示安装或卸载的字符串结果信息。取值范围包括:
"SUCCESS" : 安装成功,
"STATUS_INSTALL_FAILURE": 安装失败(不存在安装文件),
"STATUS_INSTALL_FAILURE_ABORTED": 安装中止,
"STATUS_INSTALL_FAILURE_INVALID": 安装参数无效,
"STATUS_INSTALL_FAILURE_CONFLICT": 安装冲突(常见于升级和已有应用基本信息不一致),
"STATUS_INSTALL_FAILURE_STORAGE": 存储包信息失败,
"STATUS_INSTALL_FAILURE_INCOMPATIBLE": 安装不兼容(常见于版本降级安装或者签名信息错误),
"STATUS_UNINSTALL_FAILURE": 卸载失败(不存在卸载的应用),
"STATUS_UNINSTALL_FAILURE_ABORTED": 卸载中止(没有使用),
"STATUS_UNINSTALL_FAILURE_ABORTED": 卸载冲突(卸载系统应用失败, 结束应用进程失败),
"STATUS_INSTALL_FAILURE_DOWNLOAD_TIMEOUT": 安装失败(下载超时),
"STATUS_INSTALL_FAILURE_DOWNLOAD_FAILED": 安装失败(下载失败),
"STATUS_RECOVER_FAILURE_INVALID": 恢复预置应用失败,
"STATUS_ABILITY_NOT_FOUND": Ability未找到,
"STATUS_BMS_SERVICE_ERROR": BMS服务错误,
"STATUS_FAILED_NO_SPACE_LEFT": 设备空间不足,
"STATUS_GRANT_REQUEST_PERMISSIONS_FAILED": 应用授权失败,
"STATUS_INSTALL_PERMISSION_DENIED": 缺少安装权限,
"STATUS_UNINSTALL_PERMISSION_DENIED": 缺少卸载权限| ## 获取应用的沙箱路径 对于FA模型,应用的沙箱路径可以通过[Context](js-apis-inner-app-context.md)中的方法获取;对于Stage模型,应用的沙箱路径可以通过[Context](js-apis-ability-context.md#abilitycontext)中的属性获取。下面以获取沙箱文件路径为例。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundle-CustomizeData.md b/zh-cn/application-dev/reference/apis/js-apis-bundle-CustomizeData.md index 3be53a89eeb8411bb14672ef8780eabbe58b6a54..b070c9609ed2764bbee63817834e031675e27a60 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundle-CustomizeData.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundle-CustomizeData.md @@ -1,4 +1,4 @@ -# customizeData +# CustomizeData diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundle-ElementName.md b/zh-cn/application-dev/reference/apis/js-apis-bundle-ElementName.md index a611aa20e114fbf310663937d3960bf6ac040cc9..a683ca89db326168be4fafcecb0336af53a4ca3e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundle-ElementName.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundle-ElementName.md @@ -1,6 +1,4 @@ -# elementName - - +# ElementName > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > 本模块首批接口从API version 7 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundle-HapModuleInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundle-HapModuleInfo.md index 04b1ada354fbc8c8ce81668bbe0912488bad53ae..c1d6029d9b1842913c0e57ab0f003be73c4e7589 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundle-HapModuleInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundle-HapModuleInfo.md @@ -1,12 +1,9 @@ -# hapModuleInfo - +# HapModuleInfo > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > 本模块首批接口从API version 7 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 - - -Hap模块信息,未做特殊说明的属性,均通过[GET_BUNDLE_DEFAULT](js-apis-Bundle.md)获取。 +Hap模块信息,未做特殊说明的属性,均通过[bundle.getBundleInfo](js-apis-Bundle.md#bundlegetbundleinfodeprecated)获取。 ## HapModuleInfo(deprecated) diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundle-ModuleInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundle-ModuleInfo.md index 3819b5834f5d8f8bdf5b698a7da03adbb9352fd0..4c8c416fcc79c04f3e5048626802126e689ff8d7 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundle-ModuleInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundle-ModuleInfo.md @@ -1,4 +1,4 @@ -# moduleInfo +# ModuleInfo > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > 本模块首批接口从API version 7 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundle-ShortcutInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundle-ShortcutInfo.md index 4c84b936705efb334c7e4c8052edd3b7d25f72e0..b1f2bc642cbfcafac795e52c35ecce4e12e1ef91 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundle-ShortcutInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundle-ShortcutInfo.md @@ -1,4 +1,4 @@ -# shortcutInfo +# ShortcutInfo diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundle-remoteAbilityInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundle-remoteAbilityInfo.md index d622c639c84dd087c3b11250828777cd75a53aa7..088b4f58f28dbeec5cb2e648384d0133a7cf46be 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundle-remoteAbilityInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundle-remoteAbilityInfo.md @@ -1,4 +1,4 @@ -# remoteAbilityInfo +# RemoteAbilityInfo diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-abilityInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-abilityInfo.md index 7eec5ec8d955dbe2503771a1e97ae47879823dea..898617063242ab6362b664cb307415eeae7487e2 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-abilityInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-abilityInfo.md @@ -1,40 +1,41 @@ # AbilityInfo -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> ![icon-note.gif](public_sys-resources/icon-note.gif) +> **说明:** > 本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 -Ability信息,系统应用可以通过[getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)获取自身或其他应用的Ability信息,三方应用可以通过[getBundleInfoForSelf](js-apis-bundleManager.md#bundlemanagergetbundleinfoforself)获取自身的Ability信息,其中入参[BundleFlag](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md#bundleflag)需要使用GET_BUNDLE_INFO_WITH_ABILITY。 +Ability信息,系统应用可以通过[bundleManager.queryAbilityInfo](js-apis-bundleManager.md#bundlemanagerqueryabilityinfo)获取Ability信息,其中入参[abilityFlags](js-apis-bundleManager.md#abilityflag)指定返回的[AbilityInfo](js-apis-bundleManager-abilityInfo.md)中所包含的信息。 ## AbilityInfo **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework.Core。 | 名称 | 类型 | 可读 | 可写 | 说明 | -| --------------------- | -------------------------------------------------------- | ---- | ---- | ----------------------------------------- | -| bundleName | string | 是 | 否 | 应用包名 | -| moduleName | string | 是 | 否 | Ability所属的HAP包的名称 | -| name | string | 是 | 否 | Ability名称 | -| label | string | 是 | 否 | Ability对用户显示的名称 | -| labelId | number | 是 | 否 | Ability的标签资源id | -| description | string | 是 | 否 | Ability的描述 | -| descriptionId | number | 是 | 否 | Ability的描述资源id | -| icon | string | 是 | 否 | Ability的图标资源文件索引 | -| iconId | number | 是 | 否 | Ability的图标资源id | -| process | string | 是 | 否 | Ability的进程,如果不设置,默认为包的名称 | -| isVisible | boolean | 是 | 否 | 判断Ability是否可以被其他应用调用 | -| type | [AbilityType](js-apis-bundleManager.md#abilitytype) | 是 | 否 | Ability类型
此属性仅可在FA模型下使用 | -| orientation | [DisplayOrientation](js-apis-bundleManager.md#displayorientation) | 是 | 否 | Ability的显示模式 | -| launchType | [LaunchType](js-apis-bundleManager.md#launchtype) | 是 | 否 | Ability的启动模式 | -| permissions | Array\ | 是 | 否 | 被其他应用Ability调用时需要申请的权限集合,通过传入GET_ABILITY_INFO_WITH_PERMISSION获取 | -| readPermission | string | 是 | 否 | 读取Ability数据所需的权限
此属性仅可在FA模型下使用 | -| writePermission | string | 是 | 否 | 向Ability写数据所需的权限
此属性仅可在FA模型下使用 | -| uri | string | 是 | 否 | 获取Ability的统一资源标识符(URI)
此属性仅可在FA模型下使用 | -| deviceTypes | Array\ | 是 | 否 | Ability支持的设备类型 | -| applicationInfo | [ApplicationInfo](js-apis-bundleManager-applicationInfo.md) | 是 | 否 | 应用程序的配置信息,通过传入GET_ABILITY_INFO_WITH_APPLICATION获取 | -| metadata | Array\<[Metadata](js-apis-bundleManager-metadata.md)> | 是 | 否 | ability的元信息,通过传入GET_ABILITY_INFO_WITH_METADATA获取 | -| enabled | boolean | 是 | 否 | ability是否可用 | -| supportWindowModes | Array\<[SupportWindowMode](js-apis-bundleManager.md#supportwindowmode)> | 是 | 否 | ability支持的窗口模式 | -| windowSize|[WindowSize](#windowsize) | 是 | 否 | 表示窗口尺寸| +| --------------------- | -------------------------------------------------------- | ---- | ---- | ------------------------------------------ | +| bundleName | string | 是 | 否 | 应用Bundle名称。 | +| moduleName | string | 是 | 否 | Ability所属的HAP的名称。 | +| name | string | 是 | 否 | Ability名称。 | +| label | string | 是 | 否 | Ability对用户显示的名称。 | +| labelId | number | 是 | 否 | Ability的标签资源id。 | +| description | string | 是 | 否 | Ability的描述。 | +| descriptionId | number | 是 | 否 | Ability的描述资源id。 | +| icon | string | 是 | 否 | Ability的图标资源文件索引。 | +| iconId | number | 是 | 否 | Ability的图标资源id。 | +| process | string | 是 | 否 | Ability的进程,如果不设置,默认为包的名称。 | +| isVisible | boolean | 是 | 否 | 判断Ability是否可以被其他应用调用。 | +| type | [AbilityType](js-apis-bundleManager.md#abilitytype) | 是 | 否 | Ability类型
此属性仅可在FA模型下使用。 | +| orientation | [DisplayOrientation](js-apis-bundleManager.md#displayorientation) | 是 | 否 | Ability的显示模式。 | +| launchType | [LaunchType](js-apis-bundleManager.md#launchtype) | 是 | 否 | Ability的启动模式。 | +| permissions | Array\ | 是 | 否 | 被其他应用Ability调用时需要申请的权限集合,通过调用[bundleManager.queryAbilityInfo](js-apis-bundleManager.md#bundlemanagerqueryabilityinfo)接口,传入GET_ABILITY_INFO_WITH_PERMISSION获取。 | +| readPermission | string | 是 | 否 | 读取Ability数据所需的权限
此属性仅可在FA模型下使用。 | +| writePermission | string | 是 | 否 | 向Ability写数据所需的权限
此属性仅可在FA模型下使用。 | +| uri | string | 是 | 否 | 获取Ability的统一资源标识符(URI)
此属性仅可在FA模型下使用。 | +| deviceTypes | Array\ | 是 | 否 | Ability支持的设备类型。 | +| applicationInfo | [ApplicationInfo](js-apis-bundleManager-applicationInfo.md) | 是 | 否 | 应用程序的配置信息,通过调用[bundleManager.queryAbilityInfo](js-apis-bundleManager.md#bundlemanagerqueryabilityinfo)接口,传入GET_ABILITY_INFO_WITH_APPLICATION获取。 | +| metadata | Array\<[Metadata](js-apis-bundleManager-metadata.md)> | 是 | 否 | ability的元信息,通过调用[bundleManager.queryAbilityInfo](js-apis-bundleManager.md#bundlemanagerqueryabilityinfo)接口,传入GET_ABILITY_INFO_WITH_METADATA获取。 | +| enabled | boolean | 是 | 否 | ability是否可用。 | +| supportWindowModes | Array\<[SupportWindowMode](js-apis-bundleManager.md#supportwindowmode)> | 是 | 否 | ability支持的窗口模式。 | +| windowSize|[WindowSize](#windowsize) | 是 | 否 | 表示窗口尺寸。| ## WindowSize @@ -44,9 +45,9 @@ Ability信息,系统应用可以通过[getBundleInfo](js-apis-bundleManager.md | 名称 | 类型 | 可读 | 可写 | 说明 | | -------------------| ------- | ---- | ---- | ---------------------------------- | -| maxWindowRatio | number | 是 | 否 | 表示自由窗口状态下窗口的最大宽高比;取值范围0-1 | -| minWindowRatio | number | 是 | 否 | 表示自由窗口状态下窗口的最小宽高比;取值范围0-1 | -| maxWindowWidth | number | 是 | 否 | 表示自由窗口状态下窗口的最大宽度,宽度单位为vp | -| minWindowWidth | number | 是 | 否 | 表示自由窗口状态下窗口的最小宽度,宽度单位为vp | -| maxWindowHeight | number | 是 | 否 | 表示自由窗口状态下窗口的最大高度,宽度单位为vp | -| minWindowHeight | number | 是 | 否 | 表示自由窗口状态下窗口的最小高度,宽度单位为vp | \ No newline at end of file +| maxWindowRatio | number | 是 | 否 | 表示自由窗口状态下窗口的最大宽高比;取值范围0-1。 | +| minWindowRatio | number | 是 | 否 | 表示自由窗口状态下窗口的最小宽高比;取值范围0-1。 | +| maxWindowWidth | number | 是 | 否 | 表示自由窗口状态下窗口的最大宽度,宽度单位为vp。 | +| minWindowWidth | number | 是 | 否 | 表示自由窗口状态下窗口的最小宽度,宽度单位为vp。 | +| maxWindowHeight | number | 是 | 否 | 表示自由窗口状态下窗口的最大高度,宽度单位为vp。 | +| minWindowHeight | number | 是 | 否 | 表示自由窗口状态下窗口的最小高度,宽度单位为vp。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-applicationInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-applicationInfo.md index 5e29ca0192e9a59cf02c93956ab7f49ac74a692a..d643920f81758e1ecfd069c4ed6f0fae8edf5d82 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-applicationInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-applicationInfo.md @@ -1,33 +1,34 @@ # ApplicationInfo -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> ![icon-note.gif](public_sys-resources/icon-note.gif) +> **说明:** > 本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 -应用程序信息,系统应用可以通过[getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)获取自身或其他应用的应用程序信息,三方应用可以通过[getBundleInfoForSelf](js-apis-bundleManager.md#bundlemanagergetbundleinfoforself)获取自身的应用程序信息,其中入参[BundleFlag](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md#bundleflag)需要使用GET_BUNDLE_INFO_WITH_APPLICATION。 +应用程序信息,系统应用可以通过[bundleManager.getApplicationInfo](js-apis-bundleManager.md#bundlemanagergetapplicationinfo)获取自身或其他应用的应用程序信息,其中入参[appFlags](js-apis-bundleManager.md#applicationflag)指定返回的[ApplicationInfo](js-apis-bundleManager-applicationInfo.md)中所包含的信息。 ## ApplicationInfo **系统能力**: 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework.Core | 名称 | 类型 | 可读 | 可写 | 说明 | | -------------------------- | ------------------------------------------------------------ | ---- | ---- | ------------------------------------------------------------ | -| name | string | 是 | 否 | 应用程序的名称 | -| description | string | 是 | 否 | 标识应用的描述信息 | -| descriptionId | number | 是 | 否 | 标识应用的描述信息的资源id | -| enabled | boolean | 是 | 否 | 判断应用程序是否可以使用,默认为true | -| label | string | 是 | 否 | 标识应用的名称 | -| labelId | number | 是 | 否 | 标识应用名称的资源id | -| icon | string | 是 | 否 | 应用程序的图标 | -| iconId | number | 是 | 否 | 应用程序图标的资源id | +| name | string | 是 | 否 | 应用程序的名称。 | +| description | string | 是 | 否 | 标识应用的描述信息。 | +| descriptionId | number | 是 | 否 | 标识应用的描述信息的资源id。 | +| enabled | boolean | 是 | 否 | 判断应用程序是否可以使用,默认为true。 | +| label | string | 是 | 否 | 标识应用的名称。 | +| labelId | number | 是 | 否 | 标识应用名称的资源id。 | +| icon | string | 是 | 否 | 应用程序的图标。 | +| iconId | number | 是 | 否 | 应用程序图标的资源id。 | | process | string | 是 | 否 | 应用程序的进程,如果不设置,默认为包的名称。 | -| permissions | Array\ | 是 | 否 | 访问应用程序所需的权限,通过传入GET_APPLICATION_INFO_WITH_PERMISSION获取 | -| entryDir | string | 是 | 否 | 应用程序的文件保存路径 | -| codePath | string | 是 | 否 | 应用程序的安装目录 | -| metadata | Map\> | 是 | 否 | 应用程序的元信息,通过传入GET_APPLICATION_INFO_WITH_METADATA获取 | -| removable | boolean | 是 | 否 | 应用程序是否可以被移除 | -| accessTokenId | number | 是 | 否 | 应用程序的accessTokenId | -| uid | number | 是 | 否 | 应用程序的uid | -| iconResource | [Resource](js-apis-resource-manager.md#resource9) | 是 | 否 | 应用程序的图标资源信息 | -| labelResource | [Resource](js-apis-resource-manager.md#resource9) | 是 | 否 | 应用程序的标签资源信息 | -| descriptionResource | [Resource](js-apis-resource-manager.md#resource9) | 是 | 否 | 应用程序的描述资源信息 | -| appDistributionType | string | 是 | 否 | 应用程序签名证书的分发类型,分为:app_gallery、enterprise、os_integration和crowdtesting | -| appProvisionType | string | 是 | 否 | 应用程序签名证书文件的类型,分为debug和release两种类型 | \ No newline at end of file +| permissions | Array\ | 是 | 否 | 访问应用程序所需的权限,通过调用[bundleManager.getApplicationInfo](js-apis-bundleManager.md#bundlemanagergetapplicationinfo)接口,传入GET_APPLICATION_INFO_WITH_PERMISSION获取。 | +| entryDir | string | 是 | 否 | 应用程序的文件保存路径。 | +| codePath | string | 是 | 否 | 应用程序的安装目录。 | +| metadata | Map\> | 是 | 否 | 应用程序的元信息,通过调用[bundleManager.getApplicationInfo](js-apis-bundleManager.md#bundlemanagergetapplicationinfo)接口,传入GET_APPLICATION_INFO_WITH_METADATA获取。 | +| removable | boolean | 是 | 否 | 应用程序是否可以被移除。 | +| accessTokenId | number | 是 | 否 | 应用程序的accessTokenId。 | +| uid | number | 是 | 否 | 应用程序的uid。 | +| iconResource | [Resource](js-apis-resource-manager.md#resource9) | 是 | 否 | 应用程序的图标资源信息。 | +| labelResource | [Resource](js-apis-resource-manager.md#resource9) | 是 | 否 | 应用程序的标签资源信息。 | +| descriptionResource | [Resource](js-apis-resource-manager.md#resource9) | 是 | 否 | 应用程序的描述资源信息。 | +| appDistributionType | string | 是 | 否 | 应用程序签名证书的分发类型,分为:app_gallery、enterprise、os_integration和crowdtesting。 | +| appProvisionType | string | 是 | 否 | 应用程序签名证书文件的类型,分为debug和release两种类型。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-bundleInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-bundleInfo.md index 649b5ae5e0597d310190be7fd2af5b7ef799db4e..0a34ff4dce2b392d2f20f18d6c479d5e4e2e9013 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-bundleInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-bundleInfo.md @@ -1,8 +1,9 @@ # BundleInfo -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> ![icon-note.gif](public_sys-resources/icon-note.gif) +> **说明:** > 本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 -应用包信息,系统应用可以通过[getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)获取自身或其他应用的应用包信息,三方应用可以通过[getBundleInfoForSelf](js-apis-bundleManager.md#bundlemanagergetbundleinfoforself)获取自身的应用包信息,其中入参[BundleFlag](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md#bundleflag)需要使用 GET_BUNDLE_INFO_DEFAULT。 +应用包信息,系统应用可以通过[bundleManager.getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)获取自身或其他应用的应用包信息,三方应用可以通过[getBundleInfoForSelf](js-apis-bundleManager.md#bundlemanagergetbundleinfoforself)获取自身的应用包信息,其中入参[bundleFlags](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md#bundleflag)指定所返回的[BundleInfo](js-apis-bundleManager-bundleInfo.md)中所包含的信息。 ## BundleInfo @@ -10,19 +11,19 @@ | 名称 | 类型 | 可读 | 可写 | 说明 | | --------------------------------- | ------------------------------------------------------------ | ---- | ---- | ------------------------------------------------------------ | -| name | string | 是 | 否 | 应用包的名称 | -| vendor | string | 是 | 否 | 应用包的供应商 | -| versionCode | number | 是 | 否 | 应用包的版本号 | -| versionName | string | 是 | 否 | 应用包的版本文本描述信息 | -| minCompatibleVersionCode | number | 是 | 否 | 分布式场景下的应用包兼容的最低版本 | -| targetVersion | number | 是 | 否 | 该标签标识应用运行目标版本 | -| appInfo | [ApplicationInfo](js-apis-bundleManager-applicationInfo.md) | 是 | 否 | 应用程序的配置信息,通过传入GET_BUNDLE_INFO_WITH_APPLICATION获取 | -| hapModulesInfo | Array\<[HapModuleInfo](js-apis-bundleManager-hapModuleInfo.md)> | 是 | 否 | 模块的配置信息,通过传入GET_BUNDLE_INFO_WITH_HAP_MODULE获取 | -| reqPermissionDetails | Array\<[ReqPermissionDetail](#reqpermissiondetail)> | 是 | 否 | 应用运行时需向系统申请的权限集合的详细信息,通过传入GET_BUNDLE_INFO_WITH_REQUESTED_PERMISSION获取| -| permissionGrantStates | Array\<[PermissionGrantState](js-apis-bundleManager.md#permissiongrantstate)> | 是 | 否 | 申请权限的授予状态,通过传入GET_BUNDLE_INFO_WITH_REQUESTED_PERMISSION获取 | -| signatureInfo | [SignatureInfo](#signatureinfo) | 是 | 否 | 应用包的签名信息,通过传入GET_BUNDLE_INFO_WITH_SIGNATURE_INFO获取 | -| installTime | number | 是 | 否 | 应用包安装时间 | -| updateTime | number | 是 | 否 | 应用包更新时间 | +| name | string | 是 | 否 | 应用包的名称。 | +| vendor | string | 是 | 否 | 应用包的供应商。 | +| versionCode | number | 是 | 否 | 应用包的版本号。 | +| versionName | string | 是 | 否 | 应用包的版本文本描述信息。 | +| minCompatibleVersionCode | number | 是 | 否 | 分布式场景下的应用包兼容的最低版本。 | +| targetVersion | number | 是 | 否 | 该标签标识应用运行目标版本。 | +| appInfo | [ApplicationInfo](js-apis-bundleManager-applicationInfo.md) | 是 | 否 | 应用程序的配置信息,通过调用[bundleManager.getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)接口,传入GET_BUNDLE_INFO_WITH_APPLICATION获取。 | +| hapModulesInfo | Array\<[HapModuleInfo](js-apis-bundleManager-hapModuleInfo.md)> | 是 | 否 | 模块的配置信息,通过调用[bundleManager.getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)接口,传入GET_BUNDLE_INFO_WITH_HAP_MODULE获取。 | +| reqPermissionDetails | Array\<[ReqPermissionDetail](#reqpermissiondetail)> | 是 | 否 | 应用运行时需向系统申请的权限集合的详细信息,通过调用[bundleManager.getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)接口,传入GET_BUNDLE_INFO_WITH_REQUESTED_PERMISSION获取。| +| permissionGrantStates | Array\<[PermissionGrantState](js-apis-bundleManager.md#permissiongrantstate)> | 是 | 否 | 申请权限的授予状态,通过调用[bundleManager.getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)接口,传入GET_BUNDLE_INFO_WITH_REQUESTED_PERMISSION获取。 | +| signatureInfo | [SignatureInfo](#signatureinfo) | 是 | 否 | 应用包的签名信息,通过调用[bundleManager.getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)接口,传入GET_BUNDLE_INFO_WITH_SIGNATURE_INFO获取。 | +| installTime | number | 是 | 否 | 应用包安装时间。 | +| updateTime | number | 是 | 否 | 应用包更新时间。 | ## ReqPermissionDetail @@ -33,10 +34,10 @@ | 名称 | 类型 | 可读 | 可写 | 说明 | | --------------------- | ----------------------- | ---- | ---- | ---------------------| -| name | string | 是 | 是 | 需要使用的权限名称 | -| reason | string | 是 | 是 | 描述申请权限的原因 | -| reasonId | number | 是 | 是 | 描述申请权限的原因ID | -| usedScene | [UsedScene](#usedscene) | 是 | 是 | 权限使用的场景和时机 | +| name | string | 是 | 是 | 需要使用的权限名称。 | +| reason | string | 是 | 是 | 描述申请权限的原因。 | +| reasonId | number | 是 | 是 | 描述申请权限的原因ID。 | +| usedScene | [UsedScene](#usedscene) | 是 | 是 | 权限使用的场景和时机。 | @@ -48,7 +49,7 @@ | 名称 | 类型 | 可读 | 可写 | 说明 | | --------- | -------------- | ---- | ---- | --------------------------- | -| abilities | Array\ | 是 | 是 | 使用到该权限的Ability集合 | +| abilities | Array\ | 是 | 是 | 使用到该权限的Ability集合。 | | when | string | 是 | 是 | 使用该权限的时机。 | ## SignatureInfo @@ -59,5 +60,5 @@ | 名称 | 类型 | 可读 | 可写 | 说明 | | --------- | -------------- | ---- | ---- | --------------------------- | -| appId | string | 是 | 否 | 应用的appId | -|fingerprint| string | 是 | 否 | 应用包的指纹信息 | +| appId | string | 是 | 否 | 应用的appId。 | +|fingerprint| string | 是 | 否 | 应用包的指纹信息。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-dispatchInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-dispatchInfo.md index c0efbfc7b07ccf28d872980cb2b000e8606dc5eb..2f72004ed883edc5c56d318ecfcf4a5229d97669 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-dispatchInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-dispatchInfo.md @@ -1,6 +1,7 @@ # DispatchInfo -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> ![icon-note.gif](public_sys-resources/icon-note.gif) +> **说明:** > 本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 免安装结构体和接口版本信息类,通过接口[freeInstall.getDispatchInfo](js-apis-freeInstall.md)获取。 @@ -13,5 +14,5 @@ | 名称 | 类型 | 可读 | 可写 | 说明 | | ----------- | ------ | ---- | ---- | ------------------------ | -| version | string | 是 | 否 | dispatchInfo结构体版本信息 | -| dispatchAPIVersion | string | 是 | 否 | 免安装接口版本信息 | +| version | string | 是 | 否 | dispatchInfo结构体版本信息。 | +| dispatchAPIVersion | string | 是 | 否 | 免安装接口版本信息。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-elementName.md b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-elementName.md index cd5ab868ed67ef4b435f0cb22a36340907c0240c..b08b43b5389b61abc88d01e28b827c0db8dbdec8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-elementName.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-elementName.md @@ -1,7 +1,7 @@ # ElementName - -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> ![icon-note.gif](public_sys-resources/icon-note.gif) +> **说明:** > 本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 ElementName信息,通过接口[Context.getElementName](js-apis-inner-app-context.md)获取。 @@ -11,9 +11,9 @@ ElementName信息,通过接口[Context.getElementName](js-apis-inner-app-conte | 名称 | 类型 | 可读 | 可写 | 说明 | | ----------------------- | ---------| ---- | ---- | ------------------------- | -| deviceId | string | 是 | 是 | 设备id。 | -| bundleName | string | 是 | 是 | 应用包名。 | +| deviceId | string | 是 | 是 | 设备ID。 | +| bundleName | string | 是 | 是 | 应用Bundle名称。 | | abilityName | string | 是 | 是 | Ability名称。 | | uri | string | 是 | 是 | 资源标识符。 | | shortName | string | 是 | 是 | Ability短名称。 | -| moduleName | string | 是 | 是 | Ability所属的HAP包的模块名称。 | \ No newline at end of file +| moduleName | string | 是 | 是 | Ability所属的HAP的模块名称。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-extensionAbilityInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-extensionAbilityInfo.md index 15c36235547c8300023707fb3834082e03c6213a..685753315bd8c5e6d4ca016ded017378665ac25e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-extensionAbilityInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-extensionAbilityInfo.md @@ -2,7 +2,7 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > 本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 -ExtensionAbility信息,系统应用可以通过[getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)获取自身或其他应用的ExtensionAbility信息,三方应用可以通过[getBundleInfoForSelf](js-apis-bundleManager.md#bundlemanagergetbundleinfoforself)获取自身的ExtensionAbility信息,其中入参[BundleFlag](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md#bundleflag)需要使用 GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY。 +ExtensionAbility信息,系统应用可以通过[bundleManager.getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)获取自身或其他应用的ExtensionAbility信息,三方应用可以通过[getBundleInfoForSelf](js-apis-bundleManager.md#bundlemanagergetbundleinfoforself)获取自身的ExtensionAbility信息,其中入参[bundleFlags](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md#bundleflag)需要使用 GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY。 ## ExtensionAbilityInfo diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-hapModuleInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-hapModuleInfo.md index 8fccb9fb69742eb726966cbc42378aee6fd816d2..55895f39f5637ec8c5f5f7dd514462d8911e5a45 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-hapModuleInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-hapModuleInfo.md @@ -1,9 +1,9 @@ # HapModuleInfo - -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> ![icon-note.gif](public_sys-resources/icon-note.gif) +> **说明:** > 本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 -HAP信息,系统应用可以通过[getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)获取自身或其他应用的HAP信息,三方应用可以通过[getBundleInfoForSelf](js-apis-bundleManager.md#bundlemanagergetbundleinfoforself)获取自身的HAP信息,其中入参[BundleFlag](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md#bundleflag)需要使用 GET_BUNDLE_INFO_WITH_HAP_MODULE。 +HAP信息,系统应用可以通过[bundleManager.getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)获取自身或其他应用的HAP信息,三方应用可以通过[getBundleInfoForSelf](js-apis-bundleManager.md#bundlemanagergetbundleinfoforself)获取自身的HAP信息,其中入参[bundleFlags](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md#bundleflag)需要使用 GET_BUNDLE_INFO_WITH_HAP_MODULE。 ## HapModuleInfo @@ -11,19 +11,19 @@ HAP信息,系统应用可以通过[getBundleInfo](js-apis-bundleManager.md#bun | 名称 | 类型 | 可读 | 可写 | 说明 | | --------------------------------- | ------------------------------------------------------------ | ---- | ---- | -------------------- | -| name | string | 是 | 否 | 模块名称 | -| icon | string | 是 | 否 | 模块图标 | -| iconId | number | 是 | 否 | 模块图标资源id | -| label | string | 是 | 否 | 模块标签 | -| labelId | number | 是 | 否 | 模块标签资源id | -| description | string | 是 | 否 | 模块描述信息 | -| descriptionId | number | 是 | 否 | 描述信息资源id | -| mainElementName | string | 是 | 否 | 入口ability信息 | -| abilitiesInfo | Array\<[AbilityInfo](js-apis-bundleManager-abilityInfo.md)> | 是 | 否 | Ability信息 | -| extensionAbilitiesInfo | Array\<[ExtensionAbilityInfo](js-apis-bundleManager-extensionAbilityInfo.md)> | 是 | 否 | extensionAbility信息 | -| metadata | Array\<[Metadata](js-apis-bundleManager-metadata.md)> | 是 | 否 | Ability的元信息 | -| deviceTypes | Array\ | 是 | 否 | 支持运行的设备类型 | -| installationFree | boolean | 是 | 否 | 是否支持免安装 | -| hashValue | string | 是 | 否 | Module的Hash值 | -| moduleSourceDir | string | 是 | 否 | Module的路径| +| name | string | 是 | 否 | 模块名称。 | +| icon | string | 是 | 否 | 模块图标。 | +| iconId | number | 是 | 否 | 模块图标资源id。 | +| label | string | 是 | 否 | 模块标签。 | +| labelId | number | 是 | 否 | 模块标签资源id。 | +| description | string | 是 | 否 | 模块描述信息。 | +| descriptionId | number | 是 | 否 | 描述信息资源id。 | +| mainElementName | string | 是 | 否 | 入口ability信息。 | +| abilitiesInfo | Array\<[AbilityInfo](js-apis-bundleManager-abilityInfo.md)> | 是 | 否 | Ability信息。 | +| extensionAbilitiesInfo | Array\<[ExtensionAbilityInfo](js-apis-bundleManager-extensionAbilityInfo.md)> | 是 | 否 | extensionAbility信息。 | +| metadata | Array\<[Metadata](js-apis-bundleManager-metadata.md)> | 是 | 否 | Ability的元信息。 | +| deviceTypes | Array\ | 是 | 否 | 支持运行的设备类型。 | +| installationFree | boolean | 是 | 否 | 是否支持免安装。 | +| hashValue | string | 是 | 否 | Module的Hash值。 | +| moduleSourceDir | string | 是 | 否 | Module的路径。| diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-launcherAbilityInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-launcherAbilityInfo.md index 524aee61879bd93be29d9a78a1c35317b7cba1f2..c71a4fd8a64d648cbaf0ef424b1f917abb90cfdb 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-launcherAbilityInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-launcherAbilityInfo.md @@ -1,7 +1,8 @@ # LauncherAbilityInfo -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> ![icon-note.gif](public_sys-resources/icon-note.gif) +> **说明:** > 本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 -桌面应用的Ability信息,可以通过[getLauncherAbilityInfo](js-apis-launcherBundleManager.md#launcherbundlemanagergetlauncherabilityinfo9)获取。 +桌面应用的Ability信息,可以通过[bundleManager.getLauncherAbilityInfo](js-apis-launcherBundleManager.md#launcherbundlemanagergetlauncherabilityinfo9)获取。 ## LauncherAbilityInfo @@ -11,9 +12,9 @@ | 名称 | 类型 | 可读 | 可写 | 说明 | | --------------- | ----------------------------------------------------------- | ---- | ---- | ------------------------------------ | -| applicationInfo | [ApplicationInfo](js-apis-bundleManager-applicationInfo.md) | 是 | 否 | launcher ability的应用程序的配置信息 | -| elementName | [ElementName](js-apis-bundleManager-elementName.md) | 是 | 否 | launcher ability的ElementName信息 | -| labelId | number | 是 | 否 | launcher ability的标签ID | -| iconId | number | 是 | 否 | launcher ability的图标ID | -| userId | number | 是 | 否 | launcher ability的用户ID | -| installTime | number | 是 | 否 | launcher ability的安装时间 | \ No newline at end of file +| applicationInfo | [ApplicationInfo](js-apis-bundleManager-applicationInfo.md) | 是 | 否 | launcher ability的应用程序的配置信息。 | +| elementName | [ElementName](js-apis-bundleManager-elementName.md) | 是 | 否 | launcher ability的ElementName信息。 | +| labelId | number | 是 | 否 | launcher ability的标签ID。 | +| iconId | number | 是 | 否 | launcher ability的图标ID。 | +| userId | number | 是 | 否 | launcher ability的用户ID。 | +| installTime | number | 是 | 否 | launcher ability的安装时间。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-metadata.md b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-metadata.md index 86bcc9dea27188dac154c52ba94cfd3eb2cc3f82..1563ff7f871f0e88ed5c3db59e50687953889330 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-metadata.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-metadata.md @@ -1,6 +1,6 @@ # Metadata -元数据对象,可以通过[getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)获取,此对象在[ApplicationInfo](js-apis-bundleManager-applicationInfo.md)、[HapModuleInfo](js-apis-bundleManager-hapModuleInfo.md)、[AbilityInfo](js-apis-bundleManager-abilityInfo.md)、[ExtensionAbilityInfo](js-apis-bundleManager-extensionAbilityInfo.md)中均包含。 +元数据对象,可以通过[bundleManager.getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)获取,此对象在[ApplicationInfo](js-apis-bundleManager-applicationInfo.md)、[HapModuleInfo](js-apis-bundleManager-hapModuleInfo.md)、[AbilityInfo](js-apis-bundleManager-abilityInfo.md)、[ExtensionAbilityInfo](js-apis-bundleManager-extensionAbilityInfo.md)中均包含。 > **说明:** > 本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 @@ -11,6 +11,6 @@ **系统能力**: SystemCapability.BundleManager.BundleFramework.Core | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | ------ | ---- | ---- | ---------- | -| name | string | 是 | 是 | 元数据名称 | -| value | string | 是 | 是 | 元数据值 | -| resource | string | 是 | 是 | 元数据资源 | \ No newline at end of file +| name | string | 是 | 是 | 元数据名称。 | +| value | string | 是 | 是 | 元数据值。 | +| resource | string | 是 | 是 | 元数据资源。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-packInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-packInfo.md index 76ca933ed0edd2ce0c882e153f8610834e02f3de..0d860491a8a30356c125cc7f5ea514d3b435e3ed 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-packInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-packInfo.md @@ -131,7 +131,7 @@ | ----------- | ------ | ---- | ---- | -------------------- | | releaseType | string | 是 | 否 | 版本的名称。 | | compatible | number | 是 | 否 | 版本的最小兼容代码。 | -| target | number | 是 | 否 | 目标版本号。 | +| target | number | 是 | 否 | 目标版本号。 | ## Version diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-permissionDef.md b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-permissionDef.md index 5e341eaadc5b689acd15a28e86bd798d50c37b42..362d9a25ffd9f793111b029cb9e2fed2a5a79afa 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-permissionDef.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-permissionDef.md @@ -1,6 +1,6 @@ # PermissionDef - -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> ![icon-note.gif](public_sys-resources/icon-note.gif) +> **说明:** > 本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 配置文件中定义的权限详细信息,通过接口[bundleManager.getPermissionDef](js-apis-bundleManager.md)获取。配置文件中定义的权限详细信息。 @@ -13,7 +13,7 @@ | 名称 | 类型 | 可读 | 可写 | 说明 | | -------------- | ------ | ---- | ---- | -------------- | -| permissionName | string | 是 | 否 | 用户权限名称 | -| grantMode | number | 是 | 否 | 权限的授予模式 | -| labelId | number | 是 | 否 | 权限的标签ID | -| descriptionId | number | 是 | 否 | 描述权限的ID | \ No newline at end of file +| permissionName | string | 是 | 否 | 用户权限名称。 | +| grantMode | number | 是 | 否 | 权限的授予模式。 | +| labelId | number | 是 | 否 | 权限的标签ID。 | +| descriptionId | number | 是 | 否 | 描述权限的ID。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-remoteAbilityInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-remoteAbilityInfo.md index 6a8c9700871260e6071f78437a64e0b156385dd4..5ec5b271e2d0c6b0f11721e1eff095c52f9bc50d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-remoteAbilityInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-remoteAbilityInfo.md @@ -1,6 +1,6 @@ # RemoteAbilityInfo - -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> ![icon-note.gif](public_sys-resources/icon-note.gif) +> **说明:** > 本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 包含远程的ability信息,通过接口[distributedBundle.getRemoteAbilityInfo](js-apis-distributedBundle.md)获取。 @@ -13,6 +13,6 @@ | 名称 | 类型 | 可读 | 可写 | 说明 | | ----------- | -------------------------------------------- | ---- | ---- | ----------------------- | -| elementName | [ElementName](js-apis-bundleManager-elementName.md) | 是 | 否 | 指明远程ability的ElementName信息 | -| label | string | 是 | 否 | 指明远程ability的标签信息 | -| icon | string | 是 | 否 | 指明的远程ability的图标信息 | +| elementName | [ElementName](js-apis-bundleManager-elementName.md) | 是 | 否 | 指明远程ability的ElementName信息。 | +| label | string | 是 | 否 | 指明远程ability的标签信息。 | +| icon | string | 是 | 否 | 指明的远程ability的图标信息。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md b/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md index 65a1472f388037646dadd17056f9e7ba99c2bf2e..b9194613d7da1413cdc357b88b34a36d12c0442a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md @@ -1,4 +1,4 @@ -# bundleManager模块(JS端SDK接口) +# @ohos.bundle.bundleManager (bundleManager模块) 本模块提供应用信息查询能力,支持BundleInfo、ApplicationInfo、Ability、ExtensionAbility等信息的查询 @@ -484,7 +484,7 @@ getApplicationInfo(bundleName: string, appFlags: [number](#applicationflag), use | 17700004 | The specified user ID is not found. | | 17700026 | The specified bundle is disabled. | -**示例:** +**示例:** ```ts import bundleManager from '@ohos.bundle.bundleManager' @@ -1711,7 +1711,7 @@ let want = { bundleName : "com.example.myapplication", abilityName : "com.example.myapplication.MainAbility" }; -var info; +let info; try { bundleManager.queryAbilityInfo(want, abilityFlags, userId).then((abilitiesInfo) => { @@ -1777,7 +1777,7 @@ let want = { bundleName : "com.example.myapplication", abilityName : "com.example.myapplication.MainAbility" }; -var info; +let info; try { bundleManager.queryAbilityInfo(want, abilityFlags, userId).then((abilitiesInfo) => { @@ -1924,7 +1924,7 @@ let want = { bundleName : "com.example.myapplication", abilityName : "com.example.myapplication.MainAbility" }; -var info; +let info; try { bundleManager.queryAbilityInfo(want, abilityFlags, userId).then((abilitiesInfo) => { @@ -1987,7 +1987,7 @@ let want = { bundleName : "com.example.myapplication", abilityName : "com.example.myapplication.MainAbility" }; -var info; +let info; try { bundleManager.queryAbilityInfo(want, abilityFlags, userId).then((abilitiesInfo) => { @@ -2720,7 +2720,7 @@ getApplicationInfoSync(bundleName: string, applicationFlags: number, userId: num | ----------- | ------ | ---- | ----------------------------------------------------------| | bundleName | string | 是 | 表示应用程序的bundleName。 | | applicationFlags | [number](#applicationflag) | 是 | 表示用于指定将返回的ApplicationInfo对象中包含的信息。 | -| userId | number | 是 | 表示用户ID。 | +| userId | number | 否 | 表示用户ID。 | **返回值:** @@ -2754,42 +2754,6 @@ try { } ``` -### bundleManager.getApplicationInfoSync - -getApplicationInfoSync(bundleName: string, applicationFlags: number) : [ApplicationInfo](js-apis-bundleManager-applicationInfo.md); - -以同步方法根据给定的bundleName和applicationFlags获取ApplicationInfo - -**系统接口:** 此接口为系统接口。 - -**需要权限:** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO - -**系统能力:** SystemCapability.BundleManager.BundleFramework.Core - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| ----------- | ------ | ---- | ----------------------------------------------------------| -| bundleName | string | 是 | 表示应用程序的bundleName。 | -| applicationFlags | [number](#applicationflag) | 是 | 表示用于指定将返回的ApplicationInfo对象中包含的信息。 | - -**返回值:** - -| 类型 | 说明 | -| --------------- | ------------------------- | -| [ApplicationInfo](js-apis-bundleManager-applicationInfo.md) | 返回ApplicationInfo对象。 | - -**错误码:** - -以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)。 - -| 错误码ID | 错误信息 | -| -------- | -------------------------------------- | -| 17700001 | The specified bundleName is not found. | -| 17700026 | The specified bundle is disabled. | - -**示例:** - ```ts import bundleManager from '@ohos.bundle.bundleManager' let bundleName = 'com.example.myapplication'; @@ -2821,7 +2785,7 @@ getBundleInfoSync(bundleName: string, bundleFlags: [number](#bundleflag), userId | ----------- | ------ | ---- | -------------------------------------------------------- | | bundleName | string | 是 | 表示应用程序的bundleName。 | | bundleFlags | [number](#bundleflag) | 是 | 表示用于指定将返回的BundleInfo对象中包含的信息的标志。 | -| userId | number | 是 | 表示用户ID。 | +| userId | number | 否 | 表示用户ID。 | **返回值:** @@ -2855,43 +2819,6 @@ try { } ``` -### bundleManager.getBundleInfoSync - -getBundleInfoSync(bundleName: string, bundleFlags: [number](#bundleflag)): [BundleInfo](js-apis-bundleManager-bundleInfo.md); - -以同步方法根据给定的bundleName和bundleFlags获取BundleInfo。 - -**系统接口:** 此接口为系统接口。 - -**需要权限:** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO - -**系统能力:** SystemCapability.BundleManager.BundleFramework.Core - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| ----------- | ------ | ---- | -------------------------------------------------------- | -| bundleName | string | 是 | 表示应用程序的bundleName。 | -| bundleFlags | [number](#bundleflag) | 是 | 表示用于指定将返回的BundleInfo对象中包含的信息的标志。 | - -**返回值:** - -| 类型 | 说明 | -| ---------- | -------------------- | -| [BundleInfo](js-apis-bundleManager-bundleInfo.md) | 返回BundleInfo对象。 | - -**错误码:** - -以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)。 - -| 错误码ID | 错误信息 | -| -------- | ------------------------------------- | -| 17700001 | The specified bundleName is not found. | -| 17700004 | The specified user ID is not found. | -| 17700026 | The specified bundle is disabled. | - -**示例:** - ```ts import bundleManager from '@ohos.bundle.bundleManager' let bundleName = 'com.example.myapplication'; diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundleMonitor.md b/zh-cn/application-dev/reference/apis/js-apis-bundleMonitor.md index 1755bef89e594996fc48c0febe7ed86593cc02d4..24090ebd1d3fa354f69089b4b118f55149331c91 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundleMonitor.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundleMonitor.md @@ -81,7 +81,7 @@ off(type: BundleChangedEvent, callback?: callback\): void; | 参数名 | 类型 | 必填 | 说明 | | ---------------------------- | -------- | ---- | ---------------------------------------------------------- | | type| BundleChangedEvent| 是 | 注销监听的事件类型。 | -| callback | callback\| 是 | 注销监听的回调函数,当为空时表示注销当前事件的所有callback。 | +| callback | callback\| 否 | 注销监听的回调函数,当为空时表示注销当前事件的所有callback。 | **示例:** diff --git a/zh-cn/application-dev/reference/apis/js-apis-distributedBundle.md b/zh-cn/application-dev/reference/apis/js-apis-distributedBundle.md index 09e6acc1c4a9729c611e64da9ef612ee0629c579..e1c43fc5263f5024da1f63d8d9f5e6b4e28a51ef 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-distributedBundle.md +++ b/zh-cn/application-dev/reference/apis/js-apis-distributedBundle.md @@ -1,6 +1,6 @@ # @ohos.bundle.distributedBundle (distributedBundle模块) -本模块提供分布式包的管理能力 +本模块提供分布式应用的管理能力 > **说明:** > @@ -22,7 +22,7 @@ SystemCapability.BundleManager.DistributedBundleFramework | 权限 | 权限等级 | 说明 | | ------------------------------------------ | ------------ | ------------------ | -| ohos.permission.GET_BUNDLE_INFO_PRIVILEGED | system_basic | 可查询所有应用信息。 | +| ohos.permission.GET_BUNDLE_INFO_PRIVILEGED | system_basic | 可查询系统中所有应用信息。 | 权限等级参考[权限等级说明](../../security/accesstoken-overview.md#权限等级说明)。 @@ -30,7 +30,7 @@ SystemCapability.BundleManager.DistributedBundleFramework getRemoteAbilityInfo(elementName: ElementName, callback: AsyncCallback\): void; -以异步方法根据给定的ElementName获取有关远程设备AbilityInfo信息。使用callback异步回调。 +以异步方法获取由elementName指定的远程设备上的应用的AbilityInfo信息。使用callback异步回调。 **系统接口:** 此接口为系统接口。 @@ -43,7 +43,7 @@ getRemoteAbilityInfo(elementName: ElementName, callback: AsyncCallback\ | 是 | 回调函数,操作成功返回err为null,data为RemoteAbilityInfo对象;否则为错误对象。 | +| callback | AsyncCallback<[RemoteAbilityInfo](js-apis-bundleManager-remoteAbilityInfo.md)> | 是 | 回调函数,调用成功返回err为null,data为RemoteAbilityInfo对象;调用失败err为错误对象, data为undefined。 | **错误码:** @@ -67,13 +67,13 @@ try { abilityName: 'MainAbility' }, (err, data) => { if (err) { - console.error('Operation failed:' + JSON.stringify(err)); + console.error('Operation failed: error code is ' + err.code + 'and error message is ' + err.message); } else { console.info('Operation succeed:' + JSON.stringify(data)); } }); } catch (err) { - console.error('Operation failed:' + JSON.stringify(err)); + console.error('Operation failed: error code is ' + err.code + 'and error message is ' + err.message); } ``` @@ -81,7 +81,7 @@ try { getRemoteAbilityInfo(elementName: ElementName): Promise\; -以异步方法根据给定的ElementName获取有关远程设备AbilityInfo信息。使用Promise异步回调。 +以异步方法获取由elementName指定的远程设备上的应用的AbilityInfo信息。使用Promise异步回调。 **系统接口:** 此接口为系统接口。 @@ -99,7 +99,7 @@ getRemoteAbilityInfo(elementName: ElementName): Promise\; | 类型 | 说明 | | ------------------------------------------------------------ | --------------------------------- | -| Promise\<[RemoteAbilityInfo](js-apis-bundleManager-remoteAbilityInfo.md)> | Promise对象,返回RemoteAbilityInfo对象。 | +| Promise\<[RemoteAbilityInfo](js-apis-bundleManager-remoteAbilityInfo.md)> | Promise对象,调用成功返回RemoteAbilityInfo对象;调用失败返回错误对象。 | **错误码:** @@ -124,10 +124,10 @@ try { }).then(data => { console.info('Operation succeed:' + JSON.stringify(data)); }).catch(err => { - console.error('Operation failed:' + JSON.stringify(err)); + console.error('Operation failed: error code is ' + err.code + 'and error message is ' + err.message); }); } catch (err) { - console.error('Operation failed:' + JSON.stringify(err)); + console.error('Operation failed: error code is ' + err.code + 'and error message is ' + err.message); } ``` @@ -135,7 +135,7 @@ try { getRemoteAbilityInfo(elementNames: Array\, callback: AsyncCallback\>): void; -以异步方法根据给定的ElementName获取有关远程设备AbilityInfo数组信息。使用callback异步回调。 +以异步方法获取由elementName指定的远程设备上的应用的AbilityInfo数组信息。使用callback异步回调。 **系统接口:** 此接口为系统接口。 @@ -148,7 +148,7 @@ getRemoteAbilityInfo(elementNames: Array\, callback: AsyncCallback\ | 参数名 | 类型 | 必填 | 说明 | | ------------ | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | elementNames | Array<[ElementName](js-apis-bundleManager-elementName.md)> | 是 | ElementName信息,最大数组长度为10。 | -| callback | AsyncCallback\> | 是 | 回调函数,调用成功返回err为null,data为RemoteAbilityInfo数组对象;否则返回错误对象。 | +| callback | AsyncCallback\> | 是 | 回调函数,调用成功返回err为null,data为RemoteAbilityInfo数组对象;调用失败err为错误对象, data为undefined。 | **错误码:** @@ -179,13 +179,13 @@ try { } ], (err, data) => { if (err) { - console.error('Operation failed:' + JSON.stringify(err)); + console.error('Operation failed: error code is ' + err.code + 'and error message is ' + err.message); } else { console.info('Operation succeed:' + JSON.stringify(data)); } }); } catch (err) { - console.error('Operation failed:' + JSON.stringify(err)); + console.error('Operation failed: error code is ' + err.code + 'and error message is ' + err.message); } ``` @@ -193,7 +193,7 @@ try { getRemoteAbilityInfo(elementNames: Array\): Promise\>; -以异步方法根据给定的ElementName和locale获取有关远程设备AbilityInfo数组信息。使用Promise异步回调。 +以异步方法获取由elementName指定的远程设备上的应用的AbilityInfo数组信息。使用Promise异步回调。 **系统接口:** 此接口为系统接口。 @@ -211,7 +211,7 @@ getRemoteAbilityInfo(elementNames: Array\): Promise\> | Promise对象,返回RemoteAbilityInfo数组对象。 | +| Promise\> | Promise对象,调用成功返回RemoteAbilityInfo对象;调用失败返回错误对象。 | **错误码:** @@ -243,10 +243,10 @@ try { ]).then(data => { console.info('Operation succeed:' + JSON.stringify(data)); }).catch(err => { - console.error('Operation failed:' + JSON.stringify(err)); + console.error('Operation failed: error code is ' + err.code + 'and error message is ' + err.message); }); } catch (err) { - console.error('Operation failed:' + JSON.stringify(err)); + console.error('Operation failed: error code is ' + err.code + 'and error message is ' + err.message); } ``` @@ -254,7 +254,7 @@ try { getRemoteAbilityInfo(elementName: ElementName, locale: string, callback: AsyncCallback\): void; -以异步方法根据给定的ElementName和locale获取有关远程设备AbilityInfo信息。使用callback异步回调。 +以异步方法获取由elementName和locale指定的远程设备上的应用的AbilityInfo信息。使用callback异步回调。 **系统接口:** 此接口为系统接口。 @@ -268,7 +268,7 @@ getRemoteAbilityInfo(elementName: ElementName, locale: string, callback: AsyncCa | ----------- | ------------------------------------------------------------ | ---- | -------------------------------------------------- | | elementName | [ElementName](js-apis-bundleManager-elementName.md) | 是 | ElementName信息。 | | locale | string |是 | 语言地区。 | -| callback | AsyncCallback<[RemoteAbilityInfo](js-apis-bundleManager-remoteAbilityInfo.md)> | 是 | 回调函数,操作成功返回err为null,data为RemoteAbilityInfo对象;否则为错误对象。 | +| callback | AsyncCallback<[RemoteAbilityInfo](js-apis-bundleManager-remoteAbilityInfo.md)> | 是 | 回调函数,调用成功返回err为null,data为RemoteAbilityInfo对象;调用失败err为错误对象, data为undefined。 | **错误码:** @@ -292,13 +292,13 @@ try { abilityName: 'MainAbility' }, 'zh-Hans-CN', (err, data) => { if (err) { - console.error('Operation failed:' + JSON.stringify(err)); + console.error('Operation failed: error code is ' + err.code + 'and error message is ' + err.message); } else { console.info('Operation succeed:' + JSON.stringify(data)); } }); } catch (err) { - console.error('Operation failed:' + JSON.stringify(err)); + console.error('Operation failed: error code is ' + err.code + 'and error message is ' + err.message); } ``` @@ -306,7 +306,7 @@ try { getRemoteAbilityInfo(elementName: ElementName, locale: string): Promise\; -以异步方法根据给定的ElementName和locale获取有关远程设备AbilityInfo信息。使用Promise异步回调。 +以异步方法获取由elementName和locale指定的远程设备上的应用的AbilityInfo信息。使用Promise异步回调。 **系统接口:** 此接口为系统接口。 @@ -325,7 +325,7 @@ getRemoteAbilityInfo(elementName: ElementName, locale: string): Promise\ | Promise对象,返回RemoteAbilityInfo对象。 | +| Promise\<[RemoteAbilityInfo](js-apis-bundleManager-remoteAbilityInfo.md)> | Promise对象,调用成功返回RemoteAbilityInfo对象;调用失败返回错误对象。 | **错误码:** @@ -350,10 +350,10 @@ try { }, 'zh-Hans-CN').then(data => { console.info('Operation succeed:' + JSON.stringify(data)); }).catch(err => { - console.error('Operation failed:' + JSON.stringify(err)); + console.error('Operation failed: error code is ' + err.code + 'and error message is ' + err.message); }); } catch (err) { - console.error('Operation failed:' + JSON.stringify(err)); + console.error('Operation failed: error code is ' + err.code + 'and error message is ' + err.message); } ``` @@ -361,7 +361,7 @@ try { getRemoteAbilityInfo(elementNames: Array\, locale: string, callback: AsyncCallback\>): void; -以异步方法根据给定的ElementName和locale获取有关远程设备AbilityInfo数组信息。使用callback异步回调。 +以异步方法获取由elementName和locale指定的远程设备上的应用的AbilityInfo数组信息。使用callback异步回调。 **系统接口:** 此接口为系统接口。 @@ -375,7 +375,7 @@ getRemoteAbilityInfo(elementNames: Array\, locale: string, callback | ------------ | ------------------------------------------------------------ | ---- | -------------------------------------------------- | | elementNames | Array<[ElementName](js-apis-bundleManager-elementName.md)> | 是 | ElementName信息,最大数组长度为10。 | | locale | string |是 | 语言地区。 | -| callback | AsyncCallback\> | 是 | 回调函数,调用成功返回err为null,data为RemoteAbilityInfo数组对象;否则返回错误对象。 | +| callback | AsyncCallback\> | 是 | 回调函数,调用成功返回err为null,data为RemoteAbilityInfo数组对象;调用失败err为错误对象, data为undefined。 | **错误码:** @@ -406,13 +406,13 @@ try { } ], 'zh-Hans-CN', (err, data) => { if (err) { - console.error('Operation failed:' + JSON.stringify(err)); + console.error('Operation failed: error code is ' + err.code + 'and error message is ' + err.message); } else { console.info('Operation succeed:' + JSON.stringify(data)); } }); } catch (err) { - console.error('Operation failed:' + JSON.stringify(err)); + console.error('Operation failed: error code is ' + err.code + 'and error message is ' + err.message); } ``` @@ -420,7 +420,7 @@ try { getRemoteAbilityInfo(elementNames: Array\, locale: string): Promise\>; -以异步方法根据给定的ElementName和locale获取有关远程设备AbilityInfo数组信息。使用Promise异步回调。 +以异步方法获取由elementName和locale指定的远程设备上的应用的AbilityInfo数组信息。使用Promise异步回调。 **系统接口:** 此接口为系统接口。 @@ -439,7 +439,7 @@ getRemoteAbilityInfo(elementNames: Array\, locale: string): Promise | 类型 | 说明 | | ------------------------------------------------------------ | --------------------------------- | -| Promise\> | Promise对象,返回RemoteAbilityInfo数组对象。 | +| Promise\> | Promise对象,调用成功返回RemoteAbilityInfo对象;调用失败返回错误对象。 | **错误码:** @@ -471,9 +471,9 @@ try { ], 'zh-Hans-CN').then(data => { console.info('Operation succeed:' + JSON.stringify(data)); }).catch(err => { - console.error('Operation failed:' + JSON.stringify(err)); + console.error('Operation failed: error code is ' + err.code + 'and error message is ' + err.message); }); } catch (err) { - console.error('Operation failed:' + JSON.stringify(err)); + console.error('Operation failed: error code is ' + err.code + 'and error message is ' + err.message); } ``` diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-bundle.md b/zh-cn/application-dev/reference/errorcodes/errorcode-bundle.md index dac7629da4c52235031716021b59a56a91fafeb0..6582878d486508c65b0b6bb726188becc4112219 100644 --- a/zh-cn/application-dev/reference/errorcodes/errorcode-bundle.md +++ b/zh-cn/application-dev/reference/errorcodes/errorcode-bundle.md @@ -9,6 +9,7 @@ The specified bundle name is not found. 调用查询等接口时,传入的bundleName不存在。 **可能原因**
+ 1. 输入的bundleName有误。 2. 系统中对应的应用没有安装。 @@ -42,11 +43,11 @@ The specified ability name is not found. **可能原因**
1. 输入的abilityName有误。 -2. 系统中对应的应用没有安装。 +2. 系统中对应的应用不存在该abilityName对应的ability。 **处理步骤**
1. 检查abilityName拼写是否正确。 -2. 确认对应的应用是否安装该组件。 +2. 确认对应的应用是否存在该abilityName对应的ability。 ## 17700004 指定的用户不存在 @@ -57,16 +58,17 @@ The specified user ID is not found. 调用与用户相关接口时,传入的用户不存在。 **可能原因**
-输入的用户名有误,系统中没有该用户。 +1. 输入的用户名有误。 +2. 系统中没有该用户。 **处理步骤**
1. 检查用户名拼写是否正确。 2. 确认系统中存在该用户。 -## 17700005 指定的appId不存在 +## 17700005 指定的appId为空字符串 **错误信息**
-The specified app ID is not found. +The specified app ID is empty string. **错误描述**
调用appControl模块中的相关接口时,传入的appId为空字符串。 @@ -115,12 +117,12 @@ The specified device ID is not found. Failed to install the HAP because the HAP fails to be parsed. **错误描述**
-调用installer模块中的install接口时,传入的HAP包解析失败。 +调用installer模块中的install接口时,传入的HAP解析失败。 **可能原因**
-1. hap包的格式不是zip格式。 -2. hap包的配置文件不满足json格式。 -3. hap包的配置文件缺少必要的字段。 +1. HAP的格式不是zip格式。 +2. HAP的配置文件不满足json格式。 +3. HAP的配置文件缺少必要的字段。 **处理步骤**
1. 确认hap的格式是zip。 @@ -137,15 +139,16 @@ Failed to install the HAP because the HAP signature fails to be verified. **可能原因**
-1. hap包没有签名。 +1. HAP没有签名。 2. hap签名信息来源不可靠。 -3. 升级的hap包与已安装的hap包签名信息不一致。 +3. 升级的HAP与已安装的HAP签名信息不一致。 4. 多个hap的签名信息不一致。 **处理步骤**
-1. 确认hap是否签名成功。 -2. 确认多个hap签名时使用的证书相同。 -3. 确认升级的hap签名证书与已安装的hap相同。 +1. 确认hap包是否签名成功。 +2. 确认hap包的签名证书是从应用市场申请。 +3. 确认多个hap包签名时使用的证书相同。 +4. 确认升级的ha包p签名证书与已安装的hap包相同。 ## 17700012 安装包路径无效或者文件过大导致应用安装失败 @@ -156,28 +159,28 @@ Failed to install the HAP because the HAP path is invalid or the HAP is too larg 调用installer模块中的install接口时,安装包路径无效或者文件过大导致应用安装失败。 **可能原因**
-1. 输入错误,hap包的文件路径不存在。 -2. hap包的路径无法访问。 -3. hap包的大小超过最大限制4G。 +1. 输入错误,HAP的文件路径不存在。 +2. HAP的路径无法访问。 +3. HAP的大小超过最大限制4G。 **处理步骤**
1. 确认hap是否存在。 2. 查看hap的可执行权限,是否可读。 -3. 查看hap包的大小是否超过4G。 +3. 查看HAP的大小是否超过4G。 -## 17700015 多个hap包配置信息不同导致应用安装失败 +## 17700015 多个HAP配置信息不同导致应用安装失败 **错误信息**
Failed to install the HAPs because they have different configuration information. **错误描述**
-调用installer模块中的install接口时,多个hap包配置信息不同导致应用安装失败。 +调用installer模块中的install接口时,多个HAP配置信息不同导致应用安装失败。 **可能原因**
-多个hap包中配置文件app下面的字段不一致。 +多个hap包中配置文件中app标签下面的字段信息不一致。 **处理步骤**
-确认多个hap包中配置文件app下面的字段是否一致。 +确认多个HAP中配置文件app下面的字段是否一致。 ## 17700016 系统磁盘空间不足导致应用安装失败 @@ -205,7 +208,7 @@ Failed to install the HAP since the version of the HAP to install is too early. 新安装的应用版本号低于已安装的版本号。 **处理步骤**
-确认新安装的应用版本号是否比已安装的同应用版本号高。 +确认新安装的应用版本号是否不低于已安装的同应用版本号。 ## 17700020 预置应用无法卸载 @@ -298,7 +301,8 @@ The specified type is invalid. 2. 输入的type不存在。 **处理步骤**
-确认输入的type是否拼写正确。 +1. 确认输入的type是否拼写正确。 +2. 确认输入的type是否存在。 ## 17700026 指定应用被禁用 @@ -353,7 +357,7 @@ The specified ability is disabled. 指定的ability被禁用。 **处理步骤**
-确认指定的ability是否被禁用,可以使用[bm工具命令](../../../readme/包管理子系统.md#bm工具命令)查询对应的应用信息。 +确认指定的ability是否被禁用,可以使用[bm工具命令](../../../readme/%E5%8C%85%E7%AE%A1%E7%90%86%E5%AD%90%E7%B3%BB%E7%BB%9F.md%23bm%E5%B7%A5%E5%85%B7%E5%91%BD%E4%BB%A4)查询对应的应用信息。 ## 17700030 指定的应用不支持清除缓存文件 @@ -367,5 +371,7 @@ The specified bundle does not support clearing of cache files. 指定的应用为系统应用且在签名证书中配置了不能清除数据(AllowAppDataNotCleared)的字段。 **处理步骤**
-1.确认指定的应用是否为系统应用,可以使用[bm工具命令](../../../readme/包管理子系统.md#bm工具命令)查询对应的应用信息,查看isSystemApp是否为true。 -2.确认指定的应用是否配置了能清除缓存(AllowAppDataNotCleared)的字段,可以使用[bm工具命令](../../../readme/包管理子系统.md#bm工具命令)查询对应的应用信息,查看userDataClearable是否为true。 +1.确认指定的应用是否为系统应用,可以使用[bm工具命令](../../../readme/%E5%8C%85%E7%AE%A1%E7%90%86%E5%AD%90%E7%B3%BB%E7%BB%9F.md%23bm%E5%B7%A5%E5%85%B7%E5%91%BD%E4%BB%A4)查询对应的应用信息,查看isSystemApp是否为true。 +2.确认指定的应用是否配置了能清除缓存(AllowAppDataNotCleared)的字段,可以使用[bm工具命令](../../../readme/%E5%8C%85%E7%AE%A1%E7%90%86%E5%AD%90%E7%B3%BB%E7%BB%9F.md%23bm%E5%B7%A5%E5%85%B7%E5%91%BD%E4%BB%A4)查询对应的应用信息,查看userDataClearable是否为true。 + + \ No newline at end of file