• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.bundle.launcherBundleManager (launcherBundleManager模块)
2
3本模块支持launcher应用所需的查询能力，支持[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)、[ShortcutInfo](js-apis-bundleManager-shortcutInfo.md)信息的查询。
4
5> **说明：**
6>
7> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
8
9## 导入模块
10
11```ts
12import launcherBundleManager from '@ohos.bundle.launcherBundleManager';
13```
14
15
16## launcherBundlemanager.getLauncherAbilityInfo<sup>9+</sup>
17
18getLauncherAbilityInfo(bundleName: string, userId: number, callback: AsyncCallback<Array\<[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)>>) : void;
19
20查询指定bundleName及用户的[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)。
21
22**需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
23
24**系统接口：** 此接口为系统接口
25
26**系统能力：** SystemCapability.BundleManager.BundleFramework.Launcher
27
28**参数：**
29
30| 参数名     | 类型   | 必填 | 说明         |
31| ---------- | ------ | ---- | -------------- |
32| bundleName | string | 是   | 应用程序包名称。 |
33| userId     | number | 是   | 被查询的用户id。|
34
35**返回值：**
36
37| 类型                                | 说明                                                |
38| ----------------------------------- | --------------------------------------------------- |
39| AsyncCallback\<Array<[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)>> | callback形式返回bundle包含的[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)信息。 |
40
41**错误码：**
42
43以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)。
44
45| 错误码ID | 错误信息                                 |
46| -------- | ---------------------------------------- |
47| 17700001 | The specified bundle name is not found.  |
48| 17700004 | The specified userId is not found.      |
49
50**示例：**
51
52```ts
53import launcherBundleManager from '@ohos.bundle.launcherBundleManager';
54
55try {
56    launcherBundleManager.getLauncherAbilityInfo('com.example.demo', 100, (errData, data) => {
57        if (errData !== null) {
58            console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
59        }
60        console.log("data is " + JSON.stringify(data));
61    })
62} catch (errData) {
63    console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
64}
65```
66
67## launcherBundlemanager.getLauncherAbilityInfo<sup>9+</sup>
68
69getLauncherAbilityInfo(bundleName: string, userId: number) : Promise<Array\<[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)>>;
70
71查询指定bundleName及用户的[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)。
72
73**需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
74
75**系统接口：** 此接口为系统接口
76
77**系统能力：** SystemCapability.BundleManager.BundleFramework.Launcher
78
79**参数：**
80
81| 参数名     | 类型   | 必填 | 说明         |
82| ---------- | ------ | ---- | -------------- |
83| bundleName | string | 是   | 应用程序包名称。|
84| userId     | number | 是   | 被查询的用户id。 |
85
86**返回值：**
87
88| 类型                          | 说明                                               |
89| ----------------------------- | -------------------------------------------------- |
90| Promise\<Array<[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)>> | Promise形式返回bundle包含的[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)信息。 |
91
92**错误码：**
93
94以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)。
95
96| 错误码ID | 错误信息                                 |
97| -------- | ---------------------------------------- |
98| 17700001 | The specified bundle name is not found.  |
99| 17700004 | The specified userId is not found.       |
100
101**示例：**
102
103```typescript
104import launcherBundleManager from '@ohos.bundle.launcherBundleManager';
105
106try {
107    launcherBundleManager.getLauncherAbilityInfo("com.example.demo", 100).then(data => {
108        console.log("data is " + JSON.stringify(data));
109    }).catch (errData => {
110        console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
111    })
112} catch (errData) {
113    console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
114}
115```
116
117## launcherBundlemanager.getAllLauncherAbilityInfo<sup>9+</sup>
118
119getAllLauncherAbilityInfo(userId: number, callback: AsyncCallback<Array\<[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)>>) : void;
120
121查询指定用户下所有应用的[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)
122
123**需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
124
125**系统接口：** 此接口为系统接口
126
127**系统能力：** SystemCapability.BundleManager.BundleFramework.Launcher
128
129**参数：**
130
131| 参数名 | 类型   | 必填 | 说明         |
132| ------ | ------ | ---- | -------------- |
133| userId | number | 是   | 被查询的用户id。 |
134
135**返回值：**
136
137| 类型                                | 说明                                                    |
138| ----------------------------------- | ------------------------------------------------------- |
139| AsyncCallback\<Array<[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)>> | callback形式返回指定用户下所有应用的[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)。 |
140
141**错误码：**
142
143以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)。
144
145| 错误码ID | 错误信息                                |
146| -------- | ---------------------------------------- |
147| 17700004 | The specified userId is not found.      |
148
149示例：
150
151```ts
152import launcherBundleManager from '@ohos.bundle.launcherBundleManager';
153
154try {
155    launcherBundleManager.getAllLauncherAbilityInfo(100, (errData, data) => {
156        if (errData !== null) {
157            console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
158        }
159        console.log("data is " + JSON.stringify(data));
160    });
161} catch (errData) {
162    console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
163}
164```
165## launcherBundlemanager.getAllLauncherAbilityInfo<sup>9+</sup>
166
167getAllLauncherAbilityInfo(userId: number) : Promise<Array\<[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)>>;
168
169查询指定用户下所有应用的[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)
170
171**需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
172
173**系统接口：** 此接口为系统接口
174
175**系统能力：** SystemCapability.BundleManager.BundleFramework.Launcher
176
177**参数：**
178
179| 参数名 | 类型   | 必填 | 说明         |
180| ------ | ------ | ---- | -------------- |
181| userId | number | 是   | 被查询的用户id。 |
182
183**返回值：**
184
185| 类型                          | 说明                                                   |
186| ----------------------------- | ------------------------------------------------------ |
187| Promise\<Array<[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)>> | Promise形式返回指定用户下所有应用的[LauncherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)。 |
188
189**错误码：**
190
191以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)。
192
193| 错误码ID | 错误信息                                |
194| -------- | ---------------------------------------- |
195| 17700004 | The specified userId is not found.      |
196
197**示例：**
198
199```ts
200import launcherBundleManager from '@ohos.bundle.launcherBundleManager';
201
202try {
203    launcherBundleManager.getAllLauncherAbilityInfo(100).then(data => {
204        console.log("data is " + JSON.stringify(data));
205    }).catch (errData => {
206        console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
207    });
208} catch (errData) {
209    console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
210}
211```
212
213## launcherBundlemanager.getShortcutInfo<sup>9+</sup>
214
215getShortcutInfo(bundleName :string, callback: AsyncCallback<Array\<[ShortcutInfo](js-apis-bundleManager-shortcutInfo.md)>>) : void;
216
217查询当前用户下指定应用的[ShortcutInfo](js-apis-bundleManager-shortcutInfo.md)。
218
219**需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
220
221**系统接口：** 此接口为系统接口
222
223**系统能力：** SystemCapability.BundleManager.BundleFramework.Launcher
224
225| 参数名     | 类型   | 必填 | 说明         |
226| ---------- | ------ | ---- | -------------- |
227| bundleName | string | 是   | 应用程序包名称。 |
228
229**返回值：**
230
231| 类型                                                         | 说明                                                         |
232| ------------------------------------------------------------ | ------------------------------------------------------------ |
233| AsyncCallback\<Array<[ShortcutInfo](js-apis-bundleManager-shortcutInfo.md)>> | callback形式返回当前用户下指定应用的[ShortcutInfo](js-apis-bundleManager-shortcutInfo.md)。 |
234
235**错误码：**
236
237以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)。
238
239| 错误码ID | 错误信息                                |
240| -------- | ---------------------------------------- |
241| 17700001 | The specified bundle name is not found.  |
242
243**示例：**
244
245```ts
246import launcherBundleManager from '@ohos.bundle.launcherBundleManager';
247
248try {
249    launcherBundleManager.getShortcutInfo("com.example.demo", (errData, data) => {
250        if (errData !== null) {
251            console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
252        }
253        console.log("data is " + JSON.stringify(data));
254    });
255} catch (errData) {
256    console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
257}
258```
259
260## launcherBundlemanager.getShortcutInfo<sup>9+</sup>
261
262getShortcutInfo(bundleName : string) : Promise<Array\<[ShortcutInfo](js-apis-bundleManager-shortcutInfo.md)>>;
263
264查询当前用户下指定应用的[ShortcutInfo](js-apis-bundleManager-shortcutInfo.md)。
265
266**需要权限：** ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
267
268**系统接口：** 此接口为系统接口
269
270**系统能力：** SystemCapability.BundleManager.BundleFramework.Launcher
271
272| 参数名     | 类型   | 必填 | 说明         |
273| ---------- | ------ | ---- | -------------- |
274| bundleName | string | 是   | 应用程序包名称。 |
275
276**返回值：**
277
278| 类型                   | 说明                                            |
279| ---------------------- | ----------------------------------------------- |
280| Promise\<Array<[ShortcutInfo](js-apis-bundleManager-shortcutInfo.md)>> | Promise形式返回当前用户下指定应用的[ShortcutInfo](js-apis-bundleManager-shortcutInfo.md)。 |
281
282**错误码：**
283
284以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)。
285
286| 错误码ID | 错误信息                                |
287| -------- | ---------------------------------------- |
288| 17700001 | The specified bundle name is not found.  |
289
290**示例：**
291
292```ts
293import launcherBundleManager from '@ohos.bundle.launcherBundleManager';
294
295try {
296    launcherBundleManager.getShortcutInfo("com.example.demo").then(data => {
297        console.log("data is " + JSON.stringify(data));
298    }).catch (errData => {
299        console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
300    });
301} catch (errData) {
302    console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
303}
304```
305