diff --git a/zh-cn/application-dev/reference/apis/js-apis-Bundle-BundleStatusCallback.md b/zh-cn/application-dev/reference/apis/js-apis-Bundle-BundleStatusCallback.md index 128c916edc2d5616aa91d00d689d360a97cd7c9b..c3011990c82f4521be8ace3d68561bce6c90f7c3 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-Bundle-BundleStatusCallback.md +++ b/zh-cn/application-dev/reference/apis/js-apis-Bundle-BundleStatusCallback.md @@ -3,19 +3,20 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> 本模块首批接口从API version 8 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 从API version 9开始不再支持。建议使用[bundleMonitor](js-apis-bundleMonitor.md)替代。 +应用状态回调的信息，通过接口[innerBundleManager.on](js-apis-Bundle-InnerBundleManager.md)获取。 -应用包回调的信息，通过接口[innerBundleManager.on](js-apis-Bundle-InnerBundleManager.md)获取。 -## BundleStatusCallback +## BundleStatusCallback(deprecated) +> 从API version 9开始不再支持。建议使用[bundleMonitor](js-apis-bundleMonitor.md)替代。 **系统API：** 此接口为系统接口，三方应用不支持调用。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework。 -| 名称 | 类型 | 说明 | +| 监听类型 | 注册回调 | 说明 | | ------ | --------------------------------------------- | -------------------------------------- | | add | (bundleName : string, userId: number) => void | 获取添加的launcherStatusCallback回调。 | | update | (bundleName : string, userId: number) => void | 获取编辑的launcherStatusCallback回调。 | 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 7c0bf1054168d9f5a0bbd66840239a6af4f3ccbd..448741f08e871599414a29ca7a134df8811c560a 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 @@ -1,14 +1,14 @@ -# innerBundleManager模块(JS端SDK接口) +# innerBundleManager模块(deprecated) -本模块提供内部包的管理 +本模块提供launcher应用使用的接口 -> **说明：** > > 本模块首批接口从API version 8 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块从API version 9开始不再支持。建议使用[launcherBundleManager](js-apis-launcherBundleManager.md)及[bundleMonitor](js-apis-bundleMonitor.md)替代。 ## 导入模块 -``` +```typescript import innerBundleManager from '@ohos.bundle.innerBundleManager'; ``` @@ -16,20 +16,13 @@ import innerBundleManager from '@ohos.bundle.innerBundleManager'; SystemCapability.BundleManager.BundleFramework -## 权限列表 - -| 权限 | 权限等级 | 描述 | -| ------------------------------------------ | ------------ | ---------------------------- | -| ohos.permission.GET_BUNDLE_INFO_PRIVILEGED | system_basic | 可查询所有应用信息 | -| ohos.permission.LISTEN_BUNDLE_CHANGE | system_grant | 允许该应用获取应用变化消息。 | -权限等级参考[权限等级说明](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/security/accesstoken-overview.md#%E6%9D%83%E9%99%90%E7%AD%89%E7%BA%A7%E8%AF%B4%E6%98%8E) - -## innerBundleManager.getLauncherAbilityInfos +## innerBundleManager.getLauncherAbilityInfos(deprecated) getLauncherAbilityInfos(bundleName: string, userId: number, callback: AsyncCallback<Array<LauncherAbilityInfo>>) : void; 以异步方法根据给定的包名获取LauncherAbilityInfos，使用callback形式返回结果。 +> 从API version 9开始不再支持。建议使用[launcherBundleManager#getLauncherAbilityInfo](js-apis-launcherBundleManager.md)替代。 **需要权限：** @@ -52,12 +45,12 @@ SystemCapability.BundleManager.BundleFramework | callback | AsyncCallback\> | 是 | 程序启动作为入参的回调函数，返回程序信息。 | - -## innerBundleManager.getLauncherAbilityInfos +## innerBundleManager.getLauncherAbilityInfos(deprecated) getLauncherAbilityInfos(bundleName: string, userId: number) : Promise<Array<LauncherAbilityInfo>> 以异步方法根据给定的包名获取LauncherAbilityInfos，使用Promise形式返回结果。 +> 从API version 9开始不再支持。建议使用[launcherBundleManager#getLauncherAbilityInfo](js-apis-launcherBundleManager.md)替代。 **需要权限：** @@ -84,11 +77,12 @@ SystemCapability.BundleManager.BundleFramework | ------------------------------------------------------------ | ------------------------- | | Promise\> | Promise形式返回程序信息。 | -## innerBundleManager.on +## innerBundleManager.on(deprecated) on(type:"BundleStatusChange", bundleStatusCallback : BundleStatusCallback, callback: AsyncCallback<string>) : void; 注册Callback。 +> 从API version 9开始不再支持。建议使用[bundleMonitor#on](js-apis-bundleMonitor.md)替代。 **需要权限：** @@ -110,11 +104,12 @@ SystemCapability.BundleManager.BundleFramework | bundleStatusCallback | [BundleStatusCallback](js-apis-Bundle-BundleStatusCallback.md) | 是 | 指示要注册的回调。 | | callback | AsyncCallback\ | 是 | 程序启动作为入参的回调函数，返回正确结果或错误信息。 | -## innerBundleManager.on +## innerBundleManager.on(deprecated) -on(type:"BundleStatusChange", bundleStatusCallback : BundleStatusCallback): Promise<string> +on(type:"BundleStatusChange", bundleStatusCallback : BundleStatusCallback) : Promise<string> 注册Callback。 +> 从API version 9开始不再支持。建议使用[bundleMonitor#on](js-apis-bundleMonitor.md)替代。 **需要权限：** @@ -141,11 +136,12 @@ SystemCapability.BundleManager.BundleFramework | --------------- | ----------------------------------- | | Promise\ | Promise形式返回正确结果或错误信息。 | -## innerBundleManager.off +## innerBundleManager.off(deprecated) off(type:"BundleStatusChange", callback: AsyncCallback<string>) : void; 取消注册Callback。 +> 从API version 9开始不再支持。建议使用[bundleMonitor#off](js-apis-bundleMonitor.md)替代。 **需要权限：** @@ -166,11 +162,12 @@ SystemCapability.BundleManager.BundleFramework | type | string | 是 | 指示应执行命令，只支持BundleStatusChange。 | | callback | AsyncCallback\ | 是 | 程序启动作为入参的回调函数，返回正确结果或错误信息。 | -## innerBundleManager.off +## innerBundleManager.off(deprecated) -off(type:"BundleStatusChange"): Promise<string> +off(type:"BundleStatusChange") : Promise<string> 取消注册Callback。 +> 从API version 9开始不再支持。建议使用[bundleMonitor#off](js-apis-bundleMonitor.md)替代。 **需要权限：** @@ -196,11 +193,12 @@ SystemCapability.BundleManager.BundleFramework | --------------- | ----------------------------------- | | Promise\ | Promise形式返回正确结果或错误信息。 | -## innerBundleManager.getAllLauncherAbilityInfos +## innerBundleManager.getAllLauncherAbilityInfos(deprecated) getAllLauncherAbilityInfos(userId: number, callback: AsyncCallback<Array<LauncherAbilityInfo>>) : void; 以异步方法获取所有的LauncherAbilityInfos，使用callback形式返回结果。 +> 从API version 9开始不再支持。建议使用[launcherBundleManager#getAllLauncherAbilityInfo](js-apis-launcherBundleManager.md)替代。 **需要权限：** @@ -221,11 +219,12 @@ SystemCapability.BundleManager.BundleFramework | userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | | callback | AsyncCallback\> | 是 | 程序启动作为入参的回调函数，返回程序信息。 | -## innerBundleManager.getAllLauncherAbilityInfos +## innerBundleManager.getAllLauncherAbilityInfos(deprecated) getAllLauncherAbilityInfos(userId: number) : Promise<Array<LauncherAbilityInfo>> 以异步方法获取LauncherAbilityInfos，使用Promise形式返回结果。 +> 从API version 9开始不再支持。建议使用[launcherBundleManager#getAllLauncherAbilityInfo](js-apis-launcherBundleManager.md)替代。 **需要权限：** @@ -251,11 +250,12 @@ SystemCapability.BundleManager.BundleFramework | ------------------------------------------------------------ | ------------------------- | | Promise\> | Promise形式返回程序信息。 | -## innerBundleManager.getShortcutInfos +## innerBundleManager.getShortcutInfos(deprecated) getShortcutInfos(bundleName :string, callback: AsyncCallback<Array<ShortcutInfo>>) : void; 以异步方法根据给定的包名获取快捷方式信息，使用callback形式返回结果。 +> 从API version 9开始不再支持。建议使用[launcherBundleManager#getShortcutInfo](js-apis-launcherBundleManager.md)替代。 **需要权限：** @@ -276,11 +276,12 @@ SystemCapability.BundleManager.BundleFramework | bundleName | string | 是 | 要查询的应用程序包名称。 | | callback | AsyncCallback\> | 是 | 程序启动作为入参的回调函数，返回快捷方式信息。 | -## innerBundleManager.getShortcutInfos +## innerBundleManager.getShortcutInfos(deprecated) getShortcutInfos(bundleName : string) : Promise<Array<ShortcutInfo>> 以异步方法根据给定的包名获取快捷方式信息，使用Promise形式返回结果。 +> 从API version 9开始不再支持。建议使用[launcherBundleManager#getShortcutInfo](js-apis-launcherBundleManager.md)替代。 **需要权限：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-launcherBundleManager.md b/zh-cn/application-dev/reference/apis/js-apis-launcherBundleManager.md new file mode 100644 index 0000000000000000000000000000000000000000..96dc07d812c0ac9a3c87e143254752ef98064865 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-launcherBundleManager.md @@ -0,0 +1,267 @@ +# Bundle.launcherBundleManager模块 + +本模块支持launcher应用所需的查询能力，支持[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)、[ShortcutInfo](js-apis-bundleManager-shortcutInfo.md)信息的查询。 + +> **说明：** +> +> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + +## 导入模块 + +```typescript +import launcherBundleManager from '@ohos.bundle.launcherBundleManager'; +``` + + +## launcherBundlemanager.**getLauncherAbilityInfo9+** + +getLauncherAbilityInfo(bundleName: string, userId: number, callback: AsyncCallback>) : void; + +查询指定bundleName及用户的[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)。 + +**需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED + +**系统接口：** 此接口为系统接口 + +**系统能力：** SystemCapability.BundleManager.BundleFramework.Launcher + +**参数：** + +| 参数名 | 类型 | 必填 | 描述 | +| ---------- | ------ | ---- | -------------- | +| bundleName | string | 是 | 应用程序包名称。 | +| userId | number | 是 | 被查询的用户id。| + +**返回值：** + +| 类型 | 说明 | +| ----------------------------------- | --------------------------------------------------- | +| AsyncCallback\> | callback形式返回bundle包含的[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)信息 | + +**相关错误码** + +| 错误码 | 错误信息（此处仅提供错误抛出的关键信息） | +| -------- | ---------------------------------------- | +| 17700001 | The specified bundle name is not found. | +| 17700004 | The specified user id is not found. | + +**示例：** + +```typescript +import launcherBundleManager from '@ohos.bundle.launcherBundleManager'; + +try { + launcherBundleManager.getLauncherAbilityInfo('com.example.demo', 100, (errData, data) => { + if (errData !== null) { + console.log(`errData is errCode:${errData.errCode} message:${errData.message}`); + } + console.log("data is " + JSON.Stringify(data)); + }) +} catch (errData) { + console.log(`errData is errCode:${errData.errCode} message:${errData.message}`); +} +``` + +getLauncherAbilityInfo(bundleName: string, userId: number) : Promise>; + +查询指定bundleName及用户的[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)。 + +**需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED + +**系统接口：** 此接口为系统接口 + +**系统能力：** SystemCapability.BundleManager.BundleFramework.Launcher + +**参数：** + +| 参数名 | 类型 | 必填 | 描述 | +| ---------- | ------ | ---- | -------------- | +| bundleName | string | 是 | 应用程序包名称 。| +| userId | number | 是 | 被查询的用户id。 | + +**返回值：** + +| 类型 | 说明 | +| ----------------------------- | -------------------------------------------------- | +| Promise\> | Promise形式返回bundle包含的[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)信息 | + +**相关错误码** + +| 错误码 | 错误信息（此处仅提供错误抛出的关键信息） | +| -------- | ---------------------------------------- | +| 17700001 | The specified bundle name is not found. | +| 17700004 | The specified user id is not found. | + +**示例：** + +```typescript +import launcherBundleManager from '@ohos.bundle.launcherBundleManager'; + +try { + launcherBundleManager.getLauncherAbilityInfo("com.example.demo", 100).then(data => { + console.log("data is " + JSON.Stringify(data)); + }).catch (errData => { + console.log(`errData is errCode:${errData.errCode} message:${errData.message}`); + }) +} catch (errData) { + console.log(`errData is errCode:${errData.errCode} message:${errData.message}`); +} +``` + +## launcherBundlemanager.getAllLauncherAbilityInfo9+ + +getAllLauncherAbilityInfo(userId: number, callback: AsyncCallback>) : void; + +查询指定用户下所有应用的[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md) + +**需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED + +**系统接口：** 此接口为系统接口 + +**系统能力：** SystemCapability.BundleManager.BundleFramework.Launcher + +**参数：** + +| 参数名 | 类型 | 必填 | 描述 | +| ------ | ------ | ---- | -------------- | +| userId | number | 是 | 被查询的用户id。 | + +**返回值：** + +| 类型 | 说明 | +| ----------------------------------- | ------------------------------------------------------- | +| AsyncCallback\> | callback形式返回指定用户下所有应用的[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md) | + +**相关错误码** + +| 错误码 | 错误信息（此处仅提供错误抛出的关键信息） | +| -------- | ---------------------------------------- | +| 17700004 | The specified user id is not found. | + +示例： + +```typescript +import launcherBundleManager from '@ohos.bundle.launcherBundleManager'; + +try { + launcherBundleManager.getAllLauncherAbilityInfo(100, (errData, data) => { + if (errData !== null) { + console.log(`errData is errCode:${errData.errCode} message:${errData.message}`); + } + console.log("data is " + JSON.Stringify(data)); + }) +} catch (errData) { + console.log(`errData is errCode:${errData.errCode} message:${errData.message}`); +} +``` + +getAllLauncherAbilityInfo(userId: number) : Promise>; + +查询指定用户下所有应用的[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md) + +**需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED + +**系统接口：** 此接口为系统接口 + +**系统能力：** SystemCapability.BundleManager.BundleFramework.Launcher + +**参数：** + +| 参数名 | 类型 | 必填 | 描述 | +| ------ | ------ | ---- | -------------- | +| userId | number | 是 | 被查询的用户id。 | + +**返回值：** + +| 类型 | 说明 | +| ----------------------------- | ------------------------------------------------------ | +| Promise\> | Promise形式返回指定用户下所有应用的[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md) | + +示例： + +```typescript +import launcherBundleManager from '@ohos.bundle.launcherBundleManager'; + +try { + launcherBundleManager.getAllLauncherAbilityInfo(100).then(data => { + console.log("data is " + JSON.Stringify(data)); + }).catch (errData => { + console.log(`errData is errCode:${errData.errCode} message:${errData.message}`); + }) +} catch (errData) { + console.log(`errData is errCode:${errData.errCode} message:${errData.message}`); +} +``` + +## launcherBundlemanager.getShortcutInfo9+ + +getShortcutInfo(bundleName :string, callback: AsyncCallback>) : void; + +查询当前用户下指定应用的[ShortcutInfo](js-apis-bundleManager-shortcutInfo.md) + +**需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED + +**系统接口：** 此接口为系统接口 + +**系统能力：** SystemCapability.BundleManager.BundleFramework.Launcher + +| 参数名 | 类型 | 必填 | 描述 | +| ---------- | ------ | ---- | -------------- | +| bundleName | string | 是 | 应用程序包名称。 | + +**返回值：** + +| 类型 | 说明 | +| ------------------------------------------------------------ | ------------------------------------------------------------ | +| AsyncCallback\> | callback形式返回当前用户下指定应用的[ShortcutInfo](js-apis-bundleManager-shortcutInfo.md) | + +示例： + +```typescript +import launcherBundleManager from '@ohos.bundle.launcherBundleManager'; + +try { + launcherBundleManager.getShortcutInfo("com.example.demo", (errData, data) => { + if (errData !== null) { + console.log(`errData is errCode:${errData.errCode} message:${errData.message}`); + } + console.log("data is " + JSON.Stringify(data)); + }) +} catch (errData) { + console.log(`errData is errCode:${errData.errCode} message:${errData.message}`); +} +``` + +getShortcutInfo(bundleName : string) : Promise>; + +**需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED + +**系统接口：** 此接口为系统接口 + +**系统能力：** SystemCapability.BundleManager.BundleFramework.Launcher + +| 参数名 | 类型 | 必填 | 描述 | +| ---------- | ------ | ---- | -------------- | +| bundleName | string | 是 | 应用程序包名称。 | + +**返回值：** + +| 类型 | 说明 | +| ---------------------- | ----------------------------------------------- | +| Promise\> | Promise形式返回当前用户下指定应用的[ShortcutInfo](js-apis-bundleManager-shortcutInfo.md) | + +示例： + +```typescript +import launcherBundleManager from '@ohos.bundle.launcherBundleManager'; + +try { + launcherBundleManager.getShortcutInfo("com.example.demo").then(data => { + console.log("data is " + JSON.Stringify(data)); + }).catch (errData => { + console.log(`errData is errCode:${errData.errCode} message:${errData.message}`); + }) +} catch (errData) { + console.log(`errData is errCode:${errData.errCode} message:${errData.message}`); +} +```