From a145f1da9a2847549e894731a639d4ee0a3423dc Mon Sep 17 00:00:00 2001 From: xsz233 Date: Mon, 21 Nov 2022 11:47:27 +0800 Subject: [PATCH] api doc bundle Signed-off-by: xsz233 --- .../apis/js-apis-Bundle-InnerBundleManager.md | 18 +- .../apis/js-apis-Bundle-distributedBundle.md | 6 +- .../reference/apis/js-apis-Bundle.md | 398 ++++++++++++------ .../apis/js-apis-bundle-AbilityInfo.md | 54 +-- .../apis/js-apis-bundle-ApplicationInfo.md | 6 +- .../apis/js-apis-bundle-BundleInfo.md | 2 +- .../apis/js-apis-bundle-BundleInstaller.md | 38 +- .../apis/js-apis-bundle-CustomizeData.md | 8 +- .../apis/js-apis-bundle-HapModuleInfo.md | 32 +- .../apis/js-apis-bundle-ModuleInfo.md | 6 +- .../apis/js-apis-bundle-PermissionDef.md | 10 +- .../apis/js-apis-bundle-ShortcutInfo.md | 24 +- .../apis/js-apis-bundle-remoteAbilityInfo.md | 8 +- .../apis/js-apis-defaultAppManager.md | 28 +- .../reference/apis/js-apis-system-package.md | 60 ++- 15 files changed, 440 insertions(+), 258 deletions(-) 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 7c0bf10541..8b34ba38ac 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 @@ -3,7 +3,7 @@ 本模块提供内部包的管理 > **说明：** -> +> > 本模块首批接口从API version 8 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 @@ -48,7 +48,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------- | | bundleName | string | 是 | 要查询的应用程序包名称。 | -| userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | +| userId | number | 是 | 用户ID。取值范围：大于等于0。 | | callback | AsyncCallback\> | 是 | 程序启动作为入参的回调函数，返回程序信息。 | @@ -76,7 +76,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ---------- | ------ | ---- | ----------------------------------------------------- | | bundleName | string | 是 | 要查询的应用程序包名称。 | -| userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | +| userId | number | 是 | 用户ID。取值范围：大于等于0。 | **返回值：** @@ -88,7 +88,7 @@ SystemCapability.BundleManager.BundleFramework on(type:"BundleStatusChange", bundleStatusCallback : BundleStatusCallback, callback: AsyncCallback<string>) : void; -注册Callback。 +注册Callback，使用callback方式异步回调。 **需要权限：** @@ -114,7 +114,7 @@ SystemCapability.BundleManager.BundleFramework on(type:"BundleStatusChange", bundleStatusCallback : BundleStatusCallback): Promise<string> -注册Callback。 +注册Callback，使用promise方式异步回调。 **需要权限：** @@ -145,7 +145,7 @@ SystemCapability.BundleManager.BundleFramework off(type:"BundleStatusChange", callback: AsyncCallback<string>) : void; -取消注册Callback。 +取消注册Callback，使用callback方式异步回调。 **需要权限：** @@ -170,7 +170,7 @@ SystemCapability.BundleManager.BundleFramework off(type:"BundleStatusChange"): Promise<string> -取消注册Callback。 +取消注册Callback，使用promise方式异步回调。 **需要权限：** @@ -218,7 +218,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | -------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------- | -| userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | +| userId | number | 是 | 用户ID。取值范围：大于等于0。 | | callback | AsyncCallback\> | 是 | 程序启动作为入参的回调函数，返回程序信息。 | ## innerBundleManager.getAllLauncherAbilityInfos @@ -243,7 +243,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ------ | ------ | ---- | ----------------------------------------------------- | -| userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | +| userId | number | 是 | 用户ID。取值范围：大于等于0。 | **返回值：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-Bundle-distributedBundle.md b/zh-cn/application-dev/reference/apis/js-apis-Bundle-distributedBundle.md index 33cd88b59c..de22e2e6e7 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-Bundle-distributedBundle.md +++ b/zh-cn/application-dev/reference/apis/js-apis-Bundle-distributedBundle.md @@ -1,6 +1,6 @@ # distributedBundle模块(JS端SDK接口) -本模块提供分布式包的管理 +本模块提供分布式包的管理。 > **说明：** > @@ -109,7 +109,7 @@ SystemCapability.BundleManager.DistributedBundleFramework | 名称 | 类型 | 必填 | 描述 | | ------------ | ------------------------------------------------------------ | ---- | -------------------------------------------------- | -| elementNames | Array<[ElementName](js-apis-bundle-ElementName.md)> | 是 | ElementName信息,最大数组长度为10 | +| elementNames | Array<[ElementName](js-apis-bundle-ElementName.md)> | 是 | ElementName信息，最大数组长度为10。 | | callback | AsyncCallback< Array<[RemoteAbilityInfo](js-apis-bundle-remoteAbilityInfo.md)>> | 是 | 程序启动作为入参的回调函数，返回远程基本能力信息。 | @@ -138,7 +138,7 @@ SystemCapability.BundleManager.DistributedBundleFramework | 名称 | 类型 | 必填 | 描述 | | ------------ | --------------------------------------------------- | ---- | ----------------------- | -| elementNames | Array<[ElementName](js-apis-bundle-ElementName.md)> | 是 | ElementName信息,最大数组长度为10。 | +| elementNames | Array<[ElementName](js-apis-bundle-ElementName.md)> | 是 | ElementName信息，最大数组长度为10。 | **返回值：** 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 12c38a2fea..dd82c01f61 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,6 @@ # Bundle模块(JS端SDK接口) -本模块提供应用信息查询能力，支持[BundleInfo](jw)、ApplicationInfo、Ability、ExtensionAbility、应用状态等信息的查询 +本模块提供应用信息查询能力，支持[包信息](js-apis-bundle-BundleInfo.md)、[应用信息](js-apis-bundle-ApplicationInfo.md)、[Ability组件信息](js-apis-bundle-AbilityInfo.md)等信息的查询，以及应用禁用状态的查询、设置等。 > **说明：** > @@ -28,11 +28,12 @@ import bundle from '@ohos.bundle'; getApplicationInfo(bundleName: string, bundleFlags: number, userId?: number): Promise\ -以异步方法根据给定的包名获取ApplicationInfo。使用Promise异步回调，成功返回应用程序信息，失败返回错误数字1。 +以异步方法根据给定的包名获取ApplicationInfo。使用Promise异步回调。 **需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +
获取调用方自己的信息时不需要权限。 **系统能力：** @@ -43,7 +44,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ----------- | ------ | ---- | ------------------------------------------------------------ | | bundleName | string | 是 | 要查询的应用程序包名称。 | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围请参考[BundleFlag说明](#bundleflag)中应用信息相关flag | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围请参考[BundleFlag说明](#bundleflagdeprecated)中应用信息相关flag。 | | userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | **返回值：** @@ -72,11 +73,12 @@ bundle.getApplicationInfo(bundleName, bundleFlags, userId) getApplicationInfo(bundleName: string, bundleFlags: number, userId: number, callback: AsyncCallback\): void -以异步方法根据给定的包名获取指定用户下的ApplicationInfo，使用callback形式返回结果。获取成功时data为应用程序信息，失败时err为错误数字1。 +以异步方法根据给定的包名获取指定用户下的ApplicationInfo，使用callback形式返回结果。 **需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +
获取调用方自己的信息时不需要权限。 **系统能力：** @@ -87,8 +89,8 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | bundleName | string | 是 | 要查询的应用程序包名称。 | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：参考[BundleFlag说明](#bundleflag)中应用信息相关flag | -| userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围：参考[BundleFlag说明](#bundleflag)中应用信息相关flag。 | +| userId | number | 是 | 用户ID。取值范围：大于等于0。 | | callback | AsyncCallback\<[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)> | 是 | 程序启动作为入参的回调函数，获取成功时data为应用程序信息，失败时err为错误数字1。 | **示例：** @@ -113,11 +115,11 @@ bundle.getApplicationInfo(bundleName, bundleFlags, userId, (err, data) => { getApplicationInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback\): void -以异步方法根据给定的包名获取ApplicationInfo，使用callback形式返回结果。获取成功时data为应用程序信息，失败时err为错误数字1。 - +以异步方法根据给定的包名获取ApplicationInfo，使用callback形式返回结果。 **需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +获取调用方自己的信息时不需要权限。 **系统能力：** @@ -152,7 +154,7 @@ bundle.getApplicationInfo(bundleName, bundleFlags, (err, data) => { getAllBundleInfo(bundleFlag: BundleFlag, userId?: number): Promise> -以异步方法获取指定用户所有的BundleInfo，使用Promise形式返回结果。 +以异步方法获取指定用户所有的BundleInfo，使用Promise形式异步回调， **需要权限：** @@ -166,7 +168,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ---------- | ---------- | ---- | ------------------------------------------------------------ | -| bundleFlag | BundleFlag | 是 | 用于指定返回的包信息对象中包含信息的标记。取值范围：参考[BundleFlag说明](#bundleflag)中包信息相关flag | +| bundleFlag | BundleFlag | 是 | 用于指定返回的包信息对象中包含信息的标记。取值范围：参考[BundleFlag说明](#bundleflag)中包信息相关flag。 | | userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | **返回值：** @@ -195,7 +197,7 @@ bundle.getAllBundleInfo(bundleFlag, userId) getAllBundleInfo(bundleFlag: BundleFlag, callback: AsyncCallback>): void -以异步方法获取当前用户所有的BundleInfo，使用callback形式返回结果。获取成功时data为包信息，失败时err为错误数字1。 +以异步方法获取当前用户所有的BundleInfo，使用callback形式返回结果。 **需要权限：** @@ -209,7 +211,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| bundleFlag | BundleFlag | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：参考[BundleFlag说明](#bundleflag)中包信息相关flag | +| bundleFlag | BundleFlag | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：参考[BundleFlag说明](#bundleflag)中包信息相关flag。 | | callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数，返回所有可用的BundleInfo。 | **示例：** @@ -232,7 +234,7 @@ bundle.getAllBundleInfo(bundleFlag, (err, data) => { getAllBundleInfo(bundleFlag: BundleFlag, userId: number, callback: AsyncCallback>): void -以异步方法获取系统中指定用户下所有的BundleInfo，使用callback形式返回结果。获取成功时data为包信息，失败时err为错误数字1。 +以异步方法获取系统中指定用户下所有的BundleInfo，使用callback形式返回结果。 **需要权限：** @@ -246,7 +248,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| bundleFlag | BundleFlag | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围：参考[BundleFlag说明](#bundleflag)中包信息相关flag | +| bundleFlag | BundleFlag | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围：参考[BundleFlag说明](#bundleflag)中包信息相关flag。 | | userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | | callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数，获取成功时data为指定用户下所有包的BundleInfo，失败时err为错误数字1。 | @@ -271,11 +273,12 @@ bundle.getAllBundleInfo(bundleFlag, userId, (err, data) => { getBundleInfo(bundleName: string, bundleFlags: number, options?: BundleOptions): Promise\ -以异步方法根据给定的包名获取BundleInfo，使用Promise异步回调，获取成功时返回包信息，失败时返回错误数字1。 +以异步方法根据给定的包名获取BundleInfo，使用Promise异步回调。 **需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +获取调用方自己的信息时不需要权限。 **系统能力：** @@ -285,15 +288,15 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ----------- | ------------- | ---- | --------------------------------------- | -| bundleName | string | 是 | 包名 | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围：参考[BundleFlag说明](#bundleflag)中包信息相关flag | -| options | [BundleOptions](#bundleoptions) | 否 | 包含userid。 | +| bundleName | string | 是 | 要查询的应用程序包名。 | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围：参考[BundleFlag说明](#bundleflag)中包信息相关flag。 | +| options | [BundleOptions](#bundleoptions) | 否 | 包含userid的查询选项。 | **返回值：** | 类型 | 说明 | | -------------------- | ---------------------------- | -| Promise\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | Promise对象，获取成功时返回包信息，失败时返回错误数字1 | +| Promise\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | Promise对象，获取成功时返回包信息，失败时返回错误数字1。 | **示例：** @@ -317,11 +320,12 @@ bundle.getBundleInfo(bundleName, bundleFlags, options) getBundleInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback\): void -以异步方法根据给定的包名获取BundleInfo，使用callback异步回调。成功时data为包信息，失败时err为错误数字1。 +以异步方法根据给定的包名获取BundleInfo，使用callback异步回调。 **需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +获取调用方自己的信息时不需要权限。 **系统能力：** @@ -331,8 +335,8 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ----------- | ---------------------------------------------------------- | ---- | ------------------------------------------------------------ | -| bundleName | string | 是 | 包名 | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围：参考[BundleFlag说明](#bundleflag)中包信息相关flag | +| bundleName | string | 是 | 需要查询的应用程序包名。 | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围：参考[BundleFlag说明](#bundleflag)中包信息相关flag。 | | callback | AsyncCallback\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 是 | 程序启动作为入参的回调函数，获取成功时data为包信息，失败时err为错误数字1。 | **示例：** @@ -356,11 +360,12 @@ bundle.getBundleInfo(bundleName, bundleFlags, (err, data) => { getBundleInfo(bundleName: string, bundleFlags: number, options: BundleOptions, callback: AsyncCallback\): void -以异步方法根据给定的包名获取BundleInfo，使用callback异步回调。获取成功时data为包信息，失败时err为错误数字1。 +以异步方法根据给定的包名获取BundleInfo，使用callback异步回调。 **需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +获取调用方自己的信息时不需要权限。 **系统能力：** @@ -370,9 +375,9 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ----------- | ---------------------------------------------------------- | --- | ------------------------------------------------------------ | -| bundleName | string | 是 | 包名 | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围：参考[BundleFlag说明](#bundleflag)中包信息相关flag | -| options | [BundleOptions](#bundleoptions) | 是 | 包含userid。 | +| bundleName | string | 是 | 需要查询的应用程序包名。 | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围：参考[BundleFlag说明](#bundleflag)中包信息相关flag。 | +| options | [BundleOptions](#bundleoptions) | 是 | 包含userid的查询选项。 | | callback | AsyncCallback\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 是 | 程序启动作为入参的回调函数，获取成功时data为包信息，失败时err为错误数字1。 | **示例：** @@ -400,7 +405,7 @@ bundle.getBundleInfo(bundleName, bundleFlags, options, (err, data) => { getBundleInstaller(): Promise<BundleInstaller>; -获取用于安装包的接口，使用promise异步回调，返回安装接口对象。 +获取用于安装包的接口，使用Promise异步回调，返回安装接口对象。 **需要权限：** @@ -418,7 +423,17 @@ SystemCapability.BundleManager.BundleFramework | 类型 | 说明 | | ------------------------------------------------------------ | -------------------------------------------- | -| Promise<[BundleInstaller](js-apis-bundle-BundleInstaller.md)> | 返回值为Promise对象，Promise中包含安装信息。 | +| Promise<[BundleInstaller](js-apis-bundle-BundleInstaller.md)> | Promise对象，返回安装接口对象。 | + +**示例：** + +```ts +bundle.getBundleInstaller().then((data) => { + console.info('getBundleInstaller successfully.'); +}).catch((error) => { + console.error('getBundleInstaller failed.'); +}); +``` ## bundle.getBundleInstallerdeprecated @@ -444,15 +459,26 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | -------- | ------------------------------------------------------------ | ---- | ---------------- | -| callback | AsyncCallback<[BundleInstaller](js-apis-bundle-BundleInstaller.md)> | 是 | data为安装接口对象。 | +| callback | AsyncCallback<[BundleInstaller](js-apis-bundle-BundleInstaller.md)> | 是 | 回调函数，返回安装接口对象。 | + +**示例：** +```ts +bundle.getBundleInstaller((err, data) => { + if (err.code == 0) { + console.error('getBundleInstaller failed.'); + } else { + console.info('getBundleInstaller successfully'); + } +}); +``` ## bundle.cleanBundleCacheFilesdeprecated > 从API version 9开始不再维护，建议使用[bundleManager.cleanBundleCacheFiles](js-apis-bundleManager.md#bundlemanagercleanbundlecachefiles)替代。 cleanBundleCacheFiles(bundleName: string, callback: AsyncCallback<void>): void; -清除指定应用程序的缓存数据 +清除指定应用程序的缓存数据，使用callback异步回调。 **需要权限：** @@ -471,7 +497,21 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ---------- | ------------------- | ---- | ------------------------------------- | | bundleName | string | 是 | 指示要清除其缓存数据的应用程序包名称。 | -| callback | AsyncCallback\ | 是 | 为返回操作结果而调用的回调。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | + +**示例：** + +```ts +let bundleName = "com.example.myapplication"; + +bundle.cleanBundleCacheFiles(bundleName, err => { + if (err) { + console.error('cleanBundleCacheFiles failed.'); + } else { + console.info('cleanBundleCacheFiles successfully.'); + } +}); +``` ## bundle.cleanBundleCacheFilesdeprecated @@ -479,7 +519,7 @@ SystemCapability.BundleManager.BundleFramework cleanBundleCacheFiles(bundleName: string): Promise<void> -清除指定应用程序的缓存数据 +清除指定应用程序的缓存数据，使用Promise异步回调。 **需要权限：** @@ -497,13 +537,25 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ---------- | ------ | ---- | ------------------------------------- | -| bundleName | string | 是 | 指示要清除其缓存数据的应用程序包名称. | +| bundleName | string | 是 | 指示要清除其缓存数据的应用程序包名称。 | **返回值：** | 类型 | 说明 | | ------------- | ------------------------------------ | -| Promise\ | 返回值为Promise对象，Promise中为空。 | +| Promise\ | Promise对象，无返回结果的Promise对象。 | + +**示例：** + +```ts +let bundleName = "com.example.myapplication"; + +bundle.cleanBundleCacheFiles(bundleName).then(()=> { + console.info('cleanBundleCacheFiles successfully.'); +}).catch(err=> { + console.error('cleanBundleCacheFiles failed.'); +}); +``` ## bundle.setApplicationEnableddeprecated @@ -530,8 +582,22 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ---------- | ------------------- | ---- | ----------------------------------------------- | | bundleName | string | 是 | 应用程序包名称。 | -| isEnable | boolean | 是 | 指定是否启用应用程序。true表示启用，false禁用。 | -| callback | AsyncCallback\ | 是 | 为返回操作结果而调用的回调。 | +| isEnable | boolean | 是 | 指定是否启用应用程序。true表示启用，false表示禁用。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | + +**示例：** + +```ts +let bundleName = "com.example.myapplication"; + +bundle.setApplicationEnabled(bundleName, false, err => { + if (err) { + console.error('setApplicationEnabled failed.'); + } else { + console.info('setApplicationEnabled successfully.'); + } +}); +``` ## bundle.setApplicationEnableddeprecated @@ -539,7 +605,7 @@ SystemCapability.BundleManager.BundleFramework setApplicationEnabled(bundleName: string, isEnable: boolean): Promise<void> -设置是否启用指定的应用程序，使用promise异步回调。 +设置是否启用指定的应用程序，使用Promise异步回调。 **需要权限：** @@ -564,7 +630,19 @@ SystemCapability.BundleManager.BundleFramework | 类型 | 说明 | | ------------- | ------------------------------------ | -| Promise\ | 返回值为Promise对象，Promise中为空。 | +| Promise\ | Promise对象，无返回结果的Promise对象。 | + +**示例：** + +```ts +let bundleName = "com.example.myapplication"; + +bundleManager.setApplicationEnabled(bundleName, false).then(()=> { + console.info('setApplicationEnabled successfully.'); +}).catch(err=> { + console.error('setApplicationEnabled failed.'); +}); +``` ## bundle.setAbilityEnableddeprecated @@ -572,7 +650,7 @@ SystemCapability.BundleManager.BundleFramework setAbilityEnabled(info: AbilityInfo, isEnable: boolean, callback: AsyncCallback<void>): void; -设置是否启用指定的功能，使用callback异步回调。 +设置是否启用指定的Ability组件，使用callback异步回调。 **需要权限：** @@ -590,9 +668,34 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | -------- | -------------------------------------------- | ---- | ----------------------------------------------- | -| info | [AbilityInfo](js-apis-bundle-AbilityInfo.md) | 是 | Ability信息。 | +| info | [AbilityInfo](js-apis-bundle-AbilityInfo.md) | 是 | Ability信息，指示需要设置启用状态的Ability。 | | isEnable | boolean | 是 | 指定是否启用应用程序。true表示启用，false禁用。 | -| callback | AsyncCallback\ | 是 | 为返回操作结果而调用的回调。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | + +**示例：** + +```ts +let flag = bundle.BundleFlag.GET_ABILITY_INFO_WITH_PERMISSION; +let userId = 100; +let want = { + bundleName : "com.example.myapplication", + abilityName : "com.example.myapplication.MainAbility" +}; + +bundle.getAbilityInfo(want, flag, userId).then((abilityInfo) => { + console.info('getAbilityInfo successfully. Data: ' + JSON.stringify(abilitiesInfo)); + + bundle.setAbilityEnabled(abilityInfo, false, err => { + if (err) { + console.error('setAbilityEnabled failed:' + JSON.stringify(err)); + } else { + console.info('setAbilityEnabled successfully.'); + } + }); +}).catch(error => { + console.error('getAbilityInfo failed. Cause: ' + JSON.stringify(error)); +}); +``` ## bundle.setAbilityEnableddeprecated @@ -600,7 +703,7 @@ SystemCapability.BundleManager.BundleFramework setAbilityEnabled(info: AbilityInfo, isEnable: boolean): Promise<void> -设置是否启用指定的功能，使用promise异步回调。 +设置是否启用指定的Ability组件，使用Promise异步回调。 **需要权限：** @@ -618,22 +721,44 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | -------- | -------------------------------------------- | ---- | ----------------------------------------------- | -| info | [AbilityInfo](js-apis-bundle-AbilityInfo.md) | 是 | Ability信息。 | +| info | [AbilityInfo](js-apis-bundle-AbilityInfo.md) | 是 | Ability信息，指示需要设置启用状态的Ability。 | | isEnable | boolean | 是 | 指定是否启用应用程序。true表示启用，false禁用。 | **返回值：** | 类型 | 说明 | | ------------- | ------------------------------------ | -| Promise\ | 返回值为Promise对象，Promise中为空。 | +| Promise\ | Promise对象，无返回结果的Promise对象。 | + +**示例：** +```ts +let flag = bundle.BundleFlag.GET_ABILITY_INFO_WITH_PERMISSION; +let userId = 100; +let want = { + bundleName : "com.example.myapplication", + abilityName : "com.example.myapplication.MainAbility" +}; + +bundle.getAbilityInfo(want, flag, userId).then((abilityInfo) => { + console.info('getAbilityInfo successfully. Data: ' + JSON.stringify(abilityInfo)); + + bundle.setAbilityEnabled(abilityInfo, false).then(data => { + console.info('setAbilityEnabled successfully.'); + }).catch(err => { + console.error('setAbilityEnabled failed:' + JSON.stringify(err)); + }) +}).catch(error => { + console.error('getAbilityInfo failed. Cause: ' + JSON.stringify(error)); +}); +``` ## bundle.getPermissionDefdeprecated > 从API version 9开始不再维护，建议使用[bundleManager.getPermissionDef](js-apis-bundleManager.md#bundlemanagergetpermissiondef)替代。 getPermissionDef(permissionName: string, callback: AsyncCallback<PermissionDef>): void; -按权限名称获取权限的详细信息，使用callback异步回调。获取成功时data为权限的详细信息，失败时err为错误数字1。 +按权限名称获取权限的详细信息，使用callback异步回调。 **需要权限：** @@ -651,9 +776,22 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | -------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------ | -| permissionName | string | 是 | 指定权限的名称。 | +| permissionName | string | 是 | 需要查询的权限的名称。 | | callback | AsyncCallback<[PermissionDef](js-apis-bundle-PermissionDef)> | 是 | 程序启动作为入参的回调函数，返回定义的权限信息。 | +**示例：** + +```ts +let permission = "ohos.permission.GET_BUNDLE_INFO"; +bundleManager.getPermissionDef(permission, (err, data) => { + if (err) { + console.error('getPermissionDef failed:' + err.message); + } else { + console.info('getPermissionDef successfully:' + JSON.stringify(data)); + } +}); +``` + ## bundle.getPermissionDefdeprecated > 从API version 9开始不再维护，建议使用[bundleManager.getPermissionDef](js-apis-bundleManager.md#bundlemanagergetpermissiondef)替代。 @@ -678,7 +816,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | -------------- | ------ | ---- | ---------------- | -| permissionName | string | 是 | 指定权限的名称。 | +| permissionName | string | 是 | 需要查询的权限的名称。 | **返回值：** @@ -686,6 +824,16 @@ SystemCapability.BundleManager.BundleFramework | ------------------------------------------------------ | ------------------------------------------------------ | | Promise<[PermissionDef](js-apis-bundle-PermissionDef)> | Promise对象，获取成功时返回权限详细信息，失败时返回错误数字1。 | +**示例：** + +```ts +let permissionName = "ohos.permission.GET_BUNDLE_INFO"; +bundle.getPermissionDef(permissionName).then((data) => { + console.info('getPermissionDef successfully. Data: ' + JSON.stringify(data)); +}).catch(error => { + console.error('getPermissionDef failed. Cause: ' + error.message); +}); +``` ## bundle.getAllApplicationInfodeprecated @@ -707,7 +855,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ----------- | ------ | ---- | ------------------------------------------------------------ | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围：参考[BundleFlag说明](#bundleflag)中应用信息相关flag | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围：参考[BundleFlag说明](#bundleflag)中应用信息相关flag。 | | userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | **返回值：** @@ -749,7 +897,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：参考[BundleFlag说明](#bundleflag)中应用信息相关flag | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围：参考[BundleFlag说明](#bundleflag)中应用信息相关flag。 | | userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | | callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数，获取成功时data为应用信息列表，失败时err为错误数字1。 | @@ -788,7 +936,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：参考[BundleFlag说明](#bundleflag)中应用信息相关flag | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围：参考[BundleFlag说明](#bundleflag)中应用信息相关flag。 | | callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数，获取成功时data为应用信息列表，失败时err为错误数字1。 | **示例：** @@ -821,7 +969,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ---------- | ------ | ---- | ------------ | | hapFilePath | string | 是 | HAP存放路径。路径应指向当前应用程序的数据目录的相对目录。 | -| bundleFlags | number | 是 | 用于指定要返回的BundleInfo对象中包含信息的标记。默认值：0，取值范围：参考[BundleFlag说明](#bundleflag)中包信息相关flag | +| bundleFlags | number | 是 | 用于指定要返回的BundleInfo对象中包含信息的标记。取值范围：参考[BundleFlag说明](#bundleflag)中包信息相关flag。 | **返回值：** | 类型 | 说明 | @@ -831,7 +979,7 @@ SystemCapability.BundleManager.BundleFramework **示例：** ```js -let hapFilePath = "/data/xxx/test.hap"; +let hapFilePath = "/data/storage/el2/base/test.hap"; let bundleFlags = 0; bundle.getBundleArchiveInfo(hapFilePath, bundleFlags) .then((data) => { @@ -857,8 +1005,8 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ---------- | ------ | ---- | ------------ | -| hapFilePath | string | 是 | HAP存放路径，支持当前应用程序的数据目录沙箱路径和绝对路径。 | -| bundleFlags | number | 是 | 用于指定要返回的BundleInfo对象中包含信息的标记。取值范围：参考[BundleFlag说明](#bundleflag)中包信息相关flag | +| hapFilePath | string | 是 | HAP存放路径，支持当前应用程序的绝对路径和数据目录沙箱路径。 | +| bundleFlags | number | 是 | 用于指定要返回的BundleInfo对象中包含信息的标记。取值范围：参考[BundleFlag说明](#bundleflag)中包信息相关flag。 | | callback| AsyncCallback\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 是 | 程序启动作为入参的回调函数，返回HAP包中包含的应用程序包的信息。| **示例：** @@ -882,11 +1030,12 @@ bundle.getBundleArchiveInfo(hapFilePath, bundleFlags, (err, data) => { getAbilityInfo(bundleName: string, abilityName: string): Promise\ -通过包名称和abilityName获取Ability信息，使用Promise形式返回结果。 +通过包名称和组件名获取Ability组件信息，使用Promise形式异步回调。 **需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +
获取调用方自己的信息时不需要权限。 **系统能力：** @@ -897,7 +1046,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ----------- | ------ | ---- | ---------------- | | bundleName | string | 是 | 应用程序包名。 | -| abilityName | string | 是 | Ability名称。 | +| abilityName | string | 是 | Ability组件名称。 | **返回值：** @@ -924,11 +1073,12 @@ bundle.getAbilityInfo(bundleName, abilityName) getAbilityInfo(bundleName: string, abilityName: string, callback: AsyncCallback\): void; -通过包名称和abilityName获取Ability信息，使用callback形式返回结果。 +通过包名称和ability名称获取Ability信息，使用callback形式返回结果。 **需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +
获取调用方自己的信息时不需要权限。 **系统能力：** @@ -962,11 +1112,12 @@ bundle.getAbilityInfo(bundleName, abilityName, (err, data) => { getAbilityLabel(bundleName: string, abilityName: string): Promise\ -通过包名称和abilityName获取应用名称，使用Promise形式返回结果。 +通过包名称和ability名称获取应用名称，使用Promise形式返回结果。 **需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +
获取调用方自己的信息时不需要权限。 **系统能力：** @@ -1009,6 +1160,7 @@ getAbilityLabel(bundleName: string, abilityName: string, callback : AsyncCallbac **需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +
获取调用方自己的信息时不需要权限。 **系统能力：** @@ -1052,7 +1204,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ---- | ----------- | ---- | ------------ | -| info | [AbilityInfo](js-apis-bundle-AbilityInfo.md) | 是 | Ability的配置信息 | +| info | [AbilityInfo](js-apis-bundle-AbilityInfo.md) | 是 | Ability信息 | **返回值：** @@ -1162,7 +1314,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ---------- | ----------------------- | ---- | --------------- | | bundleName | string | 是 | 要查询的应用程序包名称。 | -| callback | AsyncCallback\ | 是 | 返回boolean代表是否启用 | +| callback | AsyncCallback\ | 是 | 返回boolean代表是否启用。 | **示例：** @@ -1183,11 +1335,12 @@ bundle.isApplicationEnabled(bundleName, (err, data) => { queryAbilityByWant(want: Want, bundleFlags: number, userId?: number): Promise> -以异步方法根据给定的意图获取Ability信息，使用Promise形式返回结果。 +以异步方法根据给定的意图获取Ability组件信息，使用Promise形式返回结果。 **需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +
获取调用方自己的信息时不需要权限。 **系统能力：** @@ -1198,8 +1351,8 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ----------- | ------ | ---- | ------------------------------------- | | want | [Want](js-apis-application-Want.md) | 是 | 包含要查询的应用程序包名称的意图。 | -| bundleFlags | number | 是 | 用于指定返回abilityInfo信息。取值范围：参考[BundleFlag说明](#bundleflag)中Ability信息相关flag | -| userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0 | +| bundleFlags | number | 是 | 用于指定返回abilityInfo信息。取值范围：参考[BundleFlag说明](#bundleflag)中Ability信息相关flag。 | +| userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | **返回值：** @@ -1237,6 +1390,7 @@ queryAbilityByWant(want: Want, bundleFlags: number, userId: number, callback: As **需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +
获取调用方自己的信息时不需要权限。 **系统能力：** @@ -1247,8 +1401,8 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | want | [Want](js-apis-application-Want.md) | 是 | 指示包含要查询的应用程序包名称的意图。 | -| bundleFlags | number | 是 | 用于指定返回abilityInfo信息。默认值：0，取值范围：参考[BundleFlag说明](#bundleflag)中Ability信息相关flag | -| userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0 | +| bundleFlags | number | 是 | 用于指定返回abilityInfo信息。默认值：0，取值范围：参考[BundleFlag说明](#bundleflag)中Ability信息相关flag。 | +| userId | number | 是 | 用户ID。取值范围：大于等于0。 | | callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数，返回Ability信息。 | **示例：** @@ -1280,6 +1434,7 @@ queryAbilityByWant(want: Want, bundleFlags: number, callback: AsyncCallback获取调用方自己的信息时不需要权限。 **系统能力：** @@ -1290,7 +1445,7 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | want | [Want](js-apis-application-Want.md) | 是 | 指示包含要查询的应用程序包名称的意图。 | -| bundleFlags | number | 是 | 用于指定返回abilityInfo信息。默认值：0，取值范围：参考[BundleFlag说明](#bundleflag)中Ability信息相关flag | +| bundleFlags | number | 是 | 用于指定返回abilityInfo信息。默认值：0，取值范围：参考[BundleFlag说明](#bundleflag)中Ability信息相关flag。 | | callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数，返回Ability信息。 | **示例：** @@ -1467,6 +1622,7 @@ getAbilityIcon(bundleName: string, abilityName: string): Promise\获取调用方自己的信息时不需要权限。 **系统能力：** @@ -1476,8 +1632,8 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ----------- | ---------------------------------------- | ---- | ---------------------------------------- | -| bundleName | string | 是 | 要查询的bundleName。 | -| abilityName | string | 是 | 要查询的abilityName。 | +| bundleName | string | 是 | 要查询的应用包名称。 | +| abilityName | string | 是 | 要查询的ability名称。 | **返回值：** | 类型 | 说明 | @@ -1508,6 +1664,8 @@ getAbilityIcon(bundleName: string, abilityName: string, callback: AsyncCallback\ **需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +
获取调用方自己的信息时不需要权限。 + **系统能力：** @@ -1517,8 +1675,8 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ----------- | ---------------------------------------- | ---- | ---------------------------------------- | -| bundleName | string | 是 | 要查询的bundleName。 | -| abilityName | string | 是 | 要查询的abilityName。 | +| bundleName | string | 是 | 要查询的应用包名。 | +| abilityName | string | 是 | 要查询的Ability组件名。 | | callback | AsyncCallback\ | 是 | 程序启动作为入参的回调函数，返回指定[PixelMap](js-apis-image.md)。 | **示例：** @@ -1542,32 +1700,32 @@ bundle.getAbilityIcon(bundleName, abilityName, (err, data) => { | 名称 | 默认值 | 说明 | | ---------------------------------------- | ---- | ------------------------- | -| 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 | Ability未找到 | -| STATUS_BMS_SERVICE_ERROR | 0x41 | BMS服务错误 | -| STATUS_FAILED_NO_SPACE_LEFT8+ | 0x42 | 设备空间不足 | -| STATUS_GRANT_REQUEST_PERMISSIONS_FAILED8+ | 0x43 | 应用授权失败 | -| STATUS_INSTALL_PERMISSION_DENIED8+ | 0x44 | 安装权限拒绝 | -| STATUS_UNINSTALL_PERMISSION_DENIED8+ | 0x45 | 卸载权限拒绝 | +| 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 | Ability未找到。 | +| STATUS_BMS_SERVICE_ERROR | 0x41 | BMS服务错误。 | +| STATUS_FAILED_NO_SPACE_LEFT8+ | 0x42 | 设备空间不足。 | +| STATUS_GRANT_REQUEST_PERMISSIONS_FAILED8+ | 0x43 | 应用授权失败。 | +| STATUS_INSTALL_PERMISSION_DENIED8+ | 0x44 | 安装权限拒绝。 | +| STATUS_UNINSTALL_PERMISSION_DENIED8+ | 0x45 | 卸载权限拒绝。 | ## BundleFlagdeprecated > 从API version 9开始不再维护，建议使用[bundleManager.BundleFlag](js-apis-bundleManager.md#bundleflag)替代。 -包信息标志，指示需要获取的包信息的内容。由于完整的包信息内容较多，因此使用此标志对返回的包信息内容进行过滤。 +包信息标志，指示需要获取的包信息的内容。 当接口与标志不匹配时，该标志会被忽略，例如获取application时使用GET_ABILITY_INFO_WITH_PERMISSION对结果不会产生影响。 @@ -1575,25 +1733,25 @@ bundle.getAbilityIcon(bundleName, abilityName, (err, data) => { **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework -| 名称 | 默认值 | 说明 | +| 名称 | 值 | 说明 | | ---------------------------------------- | ---------- | ------------------- | -| GET_BUNDLE_DEFAULT | 0x00000000 | 获取默认的应用信息 | -| GET_BUNDLE_WITH_ABILITIES | 0x00000001 | 获取包括Ability信息的包信息 | -| GET_ABILITY_INFO_WITH_PERMISSION | 0x00000002 | 获取包括权限的Ability信息 | -| GET_ABILITY_INFO_WITH_APPLICATION | 0x00000004 | 获取包括应用的Ability信息 | -| GET_APPLICATION_INFO_WITH_PERMISSION | 0x00000008 | 获取包括权限的应用信息 | -| GET_BUNDLE_WITH_REQUESTED_PERMISSION | 0x00000010 | 获取包括所需权限的包信息 | -| GET_ABILITY_INFO_WITH_METADATA8+ | 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 | 获取应用所有的信息 | +| GET_BUNDLE_DEFAULT | 0x00000000 | 获取默认的应用信息。 | +| GET_BUNDLE_WITH_ABILITIES | 0x00000001 | 获取包括Ability信息的包信息。 | +| GET_ABILITY_INFO_WITH_PERMISSION | 0x00000002 | 获取包括权限的Ability信息。 | +| GET_ABILITY_INFO_WITH_APPLICATION | 0x00000004 | 获取包括应用的Ability信息。 | +| GET_APPLICATION_INFO_WITH_PERMISSION | 0x00000008 | 获取包括权限的应用信息。 | +| GET_BUNDLE_WITH_REQUESTED_PERMISSION | 0x00000010 | 获取包括所需权限的包信息。 | +| GET_ABILITY_INFO_WITH_METADATA8+ | 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 | 获取应用所有的信息。 | ## BundleOptionsdeprecated > 从API version 9开始不再维护，不推荐使用。 -包的选项 +查询选项，包含userId。 **系统能力:** SystemCapability.BundleManager.BundleFramework @@ -1605,7 +1763,7 @@ bundle.getAbilityIcon(bundleName, abilityName, (err, data) => { > 从API version 9开始不再维护，建议使用[bundleManager.AbilityType](js-apis-bundleManager.md#abilitytype)替代。 -Ability类型 +Ability组件类型。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework @@ -1620,7 +1778,7 @@ Ability类型 > 从API version 9开始不再维护，建议使用[bundleManager.DisplayOrientation](js-apis-bundleManager.md#displayorientation)替代。 -屏幕显示方向 +屏幕显示方向。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework @@ -1634,50 +1792,50 @@ Ability类型 > 从API version 9开始不再维护，建议使用[bundleManager.LaunchType](js-apis-bundleManager.md#launchtype)替代。 -启动模式 +Ability组件的启动模式。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 说明 | | --------- | ---- | ------------- | -| SINGLETON | 0 | Ability只有一个示例 | -| STANDARD | 1 | Ability有多个示例 | +| SINGLETON | 0 | Ability只有一个实例。 | +| STANDARD | 1 | Ability有多个实例。 | ## AbilitySubTypedeprecated > 从API version 9开始不再维护，不推荐使用。 -Ability的子类型 +Ability组件的子类型。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 说明 | | ----------- | ---- | -------------------- | -| UNSPECIFIED | 0 | 未定义Ability子类型 | -| CA | 1 | Ability子类型是带有 UI 的服务 | +| UNSPECIFIED | 0 | 未定义Ability子类型。 | +| CA | 1 | Ability子类型是带有 UI 的服务。 | ## ColorModedeprecated > 从API version 9开始不再维护，不推荐使用。 -颜色模式 +应用、卡片等的颜色模式。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 说明 | | ---------- | ---- | ---- | -| AUTO_MODE | -1 | 自动模式 | -| DARK_MODE | 0 | 黑色模式 | -| LIGHT_MODE | 1 | 亮度模式 | +| AUTO_MODE | -1 | 自动模式。 | +| DARK_MODE | 0 | 黑色模式。 | +| LIGHT_MODE | 1 | 亮度模式。 | ## GrantStatusdeprecated > 从API version 9开始不再维护，建议使用[bundleManager.PermissionGrantState](js-apis-bundleManager.md#permissiongrantstate)替代。 -授予状态 +权限授予状态。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 说明 | | ------------------ | ---- | ---- | -| PERMISSION_DENIED | -1 | 拒绝许可 | -| PERMISSION_GRANTED | 0 | 批准 | \ No newline at end of file +| PERMISSION_DENIED | -1 | 拒绝许可。 | +| PERMISSION_GRANTED | 0 | 批准许可。 | \ No newline at end of file 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 a5ad926bc4..1ab67c211c 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 @@ -5,7 +5,7 @@ -Ability信息，未做特殊说明的属性，均通过GET_BUNDLE_DEFAULT获取 +Ability信息，未做特殊说明的属性，均通过GET_BUNDLE_DEFAULT获取。 ## AbilityInfo(deprecated) @@ -16,29 +16,29 @@ Ability信息，未做特殊说明的属性，均通过GET_BUNDLE_DEFAULT获取 | 名称 | 类型 | 可读 | 可写 | 说明 | | --------------------- | -------------------------------------------------------- | ---- | ---- | ----------------------------------------- | | bundleName | string | 是 | 否 | 应用包名 | -| name | string | 是 | 否 | Ability名称 | -| label | string | 是 | 否 | Ability对用户显示的名称 | -| description | string | 是 | 否 | Ability的描述 | -| icon | string | 是 | 否 | Ability的图标资源文件索引 | -| descriptionId | number | 是 | 否 | Ability的描述id | -| iconId | number | 是 | 否 | Ability的图标id | -| moduleName | string | 是 | 否 | Ability所属的HAP包的名称 | -| process | string | 是 | 否 | Ability的进程，如果不设置，默认为包的名称 | -| targetAbility | string | 是 | 否 | 当前Ability重用的目标Ability
此属性仅可在FA模型下使用 | -| backgroundModes | number | 是 | 否 | 表示后台服务的类型
此属性仅可在FA模型下使用 | -| isVisible | boolean | 是 | 否 | 判断Ability是否可以被其他应用调用 | -| formEnabled | boolean | 是 | 否 | 判断Ability是否提供卡片能力
此属性仅可在FA模型下使用 | -| type | AbilityType | 是 | 否 | Ability类型
此属性仅可在FA模型下使用 | -| orientation | [DisplayOrientation](js-apis-Bundle.md#deprecatedisplayorientation) | 是 | 否 | Ability的显示模式 | -| launchMode | [LaunchMode](js-apis-Bundle.md#launchmode) | 是 | 否 | Ability的启动模式 | -| permissions | Array\ | 是 | 否 | 被其他应用Ability调用时需要申请的权限集合
通过传入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获取 | -| 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获取 | -| enabled8+ | boolean | 是 | 否 | ability是否可用 | \ No newline at end of file +| name | string | 是 | 否 | Ability名称。 | +| label | string | 是 | 否 | Ability对用户显示的名称。 | +| description | string | 是 | 否 | Ability的描述。 | +| icon | string | 是 | 否 | Ability的图标资源文件索引。 | +| descriptionId | number | 是 | 否 | Ability的描述id。 | +| iconId | number | 是 | 否 | Ability的图标id。 | +| moduleName | string | 是 | 否 | Ability所属的HAP包的名称。 | +| process | string | 是 | 否 | Ability的进程，如果不设置，默认为包的名称。 | +| targetAbility | string | 是 | 否 | 当前Ability重用的目标Ability。
此属性仅可在FA模型下使用。 | +| backgroundModes | number | 是 | 否 | 表示后台服务的类型。
此属性仅可在FA模型下使用。 | +| isVisible | boolean | 是 | 否 | 判断Ability是否可以被其他应用调用。 | +| formEnabled | boolean | 是 | 否 | 判断Ability是否提供卡片能力。
此属性仅可在FA模型下使用。 | +| type | AbilityType | 是 | 否 | Ability类型。
此属性仅可在FA模型下使用。 | +| orientation | [DisplayOrientation](js-apis-Bundle.md#deprecatedisplayorientation) | 是 | 否 | Ability的显示模式。 | +| launchMode | [LaunchMode](js-apis-Bundle.md#launchmodedeprecated) | 是 | 否 | Ability的启动模式。 | +| permissions | Array\ | 是 | 否 | 被其他应用Ability调用时需要申请的权限集合。
通过传入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获取。 | +| 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获取。 | +| enabled8+ | boolean | 是 | 否 | ability是否可用。 | \ No newline at end of file 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 22be837c08..aa20550174 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 @@ -20,12 +20,12 @@ | descriptionId | number | 是 | 否 | 应用程序的描述id。 | | systemApp | boolean | 是 | 否 | 判断是否为系统应用程序，默认为false。 | | enabled | boolean | 是 | 否 | 判断应用程序是否可以使用，默认为true。 | -| label | string | 是 | 否 | 应用程序的标签。 | +| label | string | 是 | 否 | 应用程序显示的标签。 | | labelId(deprecated) | string | 是 | 否 | 应用程序的标签id。
\- **说明：** 从API version 9开始废弃，使用labelIndex。 | | icon | string | 是 | 否 | 应用程序的图标。 | | iconId(deprecated) | string | 是 | 否 | 应用程序的图标id。
\- **说明：** 从API version 9开始废弃，使用iconIndex。 | | process | string | 是 | 否 | 应用程序的进程，如果不设置，默认为包的名称。 | -| supportedModes | number | 是 | 否 | 应用程序支持的运行模式。 | +| supportedModes | number | 是 | 否 | 标识应用支持的运行模式，当前只定义了驾驶模式（drive）。该标签只适用于车机。 | | moduleSourceDirs | Array\ | 是 | 否 | 应用程序的资源存放的相对路径。 | | permissions | Array\ | 是 | 否 | 访问应用程序所需的权限。
通过传入GET_APPLICATION_INFO_WITH_PERMISSION获取 | | moduleInfos | Array\<[ModuleInfo](js-apis-bundle-ModuleInfo.md)> | 是 | 否 | 应用程序的模块信息。 | @@ -35,4 +35,4 @@ | removable8+ | boolean | 是 | 否 | 应用程序是否可以被移除。 | | accessTokenId8+ | number | 是 | 否 | 应用程序的accessTokenId。 | | uid8+ | number | 是 | 否 | 应用程序的uid。 | -| entityType8+ | string | 是 | 否 | 应用程序的实体类型。 | \ No newline at end of file +| entityType8+ | string | 是 | 否 | 该标签标记该应用的类别，具体有 :游戏类(game)，影音类（media）、社交通信类（communication）、新闻类（news）、出行类（travel）、工具类（utility）、购物类（shopping）、教育类（education）、少儿类（kids）、商务类（business）、拍摄类（photography）。 | \ No newline at end of file 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 e70bddfecc..58d3ae685a 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 @@ -35,7 +35,7 @@ | isSilentInstallation | string | 是 | 否 | 是否通过静默安装。 | | minCompatibleVersionCode | number | 是 | 否 | 分布式场景下的应用包兼容的最低版本。 | | entryInstallationFree | boolean | 是 | 否 | Entry是否支持免安装。 | -| reqPermissionStates8+ | Array\ | 是 | 否 | 申请权限的授予状态。 | +| reqPermissionStates8+ | Array\ | 是 | 否 | 申请权限的授予状态。0表示申请成功，-1表示申请失败。 | 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 5c6bd81c3e..f1d0e27d08 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 @@ -3,7 +3,7 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 7 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -在设备上安装、升级和卸载应用 +本模块提供设备上安装、升级和卸载应用的能力。 ## BundleInstaller.install(deprecated) @@ -28,8 +28,8 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | --------------- | ---------------------------------------------------- | ---- | ------------------------------------------------------------ | | bundleFilePaths | Array<string> | 是 | 指示存储hap包的沙箱路径。沙箱路径的获取方法参见[获取应用的沙箱路径](#获取应用的沙箱路径)| -| param | [InstallParam](#installparam) | 是 | 指定安装所需的其他参数。 | -| callback | AsyncCallback<[InstallStatus](#installstatus)> | 是 | 程序启动作为入参的回调函数，返回安装状态信息。 | +| param | [InstallParam](#installparamdeprecated) | 是 | 指定安装所需的其他参数。 | +| callback | AsyncCallback<[InstallStatus](#installstatusdeprecated)> | 是 | 程序启动作为入参的回调函数，返回安装状态信息。 | **示例：** @@ -61,7 +61,7 @@ bundle.getBundleInstaller().then(installer=>{ uninstall(bundleName: string, param: InstallParam, callback: AsyncCallback<InstallStatus>): void; -以异步方法卸载应用程序，使用callback形式返回结果。 +以异步方法卸载应用程序，使用callback异步回调，返回安装状态信息。 **需要权限：** @@ -78,14 +78,14 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ---------- | ---------------------------------------------------- | ---- | ---------------------------------------------- | | bundleName | string | 是 | 包名 | -| param | [InstallParam](#installparam) | 是 | 指定卸载所需的其他参数。 | -| callback | AsyncCallback<[InstallStatus](#installstatus)> | 是 | 程序启动作为入参的回调函数，返回安装状态信息。 | +| param | [InstallParam](#installparamdeprecated) | 是 | 指定卸载所需的其他参数。 | +| callback | AsyncCallback<[InstallStatus](#installstatusdeprecated)> | 是 | 程序启动作为入参的回调函数，返回安装状态信息。 | **示例：** ```ts import bundle from '@ohos.bundle'; -let bundleName = 'com.ohos.demo'; +let bundleName = 'com.example.myapplication'; let installParam = { userId: 100, isKeepData: false, @@ -126,16 +126,16 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 必填 | 描述 | | ---------- | ---------------------------------------------------- | ---- | ---------------------------------------------- | -| bundleName | string | 是 | 包名 | -| param | [InstallParam](#installparam) | 是 | 指定应用恢复所需的其他参数。 | -| callback | AsyncCallback<[InstallStatus](#installstatus)> | 是 | 程序启动作为入参的回调函数，返回应用恢复状态信息。 | +| bundleName | string | 是 | 应用包名。 | +| param | [InstallParam](#installparamdeprecated) | 是 | 指定应用恢复所需的其他参数。 | +| callback | AsyncCallback<[InstallStatus](#installstatusdeprecated)> | 是 | 程序启动作为入参的回调函数，返回应用恢复状态信息。 | **示例：** ```ts import bundle from '@ohos.bundle'; -let bundleName = 'com.ohos.demo'; +let bundleName = 'com.example.myapplication'; let installParam = { userId: 100, isKeepData: false, @@ -157,7 +157,7 @@ bundle.getBundleInstaller().then(installer=>{ ## InstallParam(deprecated) -应用程序安装卸载信息 +安装、恢复或卸载时需要指定的参数。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework @@ -165,14 +165,14 @@ bundle.getBundleInstaller().then(installer=>{ | 名称 | 类型 |可读|可写| 说明 | | ------------------------------ | ------------------------------ | ---- |----|--------------- | -| userId | number | 是|是 |指示用户id，可以通过[账户子系统](js-apis-) | -| installFlag | number | 是|是 |指示安装标志
0表示正常安装
1表示替代原有应用 | -| isKeepData | boolean | 是|是 |指示应用删除后是否保留数据 | +| userId | number | 是|是 |指示用户id。 | +| installFlag | number | 是|是 |指示安装标志
0表示正常安装，1表示替代原有应用。 | +| isKeepData | boolean | 是|是 |指示应用删除后是否保留数据。 | ## InstallStatus(deprecated) -应用程序安装卸载状态 +应用程序安装卸载的结果。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework @@ -180,11 +180,11 @@ bundle.getBundleInstaller().then(installer=>{ | 名称 | 类型 | 可读 | 可写 | 说明 | | ------------- | ------------------------------------------------------------ | ---- | ---- | ------------------------------ | -| status | bundle.[InstallErrorCode](js-apis-Bundle.md#installerrorcode) | 是 | 否 | 表示安装或卸载错误状态码 | -| statusMessage | string | 是 | 否 | 表示安装或卸载的字符串结果信息 | +| status | bundle.[InstallErrorCode](js-apis-Bundle.md#installerrorcode) | 是 | 否 | 表示安装或卸载错误状态码。 | +| statusMessage | string | 是 | 否 | 表示安装或卸载的字符串结果信息。 | ## 获取应用的沙箱路径 -对于FA模型，应用的沙箱路径可以通过[Context](js-apis-Context.md)中的方法获取；对于Stage模型，应用的沙箱路径可以通过[Context](js-apis-ability-context.md#abilitycontext)中的属性获取。 +对于FA模型，应用的沙箱路径可以通过[Context](js-apis-Context.md)中的方法获取；对于Stage模型，应用的沙箱路径可以通过[Context](js-apis-ability-context.md#abilitycontext)中的属性获取。下面以获取沙箱文件路径为例。 **示例：** ``` ts 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 f5063c1739..198808acb3 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 @@ -7,7 +7,7 @@ -自定义元数据 +自定义元数据。 ## CustomizeData @@ -17,6 +17,6 @@ | 名称 | 类型 | 可读 | 可写 | 说明 | | ------------------ | ------ | ---- | ---- | ---------------- | -| name | string | 是 | 是 | 自定义元数据名称 | -| value | string | 是 | 是 | 自定义元数据值 | -| extra8+ | string | 是 | 是 | 自定义资源 | \ No newline at end of file +| name | string | 是 | 是 | 标识自定义数据项的键名称。 | +| value | string | 是 | 是 | 标识自定义数据项的值名称。 | +| extra8+ | string | 是 | 是 | 标识用户自定义数据格式，标签值为标识该数据的资源的索引值。 | \ No newline at end of file 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 fdb7fdbd8a..c1ae92b7f5 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 @@ -7,7 +7,7 @@ -Hap模块信息，未做特殊说明的属性，均通过GET_BUNDLE_DEFAULT获取 +Hap模块信息，未做特殊说明的属性，均通过GET_BUNDLE_DEFAULT获取。 ## HapModuleInfo(deprecated) @@ -19,19 +19,19 @@ Hap模块信息，未做特殊说明的属性，均通过GET_BUNDLE_DEFAULT获 | 名称 | 类型 | 可读 | 可写 | 说明 | | --------------------------------- | ------------------------------------------------------------ | ---- | ---- | -------------------- | -| name | string | 是 | 否 | 模块名称 | -| description | string | 是 | 否 | 模块描述信息 | -| descriptionId | number | 是 | 否 | 描述信息ID | -| icon | string | 是 | 否 | 模块图标 | -| label | string | 是 | 否 | 模块标签 | -| labelId | number | 是 | 否 | 模块标签ID | -| iconId | number | 是 | 否 | 模块图标ID | -| backgroundImg | string | 是 | 否 | 模块背景图片 | -| supportedModes | number | 是 | 否 | 模块支持的模式 | -| reqCapabilities | Array\ | 是 | 否 | 模块运行需要的能力 | -| deviceTypes | Array\ | 是 | 否 | 支持运行的设备类型 | -| abilityInfo | Array\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 是 | 否 | Ability信息 | -| moduleName | string | 是 | 否 | 模块名 | -| mainAbilityName | string | 是 | 否 | 入口Ability名称 | -| installationFree | boolean | 是 | 否 | 是否支持免安装 | +| name | string | 是 | 否 | 模块名称。 | +| description | string | 是 | 否 | 模块描述信息。 | +| descriptionId | number | 是 | 否 | 描述信息ID。 | +| icon | string | 是 | 否 | 模块图标。 | +| label | string | 是 | 否 | 模块标签。 | +| labelId | number | 是 | 否 | 模块标签ID。 | +| iconId | number | 是 | 否 | 模块图标ID。 | +| backgroundImg | string | 是 | 否 | 模块背景图片。 | +| supportedModes | number | 是 | 否 | 模块支持的模式。 | +| reqCapabilities | Array\ | 是 | 否 | 模块运行需要的能力。 | +| deviceTypes | Array\ | 是 | 否 | 支持运行的设备类型。 | +| abilityInfo | Array\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 是 | 否 | Ability信息。 | +| moduleName | string | 是 | 否 | 模块名。 | +| mainAbilityName | string | 是 | 否 | 入口Ability名称。 | +| installationFree | boolean | 是 | 否 | 是否支持免安装。 | 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 6d43d101e9..c27e2b80b8 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 @@ -2,7 +2,7 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 7 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -应用程序的模块信息 +应用程序的模块信息。 ## ModuleInfo(deprecated) > 从API version 9开始不再维护，建议使用[HapModuleInfo](js-apis-bundleManager-hapModuleInfo.md)替代。 @@ -10,5 +10,5 @@ **系统能力**: 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 可读 | 可写 | 说明 | | --------------- | ------ | ---- | ---- | -------- | -| moduleName | string | 是 | 否 | 模块名称 | -| moduleSourceDir | string | 是 | 否 | 安装目录 | \ No newline at end of file +| moduleName | string | 是 | 否 | 模块名称。 | +| moduleSourceDir | string | 是 | 否 | 安装目录。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundle-PermissionDef.md b/zh-cn/application-dev/reference/apis/js-apis-bundle-PermissionDef.md index 83ea268a27..6eb770e3f3 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundle-PermissionDef.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundle-PermissionDef.md @@ -7,7 +7,7 @@ -配置文件中定义的权限详细信息 +配置文件中定义的权限详细信息。 ## **PermissionDef**(deprecated) @@ -19,7 +19,7 @@ | 名称 | 类型 | 可读 | 可写 | 说明 | | -------------- | ------ | ---- | ---- | -------------- | -| permissionName | string | 是 | 否 | 用户权限名称 | -| grantMode | number | 是 | 否 | 权限的授予模式 | -| labelId | number | 是 | 否 | 权限的标签ID | -| descriptionId | number | 是 | 否 | 描述权限的ID | \ No newline at end of file +| permissionName | string | 是 | 否 | 权限名称。 | +| grantMode | number | 是 | 否 | 权限的授予模式，0表示安装后系统自动授予该权限，1表示使用时动态申请，用户授权后方可使用。 | +| labelId | number | 是 | 否 | 权限的标签ID。 | +| descriptionId | number | 是 | 否 | 描述权限的ID。 | \ No newline at end of file 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 f6f6c7f55c..c85219a87b 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 @@ -34,15 +34,15 @@ | 名称 | 类型 | 可读 | 可写 | 说明 | | ----------------------- | ------------------------------------------ | ---- | ---- | ---------------------------- | -| id | string | 是 | 否 | 快捷方式所属应用程序的Id | -| bundleName | string | 是 | 否 | 包含快捷方式的包名称 | -| hostAbility | string | 是 | 否 | 快捷方式的本地Ability信息 | -| icon | string | 是 | 否 | 快捷方式的图标 | -| iconId8+ | number | 是 | 否 | 快捷方式的图标Id | -| label | string | 是 | 否 | 快捷方式的标签 | -| labelId8+ | number | 是 | 否 | 快捷方式的标签Id | -| disableMessage | string | 是 | 否 | 快捷方式的禁用消息 | -| wants | Array<[ShortcutWant](#shortcutwant)> | 是 | 否 | 快捷方式所需要的信息 | -| isStatic | boolean | 是 | 否 | 快捷方式是否为静态 | -| isHomeShortcut | boolean | 是 | 否 | 快捷方式是否为主页面快捷方式 | -| isEnabled | boolean | 是 | 否 | 是否启用快捷方式 | \ No newline at end of file +| id | string | 是 | 否 | 快捷方式所属应用程序的Id。 | +| bundleName | string | 是 | 否 | 包含该快捷方式的包名称。 | +| hostAbility | string | 是 | 否 | 快捷方式的本地Ability信息。 | +| icon | string | 是 | 否 | 快捷方式的图标。 | +| iconId8+ | number | 是 | 否 | 快捷方式的图标Id。 | +| label | string | 是 | 否 | 快捷方式的名称。 | +| labelId8+ | number | 是 | 否 | 快捷方式的名称Id。 | +| disableMessage | string | 是 | 否 | 快捷方式的禁用消息。 | +| wants | Array<[ShortcutWant](#shortcutwant)> | 是 | 否 | 快捷方式意图列表。 | +| isStatic | boolean | 是 | 否 | 快捷方式是否为静态。 | +| isHomeShortcut | boolean | 是 | 否 | 快捷方式是否为主页面快捷方式。 | +| isEnabled | boolean | 是 | 否 | 是否启用快捷方式。 | \ No newline at end of file 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 690b6415c2..9b94acb5cd 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 @@ -7,7 +7,7 @@ -包含基本远程能力信息 +remoteAbility信息。 ## RemoteAbilityInfo(deprecated) @@ -20,6 +20,6 @@ | 名称 | 类型 | 可读 | 可写 | 说明 | | ----------- | -------------------------------------------- | ---- | ---- | ----------------------- | -| elementName | [ElementName](js-apis-bundle-ElementName.md) | 是 | 否 | 指明的ability信息 | -| label | string | 是 | 否 | 指明ability的标签信息 | -| icon | string | 是 | 否 | 指明的ability的图标信息 | +| elementName | [ElementName](js-apis-bundle-ElementName.md) | 是 | 否 | ability元素资源信息。 | +| label | string | 是 | 否 | 指明ability的名称。 | +| icon | string | 是 | 否 | 指明的ability的图标信息。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-defaultAppManager.md b/zh-cn/application-dev/reference/apis/js-apis-defaultAppManager.md index 9cf0762952..f5104884ea 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-defaultAppManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-defaultAppManager.md @@ -13,7 +13,7 @@ import defaultAppMgr from '@ohos.bundle.defaultAppManager'; ``` ## defaultAppMgr.ApplicationType -应用类型 +默认应用的应用类型。 **系统能力：** SystemCapability.BundleManager.BundleFramework.DefaultAppManager @@ -50,7 +50,7 @@ isDefaultApplication(type: string): Promise\ **示例：** -```js +```ts import defaultAppMgr from '@ohos.bundle.defaultAppManager'; defaultAppMgr.isDefaultApplication(defaultAppMgr.ApplicationType.BROWSER) .then((data) => { @@ -77,7 +77,7 @@ isDefaultApplication(type: string, callback: AsyncCallback\): void **示例：** -```js +```ts import defaultAppMgr from '@ohos.bundle.defaultAppManager'; defaultAppMgr.isDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, (err, data) => { if (err) { @@ -123,7 +123,7 @@ getDefaultApplication(type: string, userId?: number): Promise\ **示例：** -```js +```ts import defaultAppMgr from '@ohos.bundle.defaultAppManager'; defaultAppMgr.getDefaultApplication(defaultAppMgr.ApplicationType.BROWSER) .then((data) => { @@ -172,7 +172,7 @@ getDefaultApplication(type: string, userId: number, callback: AsyncCallback\ { @@ -221,7 +221,7 @@ getDefaultApplication(type: string, callback: AsyncCallback\) : void **示例：** -```js +```ts import defaultAppMgr from '@ohos.bundle.defaultAppManager'; defaultAppMgr.getDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, (err, data) => { if (err) { @@ -241,7 +241,9 @@ defaultAppMgr.getDefaultApplication("image/png", (err, data) => { ## defaultAppMgr.setDefaultApplication -setDefaultApplication(type: string, elementName: ElementName, userId?: number): Promise\<**返回值：** +setDefaultApplication(type: string, elementName: ElementName, userId?: number): Promise\ + +**返回值：** | 类型 | 说明 | | ----------------------------------------------------------- | --------------------------- | @@ -281,7 +283,7 @@ setDefaultApplication(type: string, elementName: ElementName, userId?: number): **示例：** -```js +```ts import defaultAppMgr from '@ohos.bundle.defaultAppManager'; defaultAppMgr.setDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, { bundleName: "com.test.app", @@ -346,7 +348,7 @@ setDefaultApplication(type: string, elementName: ElementName, userId: number, ca **示例：** -```js +```ts import defaultAppMgr from '@ohos.bundle.defaultAppManager'; let userId = 100; defaultAppMgr.setDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, { @@ -404,7 +406,7 @@ setDefaultApplication(type: string, elementName: ElementName, callback: AsyncCal **示例：** -```js +```ts import defaultAppMgr from '@ohos.bundle.defaultAppManager'; defaultAppMgr.setDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, { bundleName: "com.test.app", @@ -459,7 +461,7 @@ resetDefaultApplication(type: string, userId?: number): Promise\ **示例：** -```js +```ts import defaultAppMgr from '@ohos.bundle.defaultAppManager'; let userId = 100; defaultAppMgr.resetDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, userId) @@ -508,7 +510,7 @@ resetDefaultApplication(type: string, userId: number, callback: AsyncCallback\ { @@ -556,7 +558,7 @@ resetDefaultApplication(type: string, callback: AsyncCallback\) : void; **示例：** -```js +```ts import defaultAppMgr from '@ohos.bundle.defaultAppManager'; defaultAppMgr.resetDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, (err, data) => { if (err) { diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-package.md b/zh-cn/application-dev/reference/apis/js-apis-system-package.md index b8138d9d98..161d975336 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-package.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-package.md @@ -12,7 +12,7 @@ ``` -import pkg from '@system.package'; +import package from '@system.package'; ``` @@ -30,12 +30,9 @@ hasInstalled(Object): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| bundleName | string | 是 | 应用包名。 | -| success | Function | 否 | 接口调用成功的回调函数。 | -| fail | Function | 否 | 接口调用失败的回调函数。 | -| complete | Function | 否 | 接口调用结束的回调函数。 | +|options | [CheckPackageHasInstalledOptions](#checkpackagehasinstalledoptions) | 是 | 选项参数。 | -success返回值： +**返回值：** | 参数名 | 类型 | 说明 | | -------- | -------- | -------- | @@ -43,18 +40,43 @@ success返回值： **示例：** -``` -export default { - hasInstalled() { - pkg.hasInstalled({ - bundleName: 'com.example.bundlename', - success: function(data) { - console.log('package has installed: ' + data); - }, - fail: function(data, code) { - console.log('query package fail, code: ' + code + ', data: ' + data); - }, - }); +``` ts +export default { + hasInstalled() { + package.hasInstalled({ + bundleName: 'com.example.bundlename', + success: function(data) { + console.log('package has installed: ' + data); + }, + fail: function(data, code) { + console.log('query package fail, code: ' + code + ', data: ' + data); + }, + }); }, } -``` \ No newline at end of file +``` + +## CheckPackageHasInstalledResponse + +> 从API version 9开始不再维护。 + +指示应用包是否已安装。 + +**系统能力:** SystemCapability.BundleManager.BundleFramework。 + +| 名称 | 类型 | 说明 | +| --- | --- | ---- | +| result | boolean | 指示应用是否已安装。 | + +## CheckPackageHasInstalledOptions + +> 从API version 9开始不再维护。 + +查询包是否已安装时的选项。 + +| 名称 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| bundleName | string | 是 | 应用包名。 | +| success | Function | 否 | 接口调用成功的回调函数。 | +| fail | Function | 否 | 接口调用失败的回调函数。 | +| complete | Function | 否 | 接口调用结束的回调函数。 | \ No newline at end of file -- GitLab