@ohos.bundle.launcherBundleManager (launcherBundleManager模块)
@ohos.bundle.launcherBundleManager (launcherBundleManager模块)
本模块支持launcher应用所需的查询能力,支持LauncherAbilityInfo、ShortcutInfo信息的查询。
说明:
本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
import launcherBundleManager from '@ohos.bundle.launcherBundleManager';
launcherBundlemanager.getLauncherAbilityInfo9+
getLauncherAbilityInfo(bundleName: string, userId: number, callback: AsyncCallback<Array<LauncherAbilityInfo>>) : void;
查询指定bundleName及用户的LauncherAbilityInfo。
需要权限: ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
系统接口: 此接口为系统接口
系统能力: SystemCapability.BundleManager.BundleFramework.Launcher
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
bundleName | string | 是 | 应用Bundle名称。 |
userId | number | 是 | 被查询的用户id。 |
返回值:
类型 | 说明 |
---|---|
AsyncCallback<Array<LauncherAbilityInfo>> | callback形式返回bundle包含的LauncherAbilityInfo信息。 |
错误码:
以下错误码的详细介绍请参见ohos.bundle错误码。
错误码ID | 错误信息 |
---|---|
17700001 | The specified bundle name is not found. |
17700004 | The specified user ID is not found. |
示例:
import launcherBundleManager from '@ohos.bundle.launcherBundleManager';
try {
launcherBundleManager.getLauncherAbilityInfo('com.example.demo', 100, (errData, data) => {
if (errData !== null) {
console.error(`errData is errCode:${errData.code} message:${errData.message}`);
} else {
console.log("data is " + JSON.stringify(data));
}
})
} catch (errData) {
console.error(`errData is errCode:${errData.code} message:${errData.message}`);
}
2
3
4
5
6
7
8
9
10
11
12
13
launcherBundlemanager.getLauncherAbilityInfo9+
getLauncherAbilityInfo(bundleName: string, userId: number) : Promise<Array<LauncherAbilityInfo>>;
查询指定bundleName及用户的LauncherAbilityInfo。
需要权限: ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
系统接口: 此接口为系统接口
系统能力: SystemCapability.BundleManager.BundleFramework.Launcher
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
bundleName | string | 是 | 应用Bundle名称。 |
userId | number | 是 | 被查询的用户id。 |
返回值:
类型 | 说明 |
---|---|
Promise<Array<LauncherAbilityInfo>> | Promise形式返回bundle包含的LauncherAbilityInfo信息。 |
错误码:
以下错误码的详细介绍请参见ohos.bundle错误码。
错误码ID | 错误信息 |
---|---|
17700001 | The specified bundle name is not found. |
17700004 | The specified user ID is not found. |
示例:
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.error(`errData is errCode:${errData.code} message:${errData.message}`);
})
} catch (errData) {
console.error(`errData is errCode:${errData.code} message:${errData.message}`);
}
2
3
4
5
6
7
8
9
10
11
launcherBundlemanager.getAllLauncherAbilityInfo9+
getAllLauncherAbilityInfo(userId: number, callback: AsyncCallback<Array<LauncherAbilityInfo>>) : void;
查询指定用户下所有应用的LauncherAbilityInfo
需要权限: ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
系统接口: 此接口为系统接口
系统能力: SystemCapability.BundleManager.BundleFramework.Launcher
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
userId | number | 是 | 被查询的用户id。 |
返回值:
类型 | 说明 |
---|---|
AsyncCallback<Array<LauncherAbilityInfo>> | callback形式返回指定用户下所有应用的LauncherAbilityInfo。 |
错误码:
以下错误码的详细介绍请参见ohos.bundle错误码。
错误码ID | 错误信息 |
---|---|
17700004 | The specified user ID is not found. |
示例:
import launcherBundleManager from '@ohos.bundle.launcherBundleManager';
try {
launcherBundleManager.getAllLauncherAbilityInfo(100, (errData, data) => {
if (errData !== null) {
console.error(`errData is errCode:${errData.code} message:${errData.message}`);
} else {
console.log("data is " + JSON.stringify(data));
}
});
} catch (errData) {
console.error(`errData is errCode:${errData.code} message:${errData.message}`);
}
2
3
4
5
6
7
8
9
10
11
12
13
launcherBundlemanager.getAllLauncherAbilityInfo9+
getAllLauncherAbilityInfo(userId: number) : Promise<Array<LauncherAbilityInfo>>;
查询指定用户下所有应用的LauncherAbilityInfo
需要权限: ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
系统接口: 此接口为系统接口
系统能力: SystemCapability.BundleManager.BundleFramework.Launcher
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
userId | number | 是 | 被查询的用户id。 |
返回值:
类型 | 说明 |
---|---|
Promise<Array<LauncherAbilityInfo>> | Promise形式返回指定用户下所有应用的LauncherAbilityInfo。 |
错误码:
以下错误码的详细介绍请参见ohos.bundle错误码。
错误码ID | 错误信息 |
---|---|
17700004 | The specified user ID is not found. |
示例:
import launcherBundleManager from '@ohos.bundle.launcherBundleManager';
try {
launcherBundleManager.getAllLauncherAbilityInfo(100).then(data => {
console.log("data is " + JSON.stringify(data));
}).catch (errData => {
console.error(`errData is errCode:${errData.code} message:${errData.message}`);
});
} catch (errData) {
console.error(`errData is errCode:${errData.code} message:${errData.message}`);
}
2
3
4
5
6
7
8
9
10
11
launcherBundlemanager.getShortcutInfo9+
getShortcutInfo(bundleName :string, callback: AsyncCallback<Array<ShortcutInfo>>) : void;
查询当前用户下指定应用的ShortcutInfo。
需要权限: ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
系统接口: 此接口为系统接口
系统能力: SystemCapability.BundleManager.BundleFramework.Launcher
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
bundleName | string | 是 | 应用Bundle名称。 |
返回值:
类型 | 说明 |
---|---|
AsyncCallback<Array<ShortcutInfo>> | callback形式返回当前用户下指定应用的ShortcutInfo。 |
错误码:
以下错误码的详细介绍请参见ohos.bundle错误码。
错误码ID | 错误信息 |
---|---|
17700001 | The specified bundle name is not found. |
示例:
import launcherBundleManager from '@ohos.bundle.launcherBundleManager';
try {
launcherBundleManager.getShortcutInfo("com.example.demo", (errData, data) => {
if (errData !== null) {
console.error(`errData is errCode:${errData.code} message:${errData.message}`);
} else {
console.log("data is " + JSON.stringify(data));
}
});
} catch (errData) {
console.error(`errData is errCode:${errData.code} message:${errData.message}`);
}
2
3
4
5
6
7
8
9
10
11
12
13
launcherBundlemanager.getShortcutInfo9+
getShortcutInfo(bundleName : string) : Promise<Array<ShortcutInfo>>;
查询当前用户下指定应用的ShortcutInfo。
需要权限: ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
系统接口: 此接口为系统接口
系统能力: SystemCapability.BundleManager.BundleFramework.Launcher
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
bundleName | string | 是 | 应用Bundle名称。 |
返回值:
类型 | 说明 |
---|---|
Promise<Array<ShortcutInfo>> | Promise形式返回当前用户下指定应用的ShortcutInfo。 |
错误码:
以下错误码的详细介绍请参见ohos.bundle错误码。
错误码ID | 错误信息 |
---|---|
17700001 | The specified bundle name is not found. |
示例:
import launcherBundleManager from '@ohos.bundle.launcherBundleManager';
try {
launcherBundleManager.getShortcutInfo("com.example.demo").then(data => {
console.log("data is " + JSON.stringify(data));
}).catch (errData => {
console.error(`errData is errCode:${errData.code} message:${errData.message}`);
});
} catch (errData) {
console.error(`errData is errCode:${errData.code} message:${errData.message}`);
}
2
3
4
5
6
7
8
9
10
11