js-apis-Bundle-InnerBundleManager.md 12.4 KB
Newer Older
1
# @ohos.bundle.innerBundleManager (innerBundleManager模块)
J
junyi233 已提交
2

3
本模块提供launcher应用使用的接口。
J
junyi233 已提交
4

5
>
J
junyi233 已提交
6
> 本模块首批接口从API version 8 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
7
> 本模块从API version 9开始不再支持。建议使用[launcherBundleManager](js-apis-launcherBundleManager.md)及[bundleMonitor](js-apis-bundleMonitor.md)替代。
J
junyi233 已提交
8 9 10

## 导入模块

11
```typescript
J
junyi233 已提交
12 13 14 15 16 17 18 19
import innerBundleManager from '@ohos.bundle.innerBundleManager';
```

## 系统能力

SystemCapability.BundleManager.BundleFramework


20
## innerBundleManager.getLauncherAbilityInfos<sup>(deprecated)</sup>
J
junyi233 已提交
21 22 23 24

getLauncherAbilityInfos(bundleName: string, userId: number, callback: AsyncCallback&lt;Array&lt;LauncherAbilityInfo&gt;&gt;) : void;

以异步方法根据给定的包名获取LauncherAbilityInfos,使用callback形式返回结果。
25
> 从API version 9开始不再支持。建议使用[launcherBundleManager#getLauncherAbilityInfo](js-apis-launcherBundleManager.md)替代。
J
junyi233 已提交
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

此接口为系统接口,三方应用不支持调用

**参数:**

J
junyi233 已提交
41
| 参数名     | 类型                                                         | 必填 | 说明                                                  |
J
junyi233 已提交
42 43
| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------- |
| bundleName | string                                                       | 是   | 要查询的应用程序包名称。                              |
X
xsz233 已提交
44
| userId     | number                                                       | 是   | 用户ID。取值范围:大于等于0。 |
45
| callback   | AsyncCallback\<Array<[LauncherAbilityInfo](js-apis-bundle-LauncherAbilityInfo.md)>> | 是   | 程序启动作为入参的回调函数,返回程序信息。            |
J
junyi233 已提交
46 47


48
## innerBundleManager.getLauncherAbilityInfos<sup>(deprecated)</sup>
J
junyi233 已提交
49 50 51 52

getLauncherAbilityInfos(bundleName: string, userId: number) : Promise&lt;Array&lt;LauncherAbilityInfo&gt;&gt;

以异步方法根据给定的包名获取LauncherAbilityInfos,使用Promise形式返回结果。
53
> 从API version 9开始不再支持。建议使用[launcherBundleManager#getLauncherAbilityInfo](js-apis-launcherBundleManager.md)替代。
J
junyi233 已提交
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

此接口为系统接口,三方应用不支持调用

**参数:**

J
junyi233 已提交
69
| 参数名     | 类型   | 必填 | 说明                                                  |
J
junyi233 已提交
70 71
| ---------- | ------ | ---- | ----------------------------------------------------- |
| bundleName | string | 是   | 要查询的应用程序包名称。                              |
X
xsz233 已提交
72
| userId     | number | 是   | 用户ID。取值范围:大于等于0。 |
J
junyi233 已提交
73 74 75 76 77

**返回值:**

| 类型                                                         | 说明                      |
| ------------------------------------------------------------ | ------------------------- |
78
| Promise\<Array<[LauncherAbilityInfo](js-apis-bundle-LauncherAbilityInfo.md)>> | Promise形式返回程序信息。 |
J
junyi233 已提交
79

80
## innerBundleManager.on<sup>(deprecated)</sup>
J
junyi233 已提交
81 82 83 84

on(type:"BundleStatusChange", bundleStatusCallback : BundleStatusCallback, callback: AsyncCallback&lt;string&gt;) : void;

注册Callback。
85
> 从API version 9开始不再支持。建议使用[bundleMonitor#on](js-apis-bundleMonitor.md)替代。
J
junyi233 已提交
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100

**需要权限:**

ohos.permission.LISTEN_BUNDLE_CHANGE

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

此接口为系统接口,三方应用不支持调用

**参数:**

J
junyi233 已提交
101
| 参数名              | 类型                  | 必填 | 说明                                               |
J
junyi233 已提交
102
| -------------------- | --------------------- | ---- | ---------------------------------------------------- |
103 104
| type                 | string | 是   | 指示应执行命令,只支持BundleStatusChange。             |
| bundleStatusCallback | [BundleStatusCallback](js-apis-Bundle-BundleStatusCallback.md) | 是   | 指示要注册的回调。                                   |
105
| callback             | AsyncCallback\<string> | 是   | 程序启动作为入参的回调函数,返回正确结果或错误信息。 |
J
junyi233 已提交
106

107
## innerBundleManager.on<sup>(deprecated)</sup>
J
junyi233 已提交
108

109
on(type:"BundleStatusChange", bundleStatusCallback : BundleStatusCallback) : Promise&lt;string&gt;
J
junyi233 已提交
110 111

注册Callback。
112
> 从API version 9开始不再支持。建议使用[bundleMonitor#on](js-apis-bundleMonitor.md)替代。
J
junyi233 已提交
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127

**需要权限:**

ohos.permission.LISTEN_BUNDLE_CHANGE

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

此接口为系统接口,三方应用不支持调用

**参数:**

J
junyi233 已提交
128
| 参数名               | 类型                                                         | 必填 | 说明                                       |
129 130 131
| -------------------- | ------------------------------------------------------------ | ---- | ------------------------------------------ |
| type                 | string                                                       | 是   | 指示应执行命令,只支持BundleStatusChange。 |
| bundleStatusCallback | [BundleStatusCallback](js-apis-Bundle-BundleStatusCallback.md) | 是   | 指示要注册的回调。                         |
J
junyi233 已提交
132 133 134 135 136

**返回值:**

| 类型            | 说明                                |
| --------------- | ----------------------------------- |
137
| Promise\<string> | Promise形式返回正确结果或错误信息。 |
J
junyi233 已提交
138

139
## innerBundleManager.off<sup>(deprecated)</sup>
J
junyi233 已提交
140 141 142 143

off(type:"BundleStatusChange", callback: AsyncCallback&lt;string&gt;) : void;

取消注册Callback。
144
> 从API version 9开始不再支持。建议使用[bundleMonitor#off](js-apis-bundleMonitor.md)替代。
J
junyi233 已提交
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159

**需要权限:**

ohos.permission.LISTEN_BUNDLE_CHANGE

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

此接口为系统接口,三方应用不支持调用

**参数:**

J
junyi233 已提交
160
| 参数名  | 类型                  | 必填 | 说明                                               |
J
junyi233 已提交
161
| -------- | --------------------- | ---- | ---------------------------------------------------- |
162
| type     | string | 是   | 指示应执行命令,只支持BundleStatusChange。               |
163
| callback | AsyncCallback\<string> | 是   | 程序启动作为入参的回调函数,返回正确结果或错误信息。 |
J
junyi233 已提交
164

165
## innerBundleManager.off<sup>(deprecated)</sup>
J
junyi233 已提交
166

167
off(type:"BundleStatusChange") : Promise&lt;string&gt;
J
junyi233 已提交
168 169

取消注册Callback。
170
> 从API version 9开始不再支持。建议使用[bundleMonitor#off](js-apis-bundleMonitor.md)替代。
J
junyi233 已提交
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185

**需要权限:**

ohos.permission.LISTEN_BUNDLE_CHANGE

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

此接口为系统接口,三方应用不支持调用

**参数:**

J
junyi233 已提交
186 187 188
| 参数名 | 类型   | 必填 | 说明                                       |
| ------ | ------ | ---- | ------------------------------------------ |
| type   | string | 是   | 指示应执行命令,只支持BundleStatusChange。 |
J
junyi233 已提交
189 190 191 192 193

**返回值:**

| 类型            | 说明                                |
| --------------- | ----------------------------------- |
194
| Promise\<string> | Promise形式返回正确结果或错误信息。 |
J
junyi233 已提交
195

196
## innerBundleManager.getAllLauncherAbilityInfos<sup>(deprecated)</sup>
J
junyi233 已提交
197 198 199

getAllLauncherAbilityInfos(userId: number, callback: AsyncCallback&lt;Array&lt;LauncherAbilityInfo&gt;&gt;) : void;

200
以异步方法获取所有的LauncherAbilityInfos,使用callback形式返回结果。
201
> 从API version 9开始不再支持。建议使用[launcherBundleManager#getAllLauncherAbilityInfo](js-apis-launcherBundleManager.md)替代。
J
junyi233 已提交
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

此接口为系统接口,三方应用不支持调用

**参数:**

J
junyi233 已提交
217
| 参数名   | 类型                                                         | 必填 | 说明                                                  |
J
junyi233 已提交
218
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------- |
X
xsz233 已提交
219
| userId   | number                                                       | 是   | 用户ID。取值范围:大于等于0。 |
220
| callback | AsyncCallback\<Array<[LauncherAbilityInfo](js-apis-bundle-LauncherAbilityInfo.md)>> | 是   | 程序启动作为入参的回调函数,返回程序信息。            |
J
junyi233 已提交
221

222
## innerBundleManager.getAllLauncherAbilityInfos<sup>(deprecated)</sup>
J
junyi233 已提交
223 224 225

getAllLauncherAbilityInfos(userId: number) : Promise&lt;Array&lt;LauncherAbilityInfo&gt;&gt;

226
以异步方法获取LauncherAbilityInfos,使用Promise形式返回结果。
227
> 从API version 9开始不再支持。建议使用[launcherBundleManager#getAllLauncherAbilityInfo](js-apis-launcherBundleManager.md)替代。
J
junyi233 已提交
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

此接口为系统接口,三方应用不支持调用

**参数:**

J
junyi233 已提交
243
| 参数名 | 类型   | 必填 | 说明                                                  |
J
junyi233 已提交
244
| ------ | ------ | ---- | ----------------------------------------------------- |
X
xsz233 已提交
245
| userId | number | 是   | 用户ID。取值范围:大于等于0。 |
J
junyi233 已提交
246 247 248 249 250

**返回值:**

| 类型                                                         | 说明                      |
| ------------------------------------------------------------ | ------------------------- |
251
| Promise\<Array<[LauncherAbilityInfo](js-apis-bundle-LauncherAbilityInfo.md)>> | Promise形式返回程序信息。 |
J
junyi233 已提交
252

253
## innerBundleManager.getShortcutInfos<sup>(deprecated)</sup>
J
junyi233 已提交
254 255 256 257

getShortcutInfos(bundleName :string, callback: AsyncCallback&lt;Array&lt;ShortcutInfo&gt;&gt;) : void;

以异步方法根据给定的包名获取快捷方式信息,使用callback形式返回结果。
258
> 从API version 9开始不再支持。建议使用[launcherBundleManager#getShortcutInfo](js-apis-launcherBundleManager.md)替代。
J
junyi233 已提交
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

此接口为系统接口,三方应用不支持调用

**参数:**

J
junyi233 已提交
274
| 参数名     | 类型                                                         | 必填 | 说明                                           |
J
junyi233 已提交
275 276
| ---------- | ------------------------------------------------------------ | ---- | ---------------------------------------------- |
| bundleName | string                                                       | 是   | 要查询的应用程序包名称。                       |
277
| callback   | AsyncCallback\<Array<[ShortcutInfo](js-apis-bundle-ShortcutInfo.md)>> | 是   | 程序启动作为入参的回调函数,返回快捷方式信息。 |
J
junyi233 已提交
278

279
## innerBundleManager.getShortcutInfos<sup>(deprecated)</sup>
J
junyi233 已提交
280 281 282 283

getShortcutInfos(bundleName : string) : Promise&lt;Array&lt;ShortcutInfo&gt;&gt;

以异步方法根据给定的包名获取快捷方式信息,使用Promise形式返回结果。
284
> 从API version 9开始不再支持。建议使用[launcherBundleManager#getShortcutInfo](js-apis-launcherBundleManager.md)替代。
J
junyi233 已提交
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

此接口为系统接口,三方应用不支持调用

**参数:**

J
junyi233 已提交
300
| 参数名     | 类型   | 必填 | 说明                     |
J
junyi233 已提交
301 302 303 304 305 306 307
| ---------- | ------ | ---- | ------------------------ |
| bundleName | string | 是   | 要查询的应用程序包名称。 |

**返回值:**

| 类型                                                     | 说明                          |
| -------------------------------------------------------- | ----------------------------- |
308
| Promise\<Array<[ShortcutInfo](js-apis-bundle-ShortcutInfo.md)>> | Promise形式返回快捷方式信息。 |
J
junyi233 已提交
309