@ohos.bundle.launcherBundleManager (launcherBundleManager模块)

本模块支持launcher应用(桌面有图标的应用)所需的查询能力,支持LauncherAbilityInfo信息的查询。

说明:

本模块首批接口从API version 18开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import { launcherBundleManager } from '@kit.AbilityKit';

launcherBundleManager.getLauncherAbilityInfoSync

getLauncherAbilityInfoSync(bundleName: string, userId: number) : Array<LauncherAbilityInfo>

查询指定bundleName及用户的LauncherAbilityInfo

需要权限: ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力: SystemCapability.BundleManager.BundleFramework.Launcher

参数:

参数名 类型 必填 说明
bundleName string 应用Bundle名称。
userId number 被查询的用户ID,可以通过getOsAccountLocalId接口获取。

返回值:

类型 说明
Array<LauncherAbilityInfo> Array形式返回bundle包含的LauncherAbilityInfo信息。

错误码:

以下错误码的详细介绍请参见通用错误码ohos.bundle错误码

错误码ID 错误信息
201 Verify permission denied.
801 Capability not support.
17700001 The specified bundle name is not found.
17700004 The specified user ID is not found.

示例:

import { launcherBundleManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

try {
  let data = launcherBundleManager.getLauncherAbilityInfoSync("com.example.demo", 100);
  console.info("data is " + JSON.stringify(data));
} catch (errData) {
  let code = (errData as BusinessError).code;
  let message = (errData as BusinessError).message;
  console.error(`errData is errCode:${code}  message:${message}`);
}

LauncherAbilityInfo

type LauncherAbilityInfo = _LauncherAbilityInfo

LauncherAbilityInfo信息。

系统能力: SystemCapability.BundleManager.BundleFramework.Launcher

类型 说明
_LauncherAbilityInfo 桌面应用的Ability信息。

ShortcutInfo20+

type ShortcutInfo = _ShortcutInfo

应用module.json5配置文件中定义的快捷方式信息。

系统能力: SystemCapability.BundleManager.BundleFramework.Launcher

类型 说明
_ShortcutInfo 应用module.json5配置文件中定义的快捷方式信息。

ShortcutWant20+

type ShortcutWant = _ShortcutWant

快捷方式内定义的目标wants信息集合。

系统能力: SystemCapability.BundleManager.BundleFramework.Launcher

类型 说明
_ShortcutWant 快捷方式内定义的目标wants信息集合。

ParameterItem20+

type ParameterItem = _ParameterItem

快捷方式配置信息中的自定义数据。

系统能力: SystemCapability.BundleManager.BundleFramework.Launcher

类型 说明
_ParameterItem 快捷方式配置信息中的自定义数据。