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 81c3c912a6b4c70996ab03b054887981b4b257d6..a59ea4588f2dc5c06ddd9951d8e940464e5de875 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 @@ -41,7 +41,7 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------- | | bundleName | string | 是 | 要查询的应用程序包名称。 | -| userId | number | 是 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | +| userId | number | 是 | 用户ID。取值范围:大于等于0。 | | callback | AsyncCallback\> | 是 | 程序启动作为入参的回调函数,返回程序信息。 | @@ -69,7 +69,7 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------ | ---- | ----------------------------------------------------- | | bundleName | string | 是 | 要查询的应用程序包名称。 | -| userId | number | 是 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | +| userId | number | 是 | 用户ID。取值范围:大于等于0。 | **返回值:** @@ -216,7 +216,7 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------- | -| userId | number | 是 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | +| userId | number | 是 | 用户ID。取值范围:大于等于0。 | | callback | AsyncCallback\> | 是 | 程序启动作为入参的回调函数,返回程序信息。 | ## innerBundleManager.getAllLauncherAbilityInfos(deprecated) @@ -242,7 +242,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 23fee9213ef0bd10075ad52e8ef943062029c1ee..e08618dde0caf9ec0becd00a9379a7ef6475591e 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,8 +109,8 @@ SystemCapability.BundleManager.DistributedBundleFramework | 参数名 | 类型 | 必填 | 说明 | | ------------ | ------------------------------------------------------------ | ---- | -------------------------------------------------- | -| elementNames | Array<[ElementName](js-apis-bundle-ElementName.md)> | 是 | ElementName信息,最大数组长度为10 | -| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数,返回远程基本能力信息。 | +| 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 207cfec2689d0a833865827e561429bf9dd58de7..7e369a7644bacb19a5cbd81635950004d42adda4 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-Bundle.md +++ b/zh-cn/application-dev/reference/apis/js-apis-Bundle.md @@ -1,24 +1,24 @@ # Bundle模块(JS端SDK接口) -本模块提供应用信息查询能力,支持BundleInfo、ApplicationInfo、Ability、ExtensionAbility、应用状态等信息的查询 +本模块提供应用信息查询能力,支持[包信息](js-apis-bundle-BundleInfo.md)、[应用信息](js-apis-bundle-ApplicationInfo.md)、[Ability组件信息](js-apis-bundle-AbilityInfo.md)等信息的查询,以及应用禁用状态的查询、设置等。 > **说明:** > > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 ## 导入模块 -```js +```ts import bundle from '@ohos.bundle'; ``` ## 权限列表 -| 权限 | 权限等级 | 描述 | -| ------------------------------------------ | ------------ | ------------------ | -| ohos.permission.GET_BUNDLE_INFO | normal | 查询指定应用信息 | -| ohos.permission.GET_BUNDLE_INFO_PRIVILEGED | system_basic | 可查询所有应用信息 | -| ohos.permission.INSTALL_BUNDLE | system_core | 可安装、卸载应用 | -| ohos.permission.MANAGE_DISPOSED_APP_STATUS | system_core | 可设置和查询应用的处置状态 | +| 权限 | 权限等级 | 描述 | +|--------------------------------------------|--------------|---------------| +| ohos.permission.GET_BUNDLE_INFO | normal | 查询指定应用信息 | +| ohos.permission.GET_BUNDLE_INFO_PRIVILEGED | system_basic | 可查询所有应用信息 | +| ohos.permission.INSTALL_BUNDLE | system_core | 可安装、卸载应用 | +| ohos.permission.MANAGE_DISPOSED_APP_STATUS | system_core | 可设置和查询应用的处置状态 | 权限等级参考[权限等级说明](../../security/accesstoken-overview.md#权限等级说明)。 @@ -28,11 +28,12 @@ import bundle from '@ohos.bundle'; getApplicationInfo(bundleName: string, bundleFlags: number, userId?: number): Promise\ -以异步方法根据给定的包名获取ApplicationInfo,使用Promise形式返回结果。 +以异步方法根据给定的包名获取ApplicationInfo。使用Promise异步回调。 **需要权限:** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +
获取调用方自己的信息时不需要权限。 **系统能力:** @@ -43,7 +44,7 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ----------- | ------ | ---- | ------------------------------------------------------------ | | bundleName | string | 是 | 要查询的应用程序包名称。 | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中应用信息相关flag | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围请参考[BundleFlag说明](#bundleflagdeprecated)中应用信息相关flag。 | | userId | number | 否 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | **返回值:** @@ -54,7 +55,7 @@ SystemCapability.BundleManager.BundleFramework **示例:** -```js +```ts let bundleName = "com.example.myapplication"; let bundleFlags = 0; let userId = 100; @@ -77,6 +78,7 @@ getApplicationInfo(bundleName: string, bundleFlags: number, userId: number, call **需要权限:** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +
获取调用方自己的信息时不需要权限。 **系统能力:** @@ -87,13 +89,13 @@ 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)> | 是 | 程序启动作为入参的回调函数,返回应用程序信息。 | **示例:** -```js +```ts let bundleName = "com.example.myapplication"; let bundleFlags = 0; let userId = 100; @@ -114,10 +116,10 @@ bundle.getApplicationInfo(bundleName, bundleFlags, userId, (err, data) => { getApplicationInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback\): void 以异步方法根据给定的包名获取ApplicationInfo,使用callback形式返回结果。 - **需要权限:** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +获取调用方自己的信息时不需要权限。 **系统能力:** @@ -128,12 +130,12 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | bundleName | string | 是 | 要查询的应用程序包名称。 | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中应用信息相关flag | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中应用信息相关flag | | callback | AsyncCallback\<[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)> | 是 | 程序启动作为入参的回调函数,返回应用程序信息。 | **示例:** -```js +```ts let bundleName = "com.example.myapplication"; let bundleFlags = 0; bundle.getApplicationInfo(bundleName, bundleFlags, (err, data) => { @@ -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 | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag | +| bundleFlag | BundleFlag | 是 | 用于指定返回的包信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag。 | | userId | number | 否 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | **返回值:** @@ -177,7 +179,7 @@ SystemCapability.BundleManager.BundleFramework **示例:** -```js +```ts let bundleFlag = 0; let userId = 100; bundle.getAllBundleInfo(bundleFlag, userId) @@ -195,7 +197,7 @@ bundle.getAllBundleInfo(bundleFlag, userId) getAllBundleInfo(bundleFlag: BundleFlag, callback: AsyncCallback>): void -以异步方法获取系统中所有可用的BundleInfo,使用callback形式返回结果。 +以异步方法获取当前用户所有的BundleInfo,使用callback形式返回结果。 **需要权限:** @@ -209,12 +211,12 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| bundleFlag | BundleFlag | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag | +| bundleFlag | BundleFlag | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag。 | | callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数,返回所有可用的BundleInfo。 | **示例:** -```js +```ts let bundleFlag = 0; bundle.getAllBundleInfo(bundleFlag, (err, data) => { if (err) { @@ -232,7 +234,7 @@ bundle.getAllBundleInfo(bundleFlag, (err, data) => { getAllBundleInfo(bundleFlag: BundleFlag, userId: number, callback: AsyncCallback>): void -以异步方法获取系统中指定用户下所有可用的BundleInfo,使用callback形式返回结果。 +以异步方法获取系统中指定用户下所有的BundleInfo,使用callback形式返回结果。 **需要权限:** @@ -244,15 +246,16 @@ SystemCapability.BundleManager.BundleFramework **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| bundleFlag | BundleFlag | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag | -| userId | number | 是 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | -| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数,返回所有可用的BundleInfo。 | +| 参数名 | 类型 | 必填 | 说明 | +|------------|-------------------------------------------------------------------|-----|---------------------------------------------------------------------| +| bundleFlag | BundleFlag | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag。 | +| userId | number | 是 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | +| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数,返回指定用户下所有包的BundleInfo。 | +| **示例:** -```js +```ts let bundleFlag = 0; let userId = 100; bundle.getAllBundleInfo(bundleFlag, userId, (err, data) => { @@ -271,11 +274,12 @@ bundle.getAllBundleInfo(bundleFlag, userId, (err, data) => { getBundleInfo(bundleName: string, bundleFlags: number, options?: BundleOptions): Promise\ -以异步方法根据给定的包名获取BundleInfo,使用Promise形式返回结果。 +以异步方法根据给定的包名获取BundleInfo,使用Promise异步回调。 **需要权限:** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +获取调用方自己的信息时不需要权限。 **系统能力:** @@ -283,21 +287,21 @@ SystemCapability.BundleManager.BundleFramework **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ----------- | ------------- | ---- | --------------------------------------- | -| bundleName | string | 是 | 包名 | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[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对象,Promise中包含包信息。 | +| Promise\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | Promise对象,获取成功时返回包信息。 | **示例:** -```js +```ts let bundleName = "com.example.myapplication"; let bundleFlags = 1; let options = { @@ -317,11 +321,12 @@ bundle.getBundleInfo(bundleName, bundleFlags, options) getBundleInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback\): void -以异步方法根据给定的包名获取BundleInfo,使用callback形式返回结果。 +以异步方法根据给定的包名获取BundleInfo,使用callback异步回调。 **需要权限:** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +获取调用方自己的信息时不需要权限。 **系统能力:** @@ -329,15 +334,15 @@ SystemCapability.BundleManager.BundleFramework **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ----------- | ---------------------------------------------------------- | ---- | ------------------------------------------------------------ | -| bundleName | string | 是 | 包名 | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag | -| callback | AsyncCallback\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 是 | 程序启动作为入参的回调函数,返回包信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----------- | ---------------------------------------------------------- | ---- |---------------------------------------------------------------------| +| bundleName | string | 是 | 需要查询的应用程序包名称。 | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag。 | +| callback | AsyncCallback\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 是 | 程序启动作为入参的回调函数,返回包信息。 | **示例:** -```js +```ts let bundleName = "com.example.myapplication"; let bundleFlags = 1; bundle.getBundleInfo(bundleName, bundleFlags, (err, data) => { @@ -356,11 +361,12 @@ bundle.getBundleInfo(bundleName, bundleFlags, (err, data) => { getBundleInfo(bundleName: string, bundleFlags: number, options: BundleOptions, callback: AsyncCallback\): void -以异步方法根据给定的包名获取BundleInfo,使用callback形式返回结果。 +以异步方法根据给定的包名获取BundleInfo,使用callback异步回调。 **需要权限:** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +获取调用方自己的信息时不需要权限。 **系统能力:** @@ -371,13 +377,13 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ----------- | ---------------------------------------------------------- | ---- | ------------------------------------------------------------ | | bundleName | string | 是 | 包名 | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag | | options | [BundleOptions](#bundleoptions) | 是 | 包含userid。 | | callback | AsyncCallback\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 是 | 程序启动作为入参的回调函数,返回包信息。 | **示例:** -```js +```ts let bundleName = "com.example.myapplication"; let bundleFlags = 1; let options = { @@ -400,7 +406,7 @@ bundle.getBundleInfo(bundleName, bundleFlags, options, (err, data) => { getBundleInstaller(): Promise<BundleInstaller>; -获取用于安装包的接口 +获取用于安装包的接口,使用Promise异步回调,返回安装接口对象。 **需要权限:** @@ -418,7 +424,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 @@ -426,7 +442,7 @@ SystemCapability.BundleManager.BundleFramework getBundleInstaller(callback: AsyncCallback<BundleInstaller>): void; -获取用于安装包的接口 +获取用于安装包的接口,使用callback异步回调。 **需要权限:** @@ -444,15 +460,26 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------------------ | ---- | ---------------- | -| callback | AsyncCallback<[BundleInstaller](js-apis-bundle-BundleInstaller.md)> | 是 | 安装应用程序包。 | +| 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.cleanBundleCacheFiles8+ deprecated > 从API version 9开始不再维护,建议使用[bundleManager.cleanBundleCacheFiles](js-apis-bundleManager.md#bundlemanagercleanbundlecachefiles)替代。 cleanBundleCacheFiles(bundleName: string, callback: AsyncCallback<void>): void; -清除指定应用程序的缓存数据 +清除指定应用程序的缓存数据,使用callback异步回调。 **需要权限:** @@ -470,8 +497,22 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------- | ---- | ------------------------------------- | -| bundleName | string | 是 | 指示要清除其缓存数据的应用程序包名称. | -| callback | AsyncCallback\ | 是 | 为返回操作结果而调用的回调。 | +| bundleName | string | 是 | 指示要清除其缓存数据的应用程序包名称。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | + +**示例:** + +```ts +let bundleName = "com.example.myapplication"; + +bundle.cleanBundleCacheFiles(bundleName, err => { + if (err) { + console.error('cleanBundleCacheFiles failed.'); + } else { + console.info('cleanBundleCacheFiles successfully.'); + } +}); +``` ## bundle.cleanBundleCacheFiles8+ deprecated @@ -479,7 +520,7 @@ SystemCapability.BundleManager.BundleFramework cleanBundleCacheFiles(bundleName: string): Promise<void> -清除指定应用程序的缓存数据 +清除指定应用程序的缓存数据,使用Promise异步回调。 **需要权限:** @@ -497,13 +538,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.setApplicationEnabled8+ deprecated @@ -511,7 +564,7 @@ SystemCapability.BundleManager.BundleFramework setApplicationEnabled(bundleName: string, isEnable: boolean, callback: AsyncCallback<void>): void; -设置是否启用指定的应用程序 +设置是否启用指定的应用程序,使用callback异步回调。 **需要权限:** @@ -527,11 +580,25 @@ SystemCapability.BundleManager.BundleFramework **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------------------- | ---- | ----------------------------------------------- | -| bundleName | string | 是 | 应用程序包名称。 | -| isEnable | boolean | 是 | 指定是否启用应用程序。true表示启用,false禁用。 | -| callback | AsyncCallback\ | 是 | 为返回操作结果而调用的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------------------- | ---- |--------------------------------| +| bundleName | string | 是 | 指示需要启用或禁用的应用程序包名称。 | +| 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.setApplicationEnabled8+ deprecated @@ -539,7 +606,7 @@ SystemCapability.BundleManager.BundleFramework setApplicationEnabled(bundleName: string, isEnable: boolean): Promise<void> -设置是否启用指定的应用程序 +设置是否启用指定的应用程序,使用Promise异步回调。 **需要权限:** @@ -555,16 +622,28 @@ SystemCapability.BundleManager.BundleFramework **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------- | ---- | ----------------------------------------------- | -| bundleName | string | 是 | 应用程序包名称。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------- | ---- |------------------------------| +| bundleName | string | 是 | 指示需要启用或禁用的应用程序包名称。 | | isEnable | boolean | 是 | 指定是否启用应用程序。true表示启用,false禁用。 | **返回值:** | 类型 | 说明 | | ------------- | ------------------------------------ | -| 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.setAbilityEnabled8+ deprecated @@ -572,7 +651,7 @@ SystemCapability.BundleManager.BundleFramework setAbilityEnabled(info: AbilityInfo, isEnable: boolean, callback: AsyncCallback<void>): void; -设置是否启用指定的功能 +设置是否启用指定的Ability组件,使用callback异步回调。 **需要权限:** @@ -590,7 +669,7 @@ 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\ | 是 | 为返回操作结果而调用的回调。 | @@ -600,7 +679,7 @@ SystemCapability.BundleManager.BundleFramework setAbilityEnabled(info: AbilityInfo, isEnable: boolean): Promise<void> -设置是否启用指定的功能 +设置是否启用指定的Ability组件,使用Promise异步回调。 **需要权限:** @@ -618,22 +697,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.getPermissionDef8+ deprecated > 从API version 9开始不再维护,建议使用[bundleManager.getPermissionDef](js-apis-bundleManager.md#bundlemanagergetpermissiondef)替代。 getPermissionDef(permissionName: string, callback: AsyncCallback<PermissionDef>): void; -按权限名称获取权限的详细信息 +按权限名称获取权限的详细信息,使用callback异步回调。 **需要权限:** @@ -651,16 +752,29 @@ 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.getPermissionDef8+ deprecated > 从API version 9开始不再维护,建议使用[bundleManager.getPermissionDef](js-apis-bundleManager.md#bundlemanagergetpermissiondef)替代。 getPermissionDef(permissionName: string): Promise<PermissionDef> -按权限名称获取权限的详细信息 +按权限名称获取权限的详细信息,使用promise异步回调。。 **需要权限:** @@ -678,14 +792,24 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------ | ---- | ---------------- | -| permissionName | string | 是 | 指定权限的名称。 | +| permissionName | string | 是 | 需要查询的权限的名称。 | **返回值:** | 类型 | 说明 | | ------------------------------------------------------ | ------------------------------------------------------ | -| Promise<[PermissionDef](js-apis-bundle-PermissionDef)> | 返回值为Promise对象,Promise中包含定义的权限信息对象。 | +| Promise<[PermissionDef](js-apis-bundle-PermissionDef)> | Promise对象,获取成功时返回权限详细信息。 | + +**示例:** +```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 @@ -693,7 +817,7 @@ SystemCapability.BundleManager.BundleFramework getAllApplicationInfo(bundleFlags: number, userId?: number): Promise> -获取指定用户下所有已安装的应用信息,通过Promise获取返回值。 +获取指定用户下所有已安装的应用信息,使用promise异步回调。 **需要权限:** @@ -707,18 +831,18 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ----------- | ------ | ---- | ------------------------------------------------------------ | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中应用信息相关flag | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中应用信息相关flag。 | | userId | number | 否 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | **返回值:** | 类型 | 说明 | | -------------------------------- | ------------------------------- | -| Promise> | 返回值为Promise对象,Promise中包含应用信息列表。 | +| Promise> | Promise对象,获取成功时返回应用信息列表。 | **示例:** -```js +```ts let bundleFlags = 8; let userId = 100; bundle.getAllApplicationInfo(bundleFlags, userId) @@ -735,7 +859,7 @@ bundle.getAllApplicationInfo(bundleFlags, userId) getAllApplicationInfo(bundleFlags: number, userId: number, callback: AsyncCallback>): void -获取指定用户下所有已安装的应用信息,使用callback形式返回结果。 +获取指定用户下所有已安装的应用信息,使用callback异步回调。 **需要权限:** @@ -749,14 +873,14 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中应用信息相关flag | -| userId | number | 是 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中应用信息相关flag。 | +| userId | number | 否 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | | callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数,返回应用信息列表。 | **示例:** -```js -let bundleFlags = 8; +```ts +let bundleFlags = bundle.BundleFlag.GET_APPLICATION_INFO_WITH_PERMISSION; let userId = 100; bundle.getAllApplicationInfo(bundleFlags, userId, (err, data) => { if (err) { @@ -774,7 +898,7 @@ bundle.getAllApplicationInfo(bundleFlags, userId, (err, data) => { getAllApplicationInfo(bundleFlags: number, callback: AsyncCallback>) : void; -获取所有已安装的应用信息,使用callback形式返回结果。 +获取所有已安装的应用信息,使用callback异步回调。 **需要权限:** @@ -788,13 +912,13 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中应用信息相关flag | +| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中应用信息相关flag。 | | callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数,返回应用信息列表。 | **示例:** -```js -let bundleFlags = 8; +```ts +let bundleFlags = bundle.BundleFlag.GET_APPLICATION_INFO_WITH_PERMISSION; bundle.getAllApplicationInfo(bundleFlags, (err, data) => { if (err) { console.error('Operation failed. Cause: ' + JSON.stringify(err)); @@ -810,7 +934,7 @@ bundle.getAllApplicationInfo(bundleFlags, (err, data) => { getBundleArchiveInfo(hapFilePath: string, bundleFlags: number) : Promise\ -以异步方法获取有关HAP包中包含的应用程序包的信息,使用Promise形式返回结果。 +获取有关HAP包中包含的应用程序包的信息,使用Promise形式返回结果。 **系统能力:** @@ -820,8 +944,8 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------ | ---- | ------------ | -| hapFilePath | string | 是 | HAP存放路径。路径应指向当前应用程序的数据目录的相对目录。 | -| bundleFlags | number | 是 | 用于指定要返回的BundleInfo对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag | +| hapFilePath | string | 是 | HAP存放路径。支持当前应用程序的绝对路径和数据目录沙箱路径。 | +| bundleFlags | number | 是 | 用于指定要返回的BundleInfo对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag。 | **返回值:** | 类型 | 说明 | @@ -830,8 +954,8 @@ SystemCapability.BundleManager.BundleFramework **示例:** -```js -let hapFilePath = "/data/xxx/test.hap"; +```ts +let hapFilePath = "/data/storage/el2/base/test.hap"; let bundleFlags = 0; bundle.getBundleArchiveInfo(hapFilePath, bundleFlags) .then((data) => { @@ -857,14 +981,14 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------ | ---- | ------------ | -| hapFilePath | string | 是 | HAP存放路径。路径应指向当前应用程序的数据目录的相对目录。 | -| bundleFlags | number | 是 | 用于指定要返回的BundleInfo对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag | +| hapFilePath | string | 是 | HAP存放路径,支持当前应用程序的绝对路径和数据目录沙箱路径。 | +| bundleFlags | number | 是 | 用于指定要返回的BundleInfo对象中包含信息的标记。取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag。 | | callback| AsyncCallback\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 是 | 程序启动作为入参的回调函数,返回HAP包中包含的应用程序包的信息。| **示例:** -```js -let hapFilePath = "/data/xxx/test.hap"; +```ts +let hapFilePath = "/data/storage/el2/base/test.hap"; let bundleFlags = 0; bundle.getBundleArchiveInfo(hapFilePath, bundleFlags, (err, data) => { if (err) { @@ -882,11 +1006,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 +
获取调用方自己的信息时不需要权限。 **系统能力:** @@ -894,10 +1019,10 @@ SystemCapability.BundleManager.BundleFramework **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ----------- | ------ | ---- | ---------------- | -| bundleName | string | 是 | 应用程序包名。 | -| abilityName | string | 是 | Ability名称。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----------- | ------ | ---- |------------| +| bundleName | string | 是 | 应用程序包名称。 | +| abilityName | string | 是 | Ability组件名称。 | **返回值:** @@ -907,7 +1032,7 @@ SystemCapability.BundleManager.BundleFramework **示例:** -```js +```ts let bundleName = "com.example.myapplication"; let abilityName = "com.example.myapplication.MainAbility"; bundle.getAbilityInfo(bundleName, abilityName) @@ -924,11 +1049,12 @@ bundle.getAbilityInfo(bundleName, abilityName) getAbilityInfo(bundleName: string, abilityName: string, callback: AsyncCallback\): void; -通过包名称和abilityName获取Ability信息,使用callback形式返回结果。 +通过包名称和组件名获取Ability组件信息,使用callback形式返回结果。 **需要权限:** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +
获取调用方自己的信息时不需要权限。 **系统能力:** @@ -936,15 +1062,15 @@ SystemCapability.BundleManager.BundleFramework **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ----------- | ------------ | ---- | ---------------- | -| bundleName | string | 是 | 应用程序包名。 | -| abilityName | string | 是 | Ability名称。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----------- | ------------ | ---- |----------------------------| +| bundleName | string | 是 | 应用程序包名称。 | +| abilityName | string | 是 | Ability名称。 | | callback | AsyncCallback\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 是 | 程序启动作为入参的回调函数,返回Ability信息。 | **示例:** -```js +```ts let bundleName = "com.example.myapplication"; let abilityName = "com.example.myapplication.MainAbility"; bundle.getAbilityInfo(bundleName, abilityName, (err, data) => { @@ -962,11 +1088,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 +
获取调用方自己的信息时不需要权限。 **系统能力:** @@ -974,10 +1101,10 @@ SystemCapability.BundleManager.BundleFramework **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ----------- | ------ | ---- | ---------------- | -| bundleName | string | 是 | 应用程序包名。 | -| abilityName | string | 是 | Ability名称。 | +| 参数名 | 类型 | 必填 | 说明 | +|-------------|--------|-----|------------| +| bundleName | string | 是 | 应用程序包名称。 | +| abilityName | string | 是 | Ability名称。 | **返回值:** @@ -987,7 +1114,7 @@ SystemCapability.BundleManager.BundleFramework **示例:** -```js +```ts let bundleName = "com.example.myapplication"; let abilityName = "com.example.myapplication.MainAbility"; bundle.getAbilityLabel(bundleName, abilityName) @@ -1004,11 +1131,12 @@ bundle.getAbilityLabel(bundleName, abilityName) getAbilityLabel(bundleName: string, abilityName: string, callback : AsyncCallback\): void -通过包名称和abilityName获取应用名称,使用callback形式返回结果。 +通过包名称和Ability组件名获取应用名称,使用callback形式返回结果。 **需要权限:** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +
获取调用方自己的信息时不需要权限。 **系统能力:** @@ -1016,15 +1144,15 @@ SystemCapability.BundleManager.BundleFramework **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ----------- | ---------------------- | ---- | ---------------- | -| bundleName | string | 是 | 应用程序包名。 | -| abilityName | string | 是 | Ability名称。 | -| callback | AsyncCallback\ | 是 | 程序启动作为入参的回调函数,返回应用名称信息。 | +| 参数名 | 类型 | 必填 | 说明 | +|-------------|------------------------|-----|-------------------------| +| bundleName | string | 是 | 应用程序包名称。 | +| abilityName | string | 是 | Ability名称。 | +| callback | AsyncCallback\ | 是 | 程序启动作为入参的回调函数,返回应用名称信息。 | **示例:** -```js +```ts let bundleName = "com.example.myapplication"; let abilityName = "com.example.myapplication.MainAbility"; bundle.getAbilityLabel(bundleName, abilityName, (err, data) => { @@ -1062,7 +1190,7 @@ SystemCapability.BundleManager.BundleFramework **示例:** -```js +```ts let bundleName = "com.example.myapplication"; let abilityName = "com.example.myapplication.MainAbility"; bundle.getAbilityInfo(bundleName, abilityName).then((abilityInfo)=>{ @@ -1095,7 +1223,7 @@ SystemCapability.BundleManager.BundleFramework **示例:** -```js +```ts let bundleName = "com.example.myapplication"; let abilityName = "com.example.myapplication.MainAbility"; bundle.getAbilityInfo(bundleName, abilityName).then((abilityInfo)=>{ @@ -1135,7 +1263,7 @@ SystemCapability.BundleManager.BundleFramework **示例:** -```js +```ts let bundleName = "com.example.myapplication"; bundle.isApplicationEnabled(bundleName) .then((data) => { @@ -1166,7 +1294,7 @@ SystemCapability.BundleManager.BundleFramework **示例:** -```js +```ts let bundleName = "com.example.myapplication"; bundle.isApplicationEnabled(bundleName, (err, data) => { if (err) { @@ -1183,11 +1311,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 +1327,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信息。取值范围:参考[BundleFlag说明](#bundleflag)中Ability信息相关flag。 | +| userId | number | 否 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | **返回值:** @@ -1209,7 +1338,7 @@ SystemCapability.BundleManager.BundleFramework **示例:** -```js +```ts let bundleFlags = 0; let userId = 100; let want = { @@ -1237,6 +1366,7 @@ queryAbilityByWant(want: Want, bundleFlags: number, userId: number, callback: As **需要权限:** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +
获取调用方自己的信息时不需要权限。 **系统能力:** @@ -1244,16 +1374,16 @@ SystemCapability.BundleManager.BundleFramework **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| want | [Want](js-apis-application-Want.md) | 是 | 指示包含要查询的应用程序包名称的意图。 | -| bundleFlags | number | 是 | 用于指定返回abilityInfo信息。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中Ability信息相关flag | -| userId | number | 是 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0 | -| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数,返回Ability信息。 | +| 参数名 | 类型 | 必填 | 说明 | +|-------------|---------------------------------------------------------------------|-----|-------------------------------------------------------------------------| +| want | [Want](js-apis-application-Want.md) | 是 | 指示包含要查询的应用程序包名称的意图。 | +| bundleFlags | number | 是 | 用于指定返回abilityInfo信息。取值范围:参考[BundleFlag说明](#bundleflag)中Ability信息相关flag。 | +| userId | number | 是 | 用户ID。取值范围:大于等于0。 | +| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数,返回Ability信息。 | **示例:** -```js +```ts let bundleFlags = 0; let userId = 100; let want = { @@ -1280,6 +1410,7 @@ queryAbilityByWant(want: Want, bundleFlags: number, callback: AsyncCallback获取调用方自己的信息时不需要权限。 **系统能力:** @@ -1287,15 +1418,15 @@ SystemCapability.BundleManager.BundleFramework **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| want | [Want](js-apis-application-Want.md) | 是 | 指示包含要查询的应用程序包名称的意图。 | -| bundleFlags | number | 是 | 用于指定返回abilityInfo信息。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中Ability信息相关flag | -| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数,返回Ability信息。 | +| 参数名 | 类型 | 必填 | 说明 | +|-------------|---------------------------------------------------------------------|-----|-------------------------------------------------------------------------| +| want | [Want](js-apis-application-Want.md) | 是 | 指示包含要查询的应用程序包名称的意图。 | +| bundleFlags | number | 是 | 用于指定返回abilityInfo信息。取值范围:参考[BundleFlag说明](#bundleflag)中Ability信息相关flag。 | +| callback | AsyncCallback> | 是 | 程序启动作为入参的回调函数,返回Ability信息。 | **示例:** -```js +```ts let bundleFlags = 0; let want = { bundleName : "com.example.myapplication", @@ -1341,7 +1472,7 @@ SystemCapability.BundleManager.BundleFramework **示例:** -```js +```ts let bundleName = "com.example.myapplication"; bundle.getLaunchWantForBundle(bundleName) .then((data) => { @@ -1376,7 +1507,7 @@ SystemCapability.BundleManager.BundleFramework **示例:** -```js +```ts let bundleName = "com.example.myapplication"; bundle.getLaunchWantForBundle(bundleName, (err, data) => { if (err) { @@ -1409,11 +1540,11 @@ SystemCapability.BundleManager.BundleFramework **返回值:** | 类型 | 说明 | | ---------------- | --------------------------------- | -| Promise\ | 返回值为Promise对象,Promise中包含指定uid的包名。 | +| Promise\ | 返回值为Promise对象,Promise中包含指定uid的包名称。 | **示例:** -```js +```ts let uid = 20010005; bundle.getNameForUid(uid) .then((data) => { @@ -1437,14 +1568,14 @@ SystemCapability.BundleManager.BundleFramework **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------- | ---- | ----------------------------------------------- | -| uid | number | 是 | 要查询的uid。 | -| callback | AsyncCallback\ | 是 | 程序启动作为入参的回调函数,返回指定uid的包名。 | +| 参数名 | 类型 | 必填 | 说明 | +|----------|------------------------|-----|----------------------------| +| uid | number | 是 | 要查询的uid。 | +| callback | AsyncCallback\ | 是 | 程序启动作为入参的回调函数,返回指定uid的包名称。 | **示例:** -```js +```ts let uid = 20010005; bundle.getNameForUid(uid, (err, data) => { if (err) { @@ -1467,6 +1598,7 @@ getAbilityIcon(bundleName: string, abilityName: string): Promise\获取调用方自己的信息时不需要权限。 **系统能力:** @@ -1474,10 +1606,10 @@ SystemCapability.BundleManager.BundleFramework **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ----------- | ------ | ---- | --------------------- | -| bundleName | string | 是 | 要查询的bundleName。 | -| abilityName | string | 是 | 要查询的abilityName。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----------- | ------ | ---- |-----------------| +| bundleName | string | 是 | 要查询的应用包名。 | +| abilityName | string | 是 | 要查询的Ability组件名。 | **返回值:** | 类型 | 说明 | @@ -1486,7 +1618,7 @@ SystemCapability.BundleManager.BundleFramework **示例:** -```js +```ts let bundleName = "com.example.myapplication"; let abilityName = "com.example.myapplication.MainAbility"; bundle.getAbilityIcon(bundleName, abilityName) @@ -1508,6 +1640,8 @@ getAbilityIcon(bundleName: string, abilityName: string, callback: AsyncCallback\ **需要权限:** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO +
获取调用方自己的信息时不需要权限。 + **系统能力:** @@ -1515,15 +1649,15 @@ SystemCapability.BundleManager.BundleFramework **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ----------- | ---------------------------------------- | ---- | ---------------------------------------- | -| bundleName | string | 是 | 要查询的bundleName。 | -| abilityName | string | 是 | 要查询的abilityName。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----------- | ---------------------------------------- | ---- |-------------------------------------------------| +| bundleName | string | 是 | 要查询的应用包名称。 | +| abilityName | string | 是 | 要查询的Ability组件名。 | | callback | AsyncCallback\ | 是 | 程序启动作为入参的回调函数,返回指定[PixelMap](js-apis-image.md)。 | **示例:** -```js +```ts let bundleName = "com.example.myapplication"; let abilityName = "com.example.myapplication.MainAbility"; bundle.getAbilityIcon(bundleName, abilityName, (err, data) => { @@ -1567,7 +1701,11 @@ bundle.getAbilityIcon(bundleName, abilityName, (err, data) => { > 从API version 9开始不再维护,建议使用[bundleManager.BundleFlag](js-apis-bundleManager.md#bundleflag)替代。 -包的标志 +包信息标志,指示需要获取的包信息的内容。 + +当接口与标志不匹配时,该标志会被忽略,例如获取application时使用GET_ABILITY_INFO_WITH_PERMISSION对结果不会产生影响。 + +标志可以叠加使用,例如使用GET_APPLICATION_INFO_WITH_PERMISSION + GET_APPLICATION_INFO_WITH_DISABLE可以使结果同时包含应用权限信息和被禁用的应用信息。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework @@ -1589,7 +1727,7 @@ bundle.getAbilityIcon(bundleName, abilityName, (err, data) => { ## BundleOptionsdeprecated > 从API version 9开始不再维护,不推荐使用。 -包的选项 +查询选项,包含userId。 **系统能力:** SystemCapability.BundleManager.BundleFramework @@ -1601,7 +1739,7 @@ bundle.getAbilityIcon(bundleName, abilityName, (err, data) => { > 从API version 9开始不再维护,建议使用[bundleManager.AbilityType](js-apis-bundleManager.md#abilitytype)替代。 -Ability类型 +Ability组件类型。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework @@ -1616,7 +1754,7 @@ Ability类型 > 从API version 9开始不再维护,建议使用[bundleManager.DisplayOrientation](js-apis-bundleManager.md#displayorientation)替代。 -屏幕显示方向 +屏幕显示方向。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework @@ -1630,7 +1768,7 @@ Ability类型 > 从API version 9开始不再维护,建议使用[bundleManager.LaunchType](js-apis-bundleManager.md#launchtype)替代。 -启动模式 +Ability组件的启动模式。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework @@ -1642,7 +1780,7 @@ Ability类型 ## AbilitySubTypedeprecated > 从API version 9开始不再维护,不推荐使用。 -Ability的子类型 +Ability组件的子类型。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework @@ -1654,7 +1792,7 @@ Ability的子类型 ## ColorModedeprecated > 从API version 9开始不再维护,不推荐使用。 -颜色模式 +应用、卡片等的颜色模式。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework @@ -1669,11 +1807,11 @@ Ability的子类型 > 从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_GRANTED | 0 | 授予权限 | 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 7de063bca0d78be314e1cf0260748efe23ab532d..57eb7b6fe0438a5fdc51359fcbc6ee255c13ff2f 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) @@ -13,32 +13,32 @@ Ability信息,未做特殊说明的属性,均通过GET_BUNDLE_DEFAULT获取 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework -| 名称 | 类型 | 可读 | 可写 | 说明 | -| --------------------- | -------------------------------------------------------- | ---- | ---- | ------------------------------------------------------------ | -| 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 | bundle.AbilityType | 是 | 否 | Ability类型
此属性仅可在FA模型下使用 | -| orientation | bundle.DisplayOrientation | 是 | 否 | Ability的显示模式 | -| launchMode | bundle.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 | bundle.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 +| 名称 | 类型 | 可读 | 可写 | 说明 | +| --------------------- | -------------------------------------------------------- | ---- | ---- | ----------------------------------------- | +| 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#displayorientationdeprecated) | 是 | 否 | 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是否可用。 | 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 22be837c08a46a449ff5c101abe1b8965c44e667..c33dd49ed9e6e67f0d03b50da25407c8adaa8ce6 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 @@ -13,26 +13,26 @@ -| 名称 | 类型 | 可读 | 可写 | 说明 | -| -------------------------- | ------------------------------------------------------------ | ---- | ---- | ------------------------------------------------------------ | -| name | string | 是 | 否 | 应用程序的名称。 | -| description | string | 是 | 否 | 应用程序的描述。 | -| descriptionId | number | 是 | 否 | 应用程序的描述id。 | -| systemApp | boolean | 是 | 否 | 判断是否为系统应用程序,默认为false。 | -| enabled | boolean | 是 | 否 | 判断应用程序是否可以使用,默认为true。 | -| label | string | 是 | 否 | 应用程序的标签。 | -| labelId(deprecated) | string | 是 | 否 | 应用程序的标签id。
\- **说明:** 从API version 9开始废弃,使用labelIndex。 | -| icon | string | 是 | 否 | 应用程序的图标。 | -| iconId(deprecated) | string | 是 | 否 | 应用程序的图标id。
\- **说明:** 从API version 9开始废弃,使用iconIndex。 | -| process | string | 是 | 否 | 应用程序的进程,如果不设置,默认为包的名称。 | -| supportedModes | number | 是 | 否 | 应用程序支持的运行模式。 | -| moduleSourceDirs | Array\ | 是 | 否 | 应用程序的资源存放的相对路径。 | -| permissions | Array\ | 是 | 否 | 访问应用程序所需的权限。
通过传入GET_APPLICATION_INFO_WITH_PERMISSION获取 | -| moduleInfos | Array\<[ModuleInfo](js-apis-bundle-ModuleInfo.md)> | 是 | 否 | 应用程序的模块信息。 | -| entryDir | string | 是 | 否 | 应用程序的文件保存路径。 | -| codePath8+ | string | 是 | 否 | 应用程序的安装目录。 | -| metaData8+ | Map\> | 是 | 否 | 应用程序的自定义元信息。
通过传入GET_APPLICATION_INFO_WITH_METADATA获取 | -| removable8+ | boolean | 是 | 否 | 应用程序是否可以被移除。 | -| accessTokenId8+ | number | 是 | 否 | 应用程序的accessTokenId。 | -| uid8+ | number | 是 | 否 | 应用程序的uid。 | -| entityType8+ | string | 是 | 否 | 应用程序的实体类型。 | \ No newline at end of file +| 名称 | 类型 | 可读 | 可写 | 说明 | +|----------------------------|------------------------------------------------------------------------|-----|-----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| name | string | 是 | 否 | 应用程序的名称。 | +| description | string | 是 | 否 | 应用程序的描述。 | +| descriptionId | number | 是 | 否 | 应用程序的描述id。 | +| systemApp | boolean | 是 | 否 | 判断是否为系统应用程序,默认为false。 | +| enabled | boolean | 是 | 否 | 判断应用程序是否可以使用,默认为true。 | +| label | string | 是 | 否 | 应用程序显示的标签。 | +| labelId | string | 是 | 否 | 应用程序的标签id。 | +| icon | string | 是 | 否 | 应用程序的图标。 | +| iconId | string | 是 | 否 | 应用程序的图标id。 | +| process | string | 是 | 否 | 应用程序的进程,如果不设置,默认为包的名称。 | +| supportedModes | number | 是 | 否 | 标识应用支持的运行模式,当前只定义了驾驶模式(drive)。该标签只适用于车机。 | +| moduleSourceDirs | Array\ | 是 | 否 | 应用程序的资源存放的相对路径。 | +| permissions | Array\ | 是 | 否 | 访问应用程序所需的权限。
通过传入GET_APPLICATION_INFO_WITH_PERMISSION获取 | +| moduleInfos | Array\<[ModuleInfo](js-apis-bundle-ModuleInfo.md)> | 是 | 否 | 应用程序的模块信息。 | +| entryDir | string | 是 | 否 | 应用程序的文件保存路径。 | +| codePath8+ | string | 是 | 否 | 应用程序的安装目录。 | +| metaData8+ | Map\> | 是 | 否 | 应用程序的自定义元信息。
通过传入GET_APPLICATION_INFO_WITH_METADATA获取 | +| removable8+ | boolean | 是 | 否 | 应用程序是否可以被移除。 | +| accessTokenId8+ | number | 是 | 否 | 应用程序的accessTokenId。 | +| uid8+ | number | 是 | 否 | 应用程序的uid。 | +| 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 e70bddfecca21131c06e4189a1f8716b609a2290..58d3ae685a5213ecb0cea0e12d82d167d5d10a07 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 eed36b5c390982d6146d05e43a6b9e4a26eb223b..38ebab31dbe9b6a62a18a0c3384a5cc5de9b6a7b 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) @@ -11,7 +11,7 @@ install(bundleFilePaths: Array<string>, param: InstallParam, callback: AsyncCallback<InstallStatus>): void; -以异步方法在HAP中安装应用程序,使用callback形式返回结果。 +以异步方法在应用中安装hap,支持多hap安装。使用callback形式返回结果。 **需要权限:** @@ -27,9 +27,33 @@ SystemCapability.BundleManager.BundleFramework | 参数名 | 类型 | 必填 | 说明 | | --------------- | ---------------------------------------------------- | ---- | ------------------------------------------------------------ | -| bundleFilePaths | Array<string> | 是 | 指示存储应用程序包的路径。路径应该是当前应用程序的数据目录的相对路径。 | -| param | [InstallParam](#installparam) | 是 | 指定安装所需的其他参数。 | -| callback | AsyncCallback<[InstallStatus](#installstatus)> | 是 | 程序启动作为入参的回调函数,返回安装状态信息。 | +| bundleFilePaths | Array<string> | 是 | 指示存储hap包的沙箱路径。沙箱路径的获取方法参见[获取应用的沙箱路径](#获取应用的沙箱路径)| +| param | [InstallParam](#installparamdeprecated) | 是 | 指定安装所需的其他参数。 | +| callback | AsyncCallback<[InstallStatus](#installstatusdeprecated)> | 是 | 程序启动作为入参的回调函数,返回安装状态信息。 | + +**示例:** + +```ts +import bundle from '@ohos.bundle'; +let hapFilePaths = ['/data/storage/el2/base/haps/entry/files/']; +let installParam = { + userId: 100, + isKeepData: false, + installFlag: 1, +}; + +bundle.getBundleInstaller().then(installer=>{ + installer.install(hapFilePaths, installParam, err => { + if (err) { + console.error('install failed:' + JSON.stringify(err)); + } else { + console.info('install successfully.'); + } + }); +}).catch(error => { + console.error('getBundleInstaller failed. Cause: ' + error.message); +}); +``` ## BundleInstaller.uninstall(deprecated) @@ -37,7 +61,7 @@ SystemCapability.BundleManager.BundleFramework uninstall(bundleName: string, param: InstallParam, callback: AsyncCallback<InstallStatus>): void; -以异步方法卸载应用程序,使用callback形式返回结果。 +以异步方法卸载应用程序,使用callback异步回调,返回安装状态信息。 **需要权限:** @@ -54,16 +78,39 @@ 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.example.myapplication'; +let installParam = { + userId: 100, + isKeepData: false, + installFlag: 1, +}; + +bundle.getBundleInstaller().then(installer=>{ + installer.uninstall(bundleName, installParam, err => { + if (err) { + console.error('uninstall failed:' + JSON.stringify(err)); + } else { + console.info('uninstall successfully.'); + } + }); +}).catch(error => { + console.error('getBundleInstaller failed. Cause: ' + error.message); +}); +``` ## BundleInstaller.recover(deprecated) > 从API version 9开始不再维护,建议使用[recover](js-apis-installer.md)替代。 recover(bundleName: string, param: InstallParam, callback: AsyncCallback<InstallStatus>): void; -以异步方法恢复一个应用程序,使用callback形式返回结果。 +以异步方法恢复一个应用程序,使用callback形式返回结果。当预置应用被卸载后,可以通过此接口进行恢复。 **需要权限:** @@ -79,13 +126,38 @@ 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.example.myapplication'; +let installParam = { + userId: 100, + isKeepData: false, + installFlag: 1, +}; + +bundle.getBundleInstaller().then(installer=>{ + installer.recover(bundleName, installParam, err => { + if (err) { + console.error('recover failed:' + JSON.stringify(err)); + } else { + console.info('recover successfully.'); + } + }); +}).catch(error => { + console.error('getBundleInstaller failed. Cause: ' + error.message); +}); +``` ## InstallParam(deprecated) -应用程序安装卸载信息 +安装、恢复或卸载时需要指定的参数。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework @@ -99,7 +171,7 @@ SystemCapability.BundleManager.BundleFramework ## InstallStatus(deprecated) -应用程序安装状态 +应用程序安装卸载的结果。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework @@ -107,5 +179,29 @@ SystemCapability.BundleManager.BundleFramework | 名称 | 类型 | 可读 | 可写 | 说明 | | ------------- | ------------------------------------------------------------ | ---- | ---- | ------------------------------ | -| 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)中的属性获取。下面以获取沙箱文件路径为例。 + +**示例:** +``` ts +// Stage模型 +import Ability from '@ohos.application.Ability'; +class MainAbility extends Ability { + onWindowStageCreate(windowStage) { + let context = this.context; + let pathDir = context.filesDir; + console.info('sandbox path is ' + pathDir); + } +} + +// FA模型 +import featureAbility from '@ohos.ability.featureAbility'; +let context = featureAbility.getContext(); +context.getFilesDir().then((data) => { + let pathDir = data; + console.info('sandbox path is ' + pathDir); +}); +``` \ No newline at end of file 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 e297e63577d9efca95f61a3d1753991e525f5e77..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 @@ -7,7 +7,7 @@ -自定义元数据 +自定义元数据。 ## CustomizeData(deprecated) @@ -19,6 +19,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 fdb7fdbd8aa2d179dc5a37e224e5d765cd12551b..c1ae92b7f59e092e8b13bc4377c02e1b4c71a39b 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 6d43d101e93aefcdff8da4b7d102dea7ee7a9e92..c27e2b80b8d547f52b6ddaa35d724405ca1ce828 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 83ea268a279b928a8cfca0969ab827b471341c37..6eb770e3f35c93aae9223de31a3575241e8852b3 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 be617aafe7ad5a6245f997245ad837e96d50e765..e203780edb76cc2cdd6667ec1249ab24d3635fbc 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 @@ -33,15 +33,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 690b6415c2ddd04ef1932bfc60aa4381d6574447..9b94acb5cd60ca5f7629d58032c10718def62070 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 8f5a273bf75b5e797e19017e0247c66736ce45bc..ca5ef8abafe0dda0d588393d1b00d3f362f0373e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-defaultAppManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-defaultAppManager.md @@ -23,7 +23,7 @@ import defaultAppMgr from '@ohos.bundle.defaultAppManager'; ## defaultAppMgr.ApplicationType -应用类型 +默认应用的应用类型。 **系统能力:** SystemCapability.BundleManager.BundleFramework.DefaultApp @@ -88,7 +88,7 @@ isDefaultApplication(type: string, callback: AsyncCallback\): void **示例:** -```js +```ts import defaultAppMgr from '@ohos.bundle.defaultAppManager'; defaultAppMgr.isDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, (err, data) => { if (err) { @@ -136,7 +136,7 @@ getDefaultApplication(type: string, userId?: number): Promise\ **示例:** -```js +```ts import defaultAppMgr from '@ohos.bundle.defaultAppManager'; defaultAppMgr.getDefaultApplication(defaultAppMgr.ApplicationType.BROWSER) .then((data) => { @@ -187,7 +187,7 @@ getDefaultApplication(type: string, userId: number, callback: AsyncCallback\ { @@ -238,7 +238,7 @@ getDefaultApplication(type: string, callback: AsyncCallback\) : void **示例:** -```js +```ts import defaultAppMgr from '@ohos.bundle.defaultAppManager'; defaultAppMgr.getDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, (err, data) => { if (err) { @@ -260,12 +260,6 @@ defaultAppMgr.getDefaultApplication("image/png", (err, data) => { setDefaultApplication(type: string, elementName: ElementName, userId?: number): Promise\ -| 类型 | 说明 | -| ----------------------------------------------------------- | --------------------------- | -| Promise\ | Promise对象,返回BundleInfo | - -> - 以异步方法根据系统已定义的应用类型或者符合媒体类型格式(type/subtype)的文件类型设置默认应用,使用Promise形式返回结果。 **需要权限:** ohos.permission.SET_DEFAULT_APPLICATION @@ -286,7 +280,7 @@ setDefaultApplication(type: string, elementName: ElementName, userId?: number): | 类型 | 说明 | | -------------- | ---------------------------------- | -| Promise\ | Promise对象,无返回结果的Promise。 | +| Promise\ | Promise对象,无返回结果的Promise对象。 | **错误码:** @@ -300,7 +294,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", @@ -367,7 +361,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, { @@ -484,7 +478,7 @@ resetDefaultApplication(type: string, userId?: number): Promise\ **示例:** -```js +```ts import defaultAppMgr from '@ohos.bundle.defaultAppManager'; let userId = 100; defaultAppMgr.resetDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, userId) @@ -535,7 +529,7 @@ resetDefaultApplication(type: string, userId: number, callback: AsyncCallback\ { 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 b9eac4c952ba2a7bed4624d84ea439e7cafa785c..3823aa84617e48c6840d8de9090de4b4acc9ec87 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'; ``` @@ -31,12 +31,9 @@ hasInstalled(Object): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| bundleName | string | 是 | 应用包名。 | -| success | Function | 否 | 接口调用成功的回调函数。 | -| fail | Function | 否 | 接口调用失败的回调函数。 | -| complete | Function | 否 | 接口调用结束的回调函数。 | +|options | [CheckPackageHasInstalledOptions](#checkpackagehasinstalledoptions) | 是 | 选项参数。 | -success返回值: +**返回值:** | 参数名 | 类型 | 说明 | | -------- | -------- | -------- | @@ -44,18 +41,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