js-apis-Bundle.md 68.7 KB
Newer Older
S
shuaiyutao 已提交
1 2
# Bundle模块(JS端SDK接口)

S
shuaiyutao 已提交
3 4
本模块提供应用信息查询能力,支持BundleInfo、ApplicationInfo、Ability、ExtensionAbility、应用状态等信息的查询

5
> **说明:**
W
wanghang 已提交
6 7
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
S
shuaiyutao 已提交
8 9
## 导入模块

Mr-YX's avatar
Mr-YX 已提交
10
```js
S
shuaiyutao 已提交
11 12 13 14 15
import bundle from '@ohos.bundle';
```

## 权限列表

S
shuaiyutao 已提交
16 17
| 权限                                       | 权限等级     | 描述               |
| ------------------------------------------ | ------------ | ------------------ |
J
junyi233 已提交
18
| ohos.permission.GET_BUNDLE_INFO            | normal       | 查询指定应用信息   |
W
wanghang 已提交
19
| ohos.permission.GET_BUNDLE_INFO_PRIVILEGED | system_basic | 可查询所有应用信息 |
S
shuaiyutao 已提交
20
| ohos.permission.INSTALL_BUNDLE             | system_core  | 可安装、卸载应用   |
21
| ohos.permission.MANAGE_DISPOSED_APP_STATUS | system_core  | 可设置和查询应用的处置状态   |
S
shuaiyutao 已提交
22

Z
zengyawen 已提交
23
权限等级参考[权限等级说明](../../security/accesstoken-overview.md#权限等级说明)
S
shuaiyutao 已提交
24

W
wanghang 已提交
25 26 27
## bundle.getApplicationInfo<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.getApplicationInfo](js-apis-bundleManager.md#bundlemanagergetapplicationinfo)替代。
S
shuaiyutao 已提交
28

qq_41863798's avatar
qq_41863798 已提交
29
getApplicationInfo(bundleName: string, bundleFlags: number, userId?: number): Promise\<ApplicationInfo>
S
shuaiyutao 已提交
30 31 32 33 34

以异步方法根据给定的包名获取ApplicationInfo,使用Promise形式返回结果。

**需要权限:**

J
junyi233 已提交
35
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
S
shuaiyutao 已提交
36

37 38 39 40
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
41 42
**参数:**

J
junyi233 已提交
43
| 参数名      | 类型   | 必填 | 说明                                                         |
S
shuaiyutao 已提交
44 45 46 47
| ----------- | ------ | ---- | ------------------------------------------------------------ |
| bundleName  | string | 是   | 要查询的应用程序包名称。                                     |
| bundleFlags | number | 是   | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中应用信息相关flag |
| userId      | number | 否   | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。        |
S
shuaiyutao 已提交
48 49 50

**返回值:**

H
HelloCrease 已提交
51 52
| 类型                        | 说明                 |
| ------------------------- | ------------------ |
J
junyi233 已提交
53
| Promise\<[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)> | Promise形式返回应用程序信息。 |
S
shuaiyutao 已提交
54 55 56 57

**示例:**

```js
W
wanghang 已提交
58 59 60 61 62 63 64 65
let bundleName = "com.example.myapplication";
let bundleFlags = 0;
let userId = 100;
bundle.getApplicationInfo(bundleName, bundleFlags, userId)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
S
shuaiyutao 已提交
66 67 68
})
```

W
wanghang 已提交
69 70 71
## bundle.getApplicationInfo<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.getApplicationInfo](js-apis-bundleManager.md#bundlemanagergetapplicationinfo)替代。
S
shuaiyutao 已提交
72 73 74

getApplicationInfo(bundleName: string, bundleFlags: number, userId: number, callback: AsyncCallback\<ApplicationInfo>): void

75
以异步方法根据给定的包名获取指定用户下的ApplicationInfo,使用callback形式返回结果。
S
shuaiyutao 已提交
76 77 78

**需要权限:**

J
junyi233 已提交
79
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
S
shuaiyutao 已提交
80

81 82 83 84
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
85 86
**参数:**

J
junyi233 已提交
87
| 参数名      | 类型                                                         | 必填 | 说明                                                         |
S
shuaiyutao 已提交
88 89 90 91 92
| ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| bundleName  | string                                                       | 是   | 要查询的应用程序包名称。                                     |
| bundleFlags | number                                                       | 是   | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中应用信息相关flag |
| userId      | number                                                       | 是   | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。        |
| callback    | AsyncCallback\<[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)> | 是   | 程序启动作为入参的回调函数,返回应用程序信息。               |
S
shuaiyutao 已提交
93 94 95 96

**示例:**

```js
W
wanghang 已提交
97 98 99 100 101 102 103 104 105 106
let bundleName = "com.example.myapplication";
let bundleFlags = 0;
let userId = 100;
bundle.getApplicationInfo(bundleName, bundleFlags, userId, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
 })
S
shuaiyutao 已提交
107 108
```

W
wanghang 已提交
109 110 111 112
## bundle.getApplicationInfo<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.getApplicationInfo](js-apis-bundleManager.md#bundlemanagergetapplicationinfo)替代。

qq_41863798's avatar
qq_41863798 已提交
113 114 115 116 117 118 119

getApplicationInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback\<ApplicationInfo>): void

以异步方法根据给定的包名获取ApplicationInfo,使用callback形式返回结果。

**需要权限:**

J
junyi233 已提交
120
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
qq_41863798's avatar
qq_41863798 已提交
121 122 123 124 125 126 127

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

J
junyi233 已提交
128
| 参数名      | 类型                                                         | 必填 | 说明                                                         |
S
shuaiyutao 已提交
129 130 131 132
| ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| bundleName  | string                                                       | 是   | 要查询的应用程序包名称。                                     |
| bundleFlags | number                                                       | 是   | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中应用信息相关flag |
| callback    | AsyncCallback\<[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)> | 是   | 程序启动作为入参的回调函数,返回应用程序信息。               |
qq_41863798's avatar
qq_41863798 已提交
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147

**示例:**

```js
let bundleName = "com.example.myapplication";
let bundleFlags = 0;
bundle.getApplicationInfo(bundleName, bundleFlags, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
 })
```

148

W
wanghang 已提交
149
## bundle.getAllBundleInfo<sup>deprecated<sup>
150

W
wanghang 已提交
151
> 从API version 9开始不再维护,建议使用[bundleManager.getAllBundleInfo](js-apis-bundleManager.md#bundlemanagergetallbundleinfo)替代。
S
shuaiyutao 已提交
152

W
wanghang 已提交
153
getAllBundleInfo(bundleFlag: BundleFlag, userId?: number): Promise<Array\<BundleInfo>>
S
shuaiyutao 已提交
154 155 156 157 158 159 160

以异步方法获取系统中所有可用的BundleInfo,使用Promise形式返回结果。

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

161 162 163 164
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
165 166
**参数:**

J
junyi233 已提交
167
| 参数名     | 类型       | 必填 | 说明                                                         |
S
shuaiyutao 已提交
168 169 170
| ---------- | ---------- | ---- | ------------------------------------------------------------ |
| bundleFlag | BundleFlag | 是   | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag |
| userId     | number     | 否   | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。        |
S
shuaiyutao 已提交
171 172 173

**返回值:**

H
HelloCrease 已提交
174 175
| 类型                          | 说明                         |
| --------------------------- | -------------------------- |
J
junyi233 已提交
176
| Promise<Array\<[BundleInfo](js-apis-bundle-BundleInfo.md)>> | Promise形式返回所有可用的BundleInfo |
S
shuaiyutao 已提交
177 178 179 180

**示例:**

```js
W
wanghang 已提交
181 182 183 184 185 186 187
let bundleFlag = 0;
let userId = 100;
bundle.getAllBundleInfo(bundleFlag, userId)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
S
shuaiyutao 已提交
188 189 190
})
```

W
wanghang 已提交
191 192 193 194
## bundle.getAllBundleInfo<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.getAllBundleInfo](js-apis-bundleManager.md#bundlemanagergetallbundleinfo)替代。

S
shuaiyutao 已提交
195 196 197 198 199 200 201 202 203

getAllBundleInfo(bundleFlag: BundleFlag, callback: AsyncCallback<Array\<BundleInfo>>): void

以异步方法获取系统中所有可用的BundleInfo,使用callback形式返回结果。

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

204 205 206 207
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
208 209
**参数:**

J
junyi233 已提交
210
| 参数名     | 类型                                                         | 必填 | 说明                                                         |
S
shuaiyutao 已提交
211 212 213
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| bundleFlag | BundleFlag                                                   | 是   | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag |
| callback   | AsyncCallback<Array\<[BundleInfo](js-apis-bundle-BundleInfo.md)>> | 是   | 程序启动作为入参的回调函数,返回所有可用的BundleInfo。       |
S
shuaiyutao 已提交
214 215 216 217

**示例:**

```js
W
wanghang 已提交
218 219 220 221 222 223 224 225 226
let bundleFlag = 0;
bundle.getAllBundleInfo(bundleFlag, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
 })
```
S
shuaiyutao 已提交
227

W
wanghang 已提交
228 229 230 231
## bundle.getAllBundleInfo<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.getAllBundleInfo](js-apis-bundleManager.md#bundlemanagergetallbundleinfo)替代。

W
wanghang 已提交
232 233 234

getAllBundleInfo(bundleFlag: BundleFlag, userId: number, callback: AsyncCallback<Array\<BundleInfo>>): void

235
以异步方法获取系统中指定用户下所有可用的BundleInfo,使用callback形式返回结果。
W
wanghang 已提交
236 237 238 239 240

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

241 242 243 244
**系统能力:**

SystemCapability.BundleManager.BundleFramework

W
wanghang 已提交
245 246
**参数:**

J
junyi233 已提交
247
| 参数名     | 类型                                                         | 必填 | 说明                                                         |
S
shuaiyutao 已提交
248 249 250 251
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| bundleFlag | BundleFlag                                                   | 是   | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag |
| userId     | number                                                       | 是   | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。        |
| callback   | AsyncCallback<Array\<[BundleInfo](js-apis-bundle-BundleInfo.md)>> | 是   | 程序启动作为入参的回调函数,返回所有可用的BundleInfo。       |
W
wanghang 已提交
252 253 254 255 256 257 258 259 260 261 262 263 264

**示例:**

```js
let bundleFlag = 0;
let userId = 100;
bundle.getAllBundleInfo(bundleFlag, userId, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
 })
S
shuaiyutao 已提交
265 266
```

W
wanghang 已提交
267 268 269 270
## bundle.getBundleInfo<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)替代。

S
shuaiyutao 已提交
271

W
wanghang 已提交
272
getBundleInfo(bundleName: string, bundleFlags: number, options?: BundleOptions): Promise\<BundleInfo>
S
shuaiyutao 已提交
273 274 275 276 277

以异步方法根据给定的包名获取BundleInfo,使用Promise形式返回结果。

**需要权限:**

J
junyi233 已提交
278
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
S
shuaiyutao 已提交
279

280 281 282 283
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
284 285
**参数:**

J
junyi233 已提交
286
| 参数名         | 类型            | 必填   | 说明                                      |
H
HelloCrease 已提交
287 288
| ----------- | ------------- | ---- | --------------------------------------- |
| bundleName  | string        | 是    | 包名                                      |
S
shuaiyutao 已提交
289
| bundleFlags | number        | 是    | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag |
J
junyi233 已提交
290
| options     | [BundleOptions](#bundleoptions) | 否    | 包含userid。                               |
S
shuaiyutao 已提交
291 292 293

**返回值:**

H
HelloCrease 已提交
294 295
| 类型                   | 说明                           |
| -------------------- | ---------------------------- |
J
junyi233 已提交
296
| Promise\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 返回值为Promise对象,Promise中包含包信息。 |
S
shuaiyutao 已提交
297 298 299 300

**示例:**

```js
W
wanghang 已提交
301 302 303
let bundleName = "com.example.myapplication";
let bundleFlags = 1;
let options = {
qq_41863798's avatar
qq_41863798 已提交
304
  "userId" : 100
W
wanghang 已提交
305 306 307 308 309 310
};
bundle.getBundleInfo(bundleName, bundleFlags, options)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
S
shuaiyutao 已提交
311 312 313
})
```

W
wanghang 已提交
314 315 316
## bundle.getBundleInfo<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)替代。
S
shuaiyutao 已提交
317 318 319 320 321 322 323

getBundleInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback\<BundleInfo>): void

以异步方法根据给定的包名获取BundleInfo,使用callback形式返回结果。

**需要权限:**

J
junyi233 已提交
324
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
S
shuaiyutao 已提交
325

326 327 328 329
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
330 331
**参数:**

J
junyi233 已提交
332
| 参数名      | 类型                                                       | 必填 | 说明                                                         |
S
shuaiyutao 已提交
333 334 335 336
| ----------- | ---------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| bundleName  | string                                                     | 是   | 包名                                                         |
| bundleFlags | number                                                     | 是   | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag |
| callback    | AsyncCallback\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 是   | 程序启动作为入参的回调函数,返回包信息。                     |
S
shuaiyutao 已提交
337 338 339 340

**示例:**

```js
W
wanghang 已提交
341 342 343 344 345 346 347 348 349
let bundleName = "com.example.myapplication";
let bundleFlags = 1;
bundle.getBundleInfo(bundleName, bundleFlags, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})
S
shuaiyutao 已提交
350 351 352
```


W
wanghang 已提交
353 354 355
## bundle.getBundleInfo<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)替代。
W
wanghang 已提交
356 357 358 359 360 361 362

getBundleInfo(bundleName: string, bundleFlags: number, options: BundleOptions, callback: AsyncCallback\<BundleInfo>): void

以异步方法根据给定的包名获取BundleInfo,使用callback形式返回结果。

**需要权限:**

J
junyi233 已提交
363
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
W
wanghang 已提交
364

365 366 367 368
**系统能力:**

SystemCapability.BundleManager.BundleFramework

W
wanghang 已提交
369 370
**参数:**

J
junyi233 已提交
371
| 参数名      | 类型                                                       | 必填 | 说明                                                         |
S
shuaiyutao 已提交
372 373 374 375 376
| ----------- | ---------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| bundleName  | string                                                     | 是   | 包名                                                         |
| bundleFlags | number                                                     | 是   | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag |
| options     | [BundleOptions](#bundleoptions)                            | 是   | 包含userid。                                                 |
| callback    | AsyncCallback\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 是   | 程序启动作为入参的回调函数,返回包信息。                     |
W
wanghang 已提交
377 378 379 380 381 382 383

**示例:**

```js
let bundleName = "com.example.myapplication";
let bundleFlags = 1;
let options = {
qq_41863798's avatar
qq_41863798 已提交
384
  "userId" : 100
W
wanghang 已提交
385 386 387 388 389 390 391 392 393 394
};
bundle.getBundleInfo(bundleName, bundleFlags, options, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})
```

395 396


W
wanghang 已提交
397
## bundle.getBundleInstaller<sup>deprecated<sup>
398

W
wanghang 已提交
399
> 从API version 9开始不再维护,建议使用[installer.getBundleInstaller](js-apis-installer.md#bundleinstallergetbundleinstaller)替代。
J
junyi233 已提交
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422

getBundleInstaller(): Promise&lt;BundleInstaller&gt;;

获取用于安装包的接口

**需要权限:**

ohos.permission.INSTALL_BUNDLE

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**返回值:**

| 类型                                                         | 说明                                         |
| ------------------------------------------------------------ | -------------------------------------------- |
| Promise<[BundleInstaller](js-apis-bundle-BundleInstaller.md)> | 返回值为Promise对象,Promise中包含安装信息。 |

W
wanghang 已提交
423 424 425
## bundle.getBundleInstaller<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[installer.getBundleInstaller](js-apis-installer.md#bundleinstallergetbundleinstaller)替代。
J
junyi233 已提交
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444

getBundleInstaller(callback: AsyncCallback&lt;BundleInstaller&gt;): void;

获取用于安装包的接口

**需要权限:**

ohos.permission.INSTALL_BUNDLE

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

J
junyi233 已提交
445
| 参数名   | 类型                                                         | 必填 | 说明             |
J
junyi233 已提交
446 447 448
| -------- | ------------------------------------------------------------ | ---- | ---------------- |
| callback | AsyncCallback<[BundleInstaller](js-apis-bundle-BundleInstaller.md)> | 是   | 安装应用程序包。 |

W
wanghang 已提交
449 450 451
## bundle.cleanBundleCacheFiles<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.cleanBundleCacheFiles](js-apis-bundleManager.md#bundlemanagercleanbundlecachefiles)替代。
J
junyi233 已提交
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470

cleanBundleCacheFiles(bundleName: string, callback: AsyncCallback&lt;void&gt;): void;

清除指定应用程序的缓存数据

**需要权限:**

ohos.permission.REMOVE_CACHE_FILES

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

J
junyi233 已提交
471
| 参数名      | 类型                | 必填 | 说明                                  |
J
junyi233 已提交
472 473
| ---------- | ------------------- | ---- | ------------------------------------- |
| bundleName | string              | 是   | 指示要清除其缓存数据的应用程序包名称. |
474
| callback   | AsyncCallback\<void> | 是   | 为返回操作结果而调用的回调。          |
J
junyi233 已提交
475

W
wanghang 已提交
476 477 478
## bundle.cleanBundleCacheFiles<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.cleanBundleCacheFiles](js-apis-bundleManager.md#bundlemanagercleanbundlecachefiles)替代。
J
junyi233 已提交
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497

cleanBundleCacheFiles(bundleName: string): Promise&lt;void&gt;

清除指定应用程序的缓存数据

**需要权限:**

ohos.permission.REMOVE_CACHE_FILES

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

J
junyi233 已提交
498
| 参数名     | 类型   | 必填 | 说明                                  |
J
junyi233 已提交
499 500 501 502 503 504 505
| ---------- | ------ | ---- | ------------------------------------- |
| bundleName | string | 是   | 指示要清除其缓存数据的应用程序包名称. |

**返回值:**

| 类型          | 说明                                 |
| ------------- | ------------------------------------ |
506
| Promise\<void> | 返回值为Promise对象,Promise中为空。 |
J
junyi233 已提交
507

W
wanghang 已提交
508 509 510
## bundle.setApplicationEnabled<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.setApplicationEnabled](js-apis-bundleManager.md#bundlemanagersetapplicationenabled)替代。
J
junyi233 已提交
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529

setApplicationEnabled(bundleName: string, isEnable: boolean, callback: AsyncCallback&lt;void&gt;): void;

设置是否启用指定的应用程序

**需要权限:**

ohos.permission.CHANGE_ABILITY_ENABLED_STATE

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

J
junyi233 已提交
530
| 参数名      | 类型                | 必填 | 说明                                            |
J
junyi233 已提交
531 532 533
| ---------- | ------------------- | ---- | ----------------------------------------------- |
| bundleName | string              | 是   | 应用程序包名称。                                |
| isEnable   | boolean             | 是   | 指定是否启用应用程序。true表示启用,false禁用。 |
534
| callback   | AsyncCallback\<void> | 是   | 为返回操作结果而调用的回调。                    |
J
junyi233 已提交
535

W
wanghang 已提交
536 537 538
## bundle.setApplicationEnabled<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.setApplicationEnabled](js-apis-bundleManager.md#bundlemanagersetapplicationenabled)替代。
J
junyi233 已提交
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557

setApplicationEnabled(bundleName: string, isEnable: boolean): Promise&lt;void&gt;

设置是否启用指定的应用程序

**需要权限:**

ohos.permission.CHANGE_ABILITY_ENABLED_STATE

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

J
junyi233 已提交
558
| 参数名     | 类型    | 必填 | 说明                                            |
J
junyi233 已提交
559 560 561 562 563 564 565 566
| ---------- | ------- | ---- | ----------------------------------------------- |
| bundleName | string  | 是   | 应用程序包名称。                                |
| isEnable   | boolean | 是   | 指定是否启用应用程序。true表示启用,false禁用。 |

**返回值:**

| 类型          | 说明                                 |
| ------------- | ------------------------------------ |
567
| Promise\<void> | 返回值为Promise对象,Promise中为空。 |
J
junyi233 已提交
568

W
wanghang 已提交
569 570 571
## bundle.setAbilityEnabled<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.setAbilityEnabled](js-apis-bundleManager.md#bundlemanagersetabilityenabled)替代。
J
junyi233 已提交
572

573
setAbilityEnabled(info: AbilityInfo, isEnable: boolean, callback: AsyncCallback&lt;void&gt;): void;
J
junyi233 已提交
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590

设置是否启用指定的功能

**需要权限:**

ohos.permission.CHANGE_ABILITY_ENABLED_STATE

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

J
junyi233 已提交
591
| 参数名   | 类型                                         | 必填 | 说明                                            |
J
junyi233 已提交
592 593 594
| -------- | -------------------------------------------- | ---- | ----------------------------------------------- |
| info     | [AbilityInfo](js-apis-bundle-AbilityInfo.md) | 是   | Ability信息。                                   |
| isEnable | boolean                                      | 是   | 指定是否启用应用程序。true表示启用,false禁用。 |
J
junyi233 已提交
595
| callback | AsyncCallback\<void>                         | 是   | 为返回操作结果而调用的回调。                    |
J
junyi233 已提交
596

W
wanghang 已提交
597 598 599
## bundle.setAbilityEnabled<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.setAbilityEnabled](js-apis-bundleManager.md#bundlemanagersetabilityenabled)替代。
J
junyi233 已提交
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618

setAbilityEnabled(info: AbilityInfo, isEnable: boolean): Promise&lt;void&gt;

设置是否启用指定的功能

**需要权限:**

ohos.permission.CHANGE_ABILITY_ENABLED_STATE

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

J
junyi233 已提交
619
| 参数名   | 类型                                         | 必填 | 说明                                            |
J
junyi233 已提交
620 621 622 623 624 625 626 627
| -------- | -------------------------------------------- | ---- | ----------------------------------------------- |
| info     | [AbilityInfo](js-apis-bundle-AbilityInfo.md) | 是   | Ability信息。                                   |
| isEnable | boolean                                      | 是   | 指定是否启用应用程序。true表示启用,false禁用。 |

**返回值:**

| 类型          | 说明                                 |
| ------------- | ------------------------------------ |
628
| Promise\<void> | 返回值为Promise对象,Promise中为空。 |
J
junyi233 已提交
629

W
wanghang 已提交
630 631 632
## bundle.getPermissionDef<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.getPermissionDef](js-apis-bundleManager.md#bundlemanagergetpermissiondef)替代。
J
junyi233 已提交
633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651

getPermissionDef(permissionName: string, callback: AsyncCallback&lt;PermissionDef&gt;): void;

按权限名称获取权限的详细信息

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

J
junyi233 已提交
652
| 参数名         | 类型                                                         | 必填 | 说明                                             |
J
junyi233 已提交
653 654 655 656
| -------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------ |
| permissionName | string                                                       | 是   | 指定权限的名称。                                 |
| callback       | AsyncCallback<[PermissionDef](js-apis-bundle-PermissionDef)> | 是   | 程序启动作为入参的回调函数,返回定义的权限信息。 |

W
wanghang 已提交
657 658 659
## bundle.getPermissionDef<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.getPermissionDef](js-apis-bundleManager.md#bundlemanagergetpermissiondef)替代。
J
junyi233 已提交
660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678

getPermissionDef(permissionName: string): Promise&lt;PermissionDef&gt;

按权限名称获取权限的详细信息

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

J
junyi233 已提交
679
| 参数名         | 类型   | 必填 | 说明             |
J
junyi233 已提交
680 681 682 683 684 685 686 687 688 689
| -------------- | ------ | ---- | ---------------- |
| permissionName | string | 是   | 指定权限的名称。 |

**返回值:**

| 类型                                                   | 说明                                                   |
| ------------------------------------------------------ | ------------------------------------------------------ |
| Promise<[PermissionDef](js-apis-bundle-PermissionDef)> | 返回值为Promise对象,Promise中包含定义的权限信息对象。 |


W
wanghang 已提交
690
## bundle.getAllApplicationInfo<sup>deprecated<sup>
S
shuaiyutao 已提交
691

W
wanghang 已提交
692
> 从API version 9开始不再维护,建议使用[bundleManager.getAllApplicationInfo](js-apis-bundleManager.md#bundlemanagergetallapplicationinfo)替代。
S
shuaiyutao 已提交
693

qq_41863798's avatar
qq_41863798 已提交
694
getAllApplicationInfo(bundleFlags: number, userId?: number): Promise<Array\<ApplicationInfo>>
S
shuaiyutao 已提交
695 696 697 698 699

获取指定用户下所有已安装的应用信息,通过Promise获取返回值。

**需要权限:**

W
wanghang 已提交
700
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
S
shuaiyutao 已提交
701

702 703 704 705
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
706 707
**参数:**

J
junyi233 已提交
708
| 参数名      | 类型   | 必填 | 说明                                                         |
S
shuaiyutao 已提交
709 710 711
| ----------- | ------ | ---- | ------------------------------------------------------------ |
| bundleFlags | number | 是   | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中应用信息相关flag |
| userId      | number | 否   | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。        |
S
shuaiyutao 已提交
712 713 714

**返回值:**

H
HelloCrease 已提交
715 716
| 类型                               | 说明                              |
| -------------------------------- | ------------------------------- |
J
junyi233 已提交
717
| Promise<Array\<[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)>> | 返回值为Promise对象,Promise中包含应用信息列表。 |
S
shuaiyutao 已提交
718 719 720 721

**示例:**

```js
W
wanghang 已提交
722 723 724 725 726 727 728
let bundleFlags = 8;
let userId = 100;
bundle.getAllApplicationInfo(bundleFlags, userId)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
S
shuaiyutao 已提交
729 730 731
})
```

W
wanghang 已提交
732
## bundle.getAllApplicationInfo<sup>deprecated<sup>
S
shuaiyutao 已提交
733

W
wanghang 已提交
734
> 从API version 9开始不再维护,建议使用[bundleManager.getAllApplicationInfo](js-apis-bundleManager.md#bundlemanagergetallapplicationinfo)替代。
S
shuaiyutao 已提交
735 736 737

getAllApplicationInfo(bundleFlags: number, userId: number, callback: AsyncCallback<Array\<ApplicationInfo>>): void

738
获取指定用户下所有已安装的应用信息,使用callback形式返回结果。
S
shuaiyutao 已提交
739 740 741

**需要权限:**

W
wanghang 已提交
742
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
S
shuaiyutao 已提交
743

744 745 746 747
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
748 749
**参数:**

J
junyi233 已提交
750
| 参数名      | 类型                                                         | 必填 | 说明                                                         |
S
shuaiyutao 已提交
751 752 753 754
| ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| bundleFlags | number                                                       | 是   | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中应用信息相关flag |
| userId      | number                                                       | 否   | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。        |
| callback    | AsyncCallback<Array\<[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)>> | 是   | 程序启动作为入参的回调函数,返回应用信息列表。               |
S
shuaiyutao 已提交
755 756 757 758

**示例:**

```js
W
wanghang 已提交
759 760 761 762 763 764 765 766 767
let bundleFlags = 8;
let userId = 100;
bundle.getAllApplicationInfo(bundleFlags, userId, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})
S
shuaiyutao 已提交
768 769 770
```


W
wanghang 已提交
771 772 773
## bundle.getAllApplicationInfo<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.getAllApplicationInfo](js-apis-bundleManager.md#bundlemanagergetallapplicationinfo)替代。
qq_41863798's avatar
qq_41863798 已提交
774

qq_41863798's avatar
qq_41863798 已提交
775
getAllApplicationInfo(bundleFlags: number, callback: AsyncCallback<Array\<ApplicationInfo>>) : void;
qq_41863798's avatar
qq_41863798 已提交
776

777
获取所有已安装的应用信息,使用callback形式返回结果。
qq_41863798's avatar
qq_41863798 已提交
778 779 780 781 782 783 784 785 786 787 788

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

J
junyi233 已提交
789
| 参数名      | 类型                                                         | 必填 | 说明                                                         |
S
shuaiyutao 已提交
790 791 792
| ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| bundleFlags | number                                                       | 是   | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中应用信息相关flag |
| callback    | AsyncCallback<Array\<[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)>> | 是   | 程序启动作为入参的回调函数,返回应用信息列表。               |
qq_41863798's avatar
qq_41863798 已提交
793 794 795 796 797 798 799 800 801 802 803 804 805 806

**示例:**

```js
let bundleFlags = 8;
bundle.getAllApplicationInfo(bundleFlags, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})
```

W
wanghang 已提交
807 808 809
## bundle.getBundleArchiveInfo<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.getBundleArchiveInfo](js-apis-bundleManager.md#bundlemanagergetbundlearchiveinfo)替代。
W
wanghang 已提交
810

811
getBundleArchiveInfo(hapFilePath: string, bundleFlags: number) : Promise\<BundleInfo>
W
wanghang 已提交
812 813 814 815 816 817 818 819 820

以异步方法获取有关HAP包中包含的应用程序包的信息,使用Promise形式返回结果。

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

J
junyi233 已提交
821
| 参数名        | 类型     | 必填   | 说明           |
W
wanghang 已提交
822 823
| ---------- | ------ | ---- | ------------ |
| hapFilePath | string | 是    | HAP存放路径。路径应指向当前应用程序的数据目录的相对目录。 |
S
shuaiyutao 已提交
824
| bundleFlags | number | 是    | 用于指定要返回的BundleInfo对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag |
W
wanghang 已提交
825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843

**返回值:**
| 类型             | 说明                                     |
| -------------- | -------------------------------------- |
| Promise\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 返回值为Promise对象,Promise中包含有关hap包中包含的应用程序的信息。 |

**示例:**

```js
let hapFilePath = "/data/xxx/test.hap";
let bundleFlags = 0;
bundle.getBundleArchiveInfo(hapFilePath, bundleFlags)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})
```

W
wanghang 已提交
844 845 846
## bundle.getBundleArchiveInfo<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.getBundleArchiveInfo](js-apis-bundleManager.md#bundlemanagergetbundlearchiveinfo)替代。
W
wanghang 已提交
847

848
getBundleArchiveInfo(hapFilePath: string, bundleFlags: number, callback: AsyncCallback\<BundleInfo>) : void
W
wanghang 已提交
849 850 851 852 853 854 855 856 857

以异步方法获取有关HAP包中包含的应用程序包的信息,使用callback形式返回结果。

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

J
junyi233 已提交
858
| 参数名        | 类型     | 必填   | 说明           |
W
wanghang 已提交
859 860
| ---------- | ------ | ---- | ------------ |
| hapFilePath | string | 是    | HAP存放路径。路径应指向当前应用程序的数据目录的相对目录。 |
S
shuaiyutao 已提交
861
| bundleFlags | number | 是    | 用于指定要返回的BundleInfo对象中包含信息的标记。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中包信息相关flag |
862
| callback| AsyncCallback\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 是    | 程序启动作为入参的回调函数,返回HAP包中包含的应用程序包的信息。|
W
wanghang 已提交
863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878

**示例:**

```js
let hapFilePath = "/data/xxx/test.hap";
let bundleFlags = 0;
bundle.getBundleArchiveInfo(hapFilePath, bundleFlags, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})
```


W
wanghang 已提交
879 880 881
## bundle.getAbilityInfo<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.queryAbilityInfo](js-apis-bundleManager.md#bundlemanagerqueryabilityinfo)替代。
qq_41863798's avatar
qq_41863798 已提交
882

D
dy 已提交
883
getAbilityInfo(bundleName: string, abilityName: string): Promise\<AbilityInfo>
qq_41863798's avatar
qq_41863798 已提交
884

qq_41863798's avatar
qq_41863798 已提交
885
通过包名称和abilityName获取Ability信息,使用Promise形式返回结果。
D
dy 已提交
886 887 888

**需要权限:**

J
junyi233 已提交
889
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
D
dy 已提交
890 891 892 893 894 895 896

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

J
junyi233 已提交
897
| 参数名         | 类型     | 必填   | 说明               |
H
HelloCrease 已提交
898
| ----------- | ------ | ---- | ---------------- |
qq_41863798's avatar
qq_41863798 已提交
899 900
| bundleName  | string | 是    | 应用程序包名。     |
| abilityName | string | 是    | Ability名称。 |
D
dy 已提交
901 902 903

**返回值:**

H
HelloCrease 已提交
904 905
| 类型                    | 说明                    |
| --------------------- | --------------------- |
J
junyi233 已提交
906
| Promise\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | Promise形式返回Ability信息。 |
D
dy 已提交
907 908 909 910 911 912 913 914 915 916 917 918 919 920

**示例:**

```js
let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityInfo(bundleName, abilityName)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})
```

W
wanghang 已提交
921 922 923
## bundle.getAbilityInfo<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.queryAbilityInfo](js-apis-bundleManager.md#bundlemanagerqueryabilityinfo)替代。
D
dy 已提交
924

qq_41863798's avatar
qq_41863798 已提交
925
getAbilityInfo(bundleName: string, abilityName: string, callback: AsyncCallback\<AbilityInfo>): void;
D
dy 已提交
926

qq_41863798's avatar
qq_41863798 已提交
927
通过包名称和abilityName获取Ability信息,使用callback形式返回结果。
D
dy 已提交
928 929 930

**需要权限:**

J
junyi233 已提交
931
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
D
dy 已提交
932 933 934 935 936 937 938

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

J
junyi233 已提交
939
| 参数名        | 类型     | 必填   | 说明            |
qq_41863798's avatar
qq_41863798 已提交
940 941 942
| ----------- | ------------ | ---- | ---------------- |
| bundleName  | string | 是    | 应用程序包名。     |
| abilityName | string | 是    | Ability名称。 |
J
junyi233 已提交
943
| callback    | AsyncCallback\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 是    | 程序启动作为入参的回调函数,返回Ability信息。 |
D
dy 已提交
944 945 946 947 948 949 950 951 952 953 954 955 956 957

**示例:**

```js
let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityInfo(bundleName, abilityName, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})
```
958

W
wanghang 已提交
959 960 961 962 963
## bundle.getAbilityLabel<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.getAbilityLabel](js-apis-bundleManager.md#bundlemanagergetabilitylabel)替代。

getAbilityLabel(bundleName: string, abilityName: string): Promise\<string>
964

W
wanghang 已提交
965
通过包名称和abilityName获取应用名称,使用Promise形式返回结果。
D
dy 已提交
966 967 968

**需要权限:**

J
junyi233 已提交
969
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
D
dy 已提交
970 971 972 973 974 975 976

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

J
junyi233 已提交
977
| 参数名         | 类型     | 必填   | 说明               |
H
HelloCrease 已提交
978
| ----------- | ------ | ---- | ---------------- |
qq_41863798's avatar
qq_41863798 已提交
979 980
| bundleName  | string | 是    | 应用程序包名。     |
| abilityName | string | 是    | Ability名称。 |
D
dy 已提交
981 982 983

**返回值:**

H
HelloCrease 已提交
984 985
| 类型               | 说明                 |
| ---------------- | ------------------ |
D
dy 已提交
986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
| Promise\<string> | Promise形式返回应用名称信息。 |

**示例:**

```js
let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityLabel(bundleName, abilityName)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})
```

W
wanghang 已提交
1001 1002 1003
## bundle.getAbilityLabel<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.getAbilityLabel](js-apis-bundleManager.md#bundlemanagergetabilitylabel)替代。
D
dy 已提交
1004 1005 1006

getAbilityLabel(bundleName: string, abilityName: string, callback : AsyncCallback\<string>): void

qq_41863798's avatar
qq_41863798 已提交
1007
通过包名称和abilityName获取应用名称,使用callback形式返回结果。
D
dy 已提交
1008 1009 1010

**需要权限:**

J
junyi233 已提交
1011
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
D
dy 已提交
1012 1013 1014 1015 1016 1017 1018

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

J
junyi233 已提交
1019
| 参数名         | 类型                     | 必填   | 说明               |
H
HelloCrease 已提交
1020
| ----------- | ---------------------- | ---- | ---------------- |
qq_41863798's avatar
qq_41863798 已提交
1021 1022 1023
| bundleName  | string                 | 是    | 应用程序包名。     |
| abilityName | string                 | 是    | Ability名称。 |
| callback    | AsyncCallback\<string> | 是    | 程序启动作为入参的回调函数,返回应用名称信息。        |
D
dy 已提交
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037

**示例:**

```js
let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityLabel(bundleName, abilityName, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})
```
1038

W
wanghang 已提交
1039
## bundle.isAbilityEnabled<sup>deprecated<sup>
1040

W
wanghang 已提交
1041
> 从API version 9开始不再维护,建议使用[bundleManager.isAbilityEnabled](js-apis-bundleManager.md#bundlemanagerisabilityenabled)替代。
D
dy 已提交
1042 1043 1044

isAbilityEnabled(info: AbilityInfo): Promise\<boolean>

1045
以异步方法根据给定的AbilityInfo查询ability是否已经启用,使用Promise形式返回结果。
D
dy 已提交
1046 1047 1048 1049 1050 1051 1052

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

J
junyi233 已提交
1053 1054 1055
| 参数名 | 类型                                         | 必填 | 说明              |
| ------ | -------------------------------------------- | ---- | ----------------- |
| info   | [AbilityInfo](js-apis-bundle-AbilityInfo.md) | 是   | Ability的配置信息 |
D
dy 已提交
1056 1057 1058

**返回值:**

H
HelloCrease 已提交
1059 1060
| 类型                | 说明                        |
| ----------------- | ------------------------- |
D
dy 已提交
1061 1062 1063 1064 1065
| Promise\<boolean> | Promise形式返回boolean代表是否启用。 |

**示例:**

```js
W
wanghang 已提交
1066 1067 1068 1069 1070 1071 1072 1073
let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityInfo(bundleName, abilityName).then((abilityInfo)=>{
    bundle.isAbilityEnabled(abilityInfo).then((data) => {
        console.info('Operation successful. Data: ' + JSON.stringify(data));
    }).catch((error) => {
        console.error('Operation failed. Cause: ' + JSON.stringify(error));
    })
D
dy 已提交
1074 1075 1076
})
```

W
wanghang 已提交
1077 1078 1079
## bundle.isAbilityEnabled<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.isAbilityEnabled](js-apis-bundleManager.md#bundlemanagerisabilityenabled)替代。
D
dy 已提交
1080 1081 1082

isAbilityEnabled(info : AbilityInfo, callback : AsyncCallback\<boolean>): void

1083
以异步方法根据给定的AbilityInfo查询ability是否已经启用,使用callback形式返回结果。
D
dy 已提交
1084 1085 1086 1087 1088 1089 1090

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

J
junyi233 已提交
1091 1092 1093 1094
| 参数名   | 类型                                         | 必填 | 说明                    |
| -------- | -------------------------------------------- | ---- | ----------------------- |
| info     | [AbilityInfo](js-apis-bundle-AbilityInfo.md) | 是   | Ability的配置信息       |
| callback | AsyncCallback\<boolean>                      | 是   | 返回boolean代表是否启用 |
D
dy 已提交
1095 1096 1097 1098

**示例:**

```js
W
wanghang 已提交
1099 1100 1101 1102
let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityInfo(bundleName, abilityName).then((abilityInfo)=>{
    bundle.isAbilityEnabled(abilityInfo, (err, data) => {
D
dy 已提交
1103 1104 1105 1106 1107
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
W
wanghang 已提交
1108
    })
D
dy 已提交
1109 1110 1111
})
```

W
wanghang 已提交
1112 1113 1114
## bundle.isApplicationEnabled<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.isApplicationEnabled](js-apis-bundleManager.md#bundlemanagerisapplicationenabled)替代。
D
dy 已提交
1115 1116 1117

isApplicationEnabled(bundleName: string): Promise\<boolean>

1118
以异步方法根据给定的bundleName查询指定应用程序是否已经启用,使用Promise形式返回结果。
D
dy 已提交
1119 1120 1121 1122 1123 1124 1125

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

J
junyi233 已提交
1126 1127 1128
| 参数名     | 类型   | 必填 | 说明                     |
| ---------- | ------ | ---- | ------------------------ |
| bundleName | string | 是   | 要查询的应用程序包名称。 |
D
dy 已提交
1129 1130 1131

**返回值:**

H
HelloCrease 已提交
1132 1133
| 类型                | 说明                        |
| ----------------- | ------------------------- |
D
dy 已提交
1134 1135 1136 1137 1138
| Promise\<boolean> | Promise形式返回boolean代表是否启用。 |

**示例:**

```js
qq_41863798's avatar
api 9  
qq_41863798 已提交
1139 1140
let bundleName = "com.example.myapplication";
bundle.isApplicationEnabled(bundleName)
D
dy 已提交
1141 1142 1143 1144 1145 1146 1147
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})
```

W
wanghang 已提交
1148 1149 1150
## bundle.isApplicationEnabled<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.isApplicationEnabled](js-apis-bundleManager.md#bundlemanagerisapplicationenabled)替代。
D
dy 已提交
1151 1152 1153

isApplicationEnabled(bundleName: string, callback : AsyncCallback\<boolean>): void

1154
以异步方法根据给定的bundleName查询指定应用程序是否已经启用,使用callback形式返回结果。
D
dy 已提交
1155 1156 1157 1158 1159 1160 1161

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

J
junyi233 已提交
1162 1163 1164 1165
| 参数名     | 类型                    | 必填 | 说明                     |
| ---------- | ----------------------- | ---- | ------------------------ |
| bundleName | string                  | 是   | 要查询的应用程序包名称。 |
| callback   | AsyncCallback\<boolean> | 是   | 返回boolean代表是否启用  |
D
dy 已提交
1166 1167 1168 1169

**示例:**

```js
H
HelloCrease 已提交
1170
let bundleName = "com.example.myapplication";
D
dy 已提交
1171 1172 1173 1174 1175 1176 1177 1178
bundle.isApplicationEnabled(bundleName, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})
```
S
shuaiyutao 已提交
1179

W
wanghang 已提交
1180 1181 1182
## bundle.queryAbilityByWant<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.queryAbilityInfo](js-apis-bundleManager.md#bundlemanagerqueryabilityinfo)替代。
S
shuaiyutao 已提交
1183 1184 1185 1186 1187 1188 1189

queryAbilityByWant(want: Want, bundleFlags: number, userId?: number): Promise<Array\<AbilityInfo>>

以异步方法根据给定的意图获取Ability信息,使用Promise形式返回结果。

**需要权限:**

J
junyi233 已提交
1190
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
S
shuaiyutao 已提交
1191

1192 1193 1194 1195
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
1196 1197
**参数:**

J
junyi233 已提交
1198
| 参数名         | 类型     | 必填   | 说明                                    |
H
HelloCrease 已提交
1199
| ----------- | ------ | ---- | ------------------------------------- |
J
junyi233 已提交
1200
| want        | [Want](js-apis-application-Want.md)   | 是    | 包含要查询的应用程序包名称的意图。                     |
S
shuaiyutao 已提交
1201
| bundleFlags | number | 是    | 用于指定返回abilityInfo信息。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中Ability信息相关flag |
H
HelloCrease 已提交
1202
| userId      | number | 否    | 用户ID。默认值:调用方所在用户,取值范围:大于等于0           |
S
shuaiyutao 已提交
1203 1204 1205

**返回值:**

H
HelloCrease 已提交
1206 1207
| 类型                           | 说明                    |
| ---------------------------- | --------------------- |
J
junyi233 已提交
1208
| Promise<Array\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)>> | Promise形式返回Ability信息。 |
S
shuaiyutao 已提交
1209 1210 1211 1212

**示例:**

```js
W
wanghang 已提交
1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223
let bundleFlags = 0;
let userId = 100;
let want = {
    bundleName : "com.example.myapplication",
    abilityName : "com.example.myapplication.MainAbility"
};
bundle.queryAbilityByWant(want, bundleFlags, userId)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
S
shuaiyutao 已提交
1224 1225 1226 1227 1228
})
```



W
wanghang 已提交
1229 1230 1231
## bundle.queryAbilityByWant<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.queryAbilityInfo](js-apis-bundleManager.md#bundlemanagerqueryabilityinfo)替代。
S
shuaiyutao 已提交
1232 1233 1234

queryAbilityByWant(want: Want, bundleFlags: number, userId: number, callback: AsyncCallback<Array\<AbilityInfo>>): void

1235
以异步方法根据给定的意图获取指定用户下Ability信息,使用callback形式返回结果。
S
shuaiyutao 已提交
1236

J
junyi233 已提交
1237 1238 1239 1240
**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

X
xuezhongzhu 已提交
1241 1242 1243 1244
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
1245 1246
**参数:**

J
junyi233 已提交
1247
| 参数名      | 类型                                                         | 必填 | 说明                                                         |
S
shuaiyutao 已提交
1248 1249 1250 1251 1252
| ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| want        | [Want](js-apis-application-Want.md)                          | 是   | 指示包含要查询的应用程序包名称的意图。                       |
| bundleFlags | number                                                       | 是   | 用于指定返回abilityInfo信息。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中Ability信息相关flag |
| userId      | number                                                       | 是   | 用户ID。默认值:调用方所在用户,取值范围:大于等于0          |
| callback    | AsyncCallback<Array\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)>> | 是   | 程序启动作为入参的回调函数,返回Ability信息。                |
S
shuaiyutao 已提交
1253 1254 1255 1256

**示例:**

```js
W
wanghang 已提交
1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269
let bundleFlags = 0;
let userId = 100;
let want = {
    bundleName : "com.example.myapplication",
    abilityName : "com.example.myapplication.MainAbility"
};
bundle.queryAbilityByWant(want, bundleFlags, userId, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})
S
shuaiyutao 已提交
1270 1271
```

W
wanghang 已提交
1272 1273 1274
## bundle.queryAbilityByWant<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.queryAbilityInfo](js-apis-bundleManager.md#bundlemanagerqueryabilityinfo)替代。
S
shuaiyutao 已提交
1275

qq_41863798's avatar
qq_41863798 已提交
1276
queryAbilityByWant(want: Want, bundleFlags: number, callback: AsyncCallback<Array\<AbilityInfo>>): void;
S
shuaiyutao 已提交
1277 1278 1279

以异步方法根据给定的意图获取Ability信息,使用callback形式返回结果。

J
junyi233 已提交
1280 1281 1282 1283
**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

X
xuezhongzhu 已提交
1284 1285 1286 1287
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
1288 1289
**参数:**

J
junyi233 已提交
1290
| 参数名      | 类型                                                         | 必填 | 说明                                                         |
S
shuaiyutao 已提交
1291 1292 1293 1294
| ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| want        | [Want](js-apis-application-Want.md)                          | 是   | 指示包含要查询的应用程序包名称的意图。                       |
| bundleFlags | number                                                       | 是   | 用于指定返回abilityInfo信息。默认值:0,取值范围:参考[BundleFlag说明](#bundleflag)中Ability信息相关flag |
| callback    | AsyncCallback<Array\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)>> | 是   | 程序启动作为入参的回调函数,返回Ability信息。                |
S
shuaiyutao 已提交
1295 1296 1297 1298

**示例:**

```js
W
wanghang 已提交
1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310
let bundleFlags = 0;
let want = {
    bundleName : "com.example.myapplication",
    abilityName : "com.example.myapplication.MainAbility"
};
bundle.queryAbilityByWant(want, bundleFlags, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})
S
shuaiyutao 已提交
1311 1312 1313 1314
```



W
wanghang 已提交
1315 1316 1317
## bundle.getLaunchWantForBundle<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.getLaunchWantForBundle](js-apis-bundleManager.md#bundlemanagergetlaunchwantforbundle)替代。
S
shuaiyutao 已提交
1318

W
wanghang 已提交
1319 1320 1321
getLaunchWantForBundle(bundleName: string): Promise\<Want>

以异步方法查询拉起指定应用的want对象,使用Promise形式返回结果。
S
shuaiyutao 已提交
1322

W
wanghang 已提交
1323 1324 1325 1326
**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

1327 1328 1329 1330
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
1331 1332
**参数:**

J
junyi233 已提交
1333 1334 1335
| 参数名     | 类型   | 必填 | 说明                     |
| ---------- | ------ | ---- | ------------------------ |
| bundleName | string | 是   | 要查询的应用程序包名称。 |
S
shuaiyutao 已提交
1336 1337

**返回值:**
H
HelloCrease 已提交
1338 1339
| 类型             | 说明                                     |
| -------------- | -------------------------------------- |
J
junyi233 已提交
1340
| Promise\<[Want](js-apis-application-Want.md)> | 返回值为Promise对象,Promise中包含拉起指定应用的Want对象。 |
S
shuaiyutao 已提交
1341 1342 1343 1344

**示例:**

```js
W
wanghang 已提交
1345 1346 1347 1348 1349 1350 1351
let bundleName = "com.example.myapplication";
bundle.getLaunchWantForBundle(bundleName)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})
S
shuaiyutao 已提交
1352 1353
```

W
wanghang 已提交
1354 1355 1356
## bundle.getLaunchWantForBundle<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.getLaunchWantForBundle](js-apis-bundleManager.md#bundlemanagergetlaunchwantforbundle)替代。
S
shuaiyutao 已提交
1357

qq_41863798's avatar
api 9  
qq_41863798 已提交
1358
getLaunchWantForBundle(bundleName: string, callback: AsyncCallback\<Want>): void;
S
shuaiyutao 已提交
1359

W
wanghang 已提交
1360
以异步方法查询拉起指定应用的want对象,使用callback形式返回结果。
S
shuaiyutao 已提交
1361

W
wanghang 已提交
1362 1363 1364 1365
**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

1366 1367 1368 1369
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
1370 1371
**参数:**

J
junyi233 已提交
1372 1373 1374 1375
| 参数名     | 类型                                                | 必填 | 说明                                                     |
| ---------- | --------------------------------------------------- | ---- | -------------------------------------------------------- |
| bundleName | string                                              | 是   | 要查询的应用程序包名称。                                 |
| callback   | AsyncCallback\<[Want](js-apis-application-Want.md)> | 是   | 程序启动作为入参的回调函数,返回拉起指定应用的want对象。 |
S
shuaiyutao 已提交
1376 1377 1378 1379

**示例:**

```js
W
wanghang 已提交
1380 1381 1382 1383 1384 1385 1386 1387
let bundleName = "com.example.myapplication";
bundle.getLaunchWantForBundle(bundleName, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})
S
shuaiyutao 已提交
1388 1389 1390
```


W
wanghang 已提交
1391 1392 1393
## bundle.getNameForUid<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.getBundleNameByUid](js-apis-bundleManager.md#bundlemanagergetbundlenamebyuid)替代。
W
wanghang 已提交
1394 1395

getNameForUid(uid: number): Promise\<string>
S
shuaiyutao 已提交
1396

W
wanghang 已提交
1397
以异步方法通过uid获取对应的包名,使用Promise形式返回结果。
S
shuaiyutao 已提交
1398

X
xuezhongzhu 已提交
1399 1400 1401 1402
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
1403 1404
**参数:**

J
junyi233 已提交
1405 1406 1407
| 参数名 | 类型   | 必填 | 说明          |
| ------ | ------ | ---- | ------------- |
| uid    | number | 是   | 要查询的uid。 |
S
shuaiyutao 已提交
1408 1409

**返回值:**
H
HelloCrease 已提交
1410 1411
| 类型               | 说明                                |
| ---------------- | --------------------------------- |
W
wanghang 已提交
1412
| Promise\<string> | 返回值为Promise对象,Promise中包含指定uid的包名。 |
S
shuaiyutao 已提交
1413 1414 1415 1416

**示例:**

```js
W
wanghang 已提交
1417 1418 1419 1420 1421 1422 1423
let uid = 20010005;
bundle.getNameForUid(uid)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})
S
shuaiyutao 已提交
1424 1425
```

W
wanghang 已提交
1426 1427 1428
## bundle.getNameForUid<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.getBundleNameByUid](js-apis-bundleManager.md#bundlemanagergetbundlenamebyuid)替代。
S
shuaiyutao 已提交
1429

qq_41863798's avatar
qq_41863798 已提交
1430
getNameForUid(uid: number, callback: AsyncCallback\<string>) : void
S
shuaiyutao 已提交
1431

W
wanghang 已提交
1432
以异步方法通过uid获取对应的包名,使用callback形式返回结果。
S
shuaiyutao 已提交
1433

X
xuezhongzhu 已提交
1434 1435 1436 1437
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
1438 1439
**参数:**

J
junyi233 已提交
1440 1441 1442 1443
| 参数名   | 类型                   | 必填 | 说明                                            |
| -------- | ---------------------- | ---- | ----------------------------------------------- |
| uid      | number                 | 是   | 要查询的uid。                                   |
| callback | AsyncCallback\<string> | 是   | 程序启动作为入参的回调函数,返回指定uid的包名。 |
S
shuaiyutao 已提交
1444 1445 1446 1447

**示例:**

```js
W
wanghang 已提交
1448 1449 1450 1451 1452 1453 1454 1455
let uid = 20010005;
bundle.getNameForUid(uid, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})
S
shuaiyutao 已提交
1456 1457
```

qq_41863798's avatar
qq_41863798 已提交
1458

W
wanghang 已提交
1459 1460 1461
## bundle.getAbilityIcon<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.getAbilityIcon](js-apis-bundleManager.md#bundlemanagergetabilityicon)替代。
qq_41863798's avatar
qq_41863798 已提交
1462

qq_41863798's avatar
qq_41863798 已提交
1463
getAbilityIcon(bundleName: string, abilityName: string): Promise\<image.PixelMap>;
qq_41863798's avatar
qq_41863798 已提交
1464

1465
以异步方法通过bundleName和abilityName获取对应Icon的[PixelMap](js-apis-image.md),使用Promise形式返回结果。
qq_41863798's avatar
qq_41863798 已提交
1466

qq_41863798's avatar
qq_41863798 已提交
1467 1468
**需要权限:**

J
junyi233 已提交
1469
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
qq_41863798's avatar
qq_41863798 已提交
1470 1471 1472 1473 1474

**系统能力:**

SystemCapability.BundleManager.BundleFramework

qq_41863798's avatar
qq_41863798 已提交
1475 1476
**参数:**

J
junyi233 已提交
1477 1478 1479 1480
| 参数名      | 类型   | 必填 | 说明                  |
| ----------- | ------ | ---- | --------------------- |
| bundleName  | string | 是   | 要查询的bundleName。  |
| abilityName | string | 是   | 要查询的abilityName。 |
qq_41863798's avatar
qq_41863798 已提交
1481 1482 1483 1484

**返回值:**
| 类型                  | 说明                                                         |
| --------------------- | ------------------------------------------------------------ |
1485
| Promise\<image.PixelMap> | 返回值为[PixelMap](js-apis-image.md)。 |
qq_41863798's avatar
qq_41863798 已提交
1486 1487 1488 1489

**示例:**

```js
1490 1491
let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
qq_41863798's avatar
qq_41863798 已提交
1492 1493 1494 1495 1496 1497 1498 1499
bundle.getAbilityIcon(bundleName, abilityName)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})
```

W
wanghang 已提交
1500 1501 1502
## bundle.getAbilityIcon<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.getAbilityIcon](js-apis-bundleManager.md#bundlemanagergetabilityicon)替代。
qq_41863798's avatar
qq_41863798 已提交
1503

qq_41863798's avatar
qq_41863798 已提交
1504
getAbilityIcon(bundleName: string, abilityName: string, callback: AsyncCallback\<image.PixelMap>): void;
qq_41863798's avatar
qq_41863798 已提交
1505

1506
以异步方法通过bundleName和abilityName获取对应Icon的[PixelMap](js-apis-image.md),使用callback形式返回结果。
qq_41863798's avatar
qq_41863798 已提交
1507

qq_41863798's avatar
qq_41863798 已提交
1508 1509
**需要权限:**

J
junyi233 已提交
1510
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
qq_41863798's avatar
qq_41863798 已提交
1511 1512 1513 1514 1515

**系统能力:**

SystemCapability.BundleManager.BundleFramework

qq_41863798's avatar
qq_41863798 已提交
1516 1517
**参数:**

J
junyi233 已提交
1518
| 参数名         | 类型                                       | 必填   | 说明                                       |
qq_41863798's avatar
qq_41863798 已提交
1519 1520 1521
| ----------- | ---------------------------------------- | ---- | ---------------------------------------- |
| bundleName  | string                                   | 是    | 要查询的bundleName。                          |
| abilityName | string                                   | 是    | 要查询的abilityName。                         |
1522
| callback   | AsyncCallback\<image.PixelMap> | 是   | 程序启动作为入参的回调函数,返回指定[PixelMap](js-apis-image.md)。 |
qq_41863798's avatar
qq_41863798 已提交
1523 1524 1525 1526

**示例:**

```js
1527 1528
let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
qq_41863798's avatar
qq_41863798 已提交
1529 1530 1531 1532 1533 1534 1535 1536 1537
bundle.getAbilityIcon(bundleName, abilityName, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})
```

W
wanghang 已提交
1538 1539
## InstallErrorCode<sup>deprecated<sup>
> 从API version 9开始不再维护,不推荐使用。
S
shuaiyutao 已提交
1540

qq_41863798's avatar
api 9  
qq_41863798 已提交
1541
 **系统能力:** SystemCapability.BundleManager.BundleFramework
X
xuezhongzhu 已提交
1542

J
junyi233 已提交
1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564
| 名称                                                 | 值   | 说明                                             |
| ---------------------------------------------------- | ---- | ------------------------------------------------ |
| SUCCESS                                              | 0    | 安装成功                                         |
| STATUS_INSTALL_FAILURE                               | 1    | 安装失败(不存在安装的应用)                     |
| STATUS_INSTALL_FAILURE_ABORTED                       | 2    | 安装中止                                         |
| STATUS_INSTALL_FAILURE_INVALID                       | 3    | 安装参数无效                                     |
| STATUS_INSTALL_FAILURE_CONFLICT                      | 4    | 安装冲突 (常见于升级和已有应用基本信息不一致)  |
| STATUS_INSTALL_FAILURE_STORAGE                       | 5    | 存储包信息失败                                   |
| STATUS_INSTALL_FAILURE_INCOMPATIBLE                  | 6    | 安装不兼容(常见于版本降级安装或者签名信息错误) |
| STATUS_UNINSTALL_FAILURE                             | 7    | 卸载失败 (不存在卸载的应用)                    |
| STATUS_UNINSTALL_FAILURE_BLOCKED                     | 8    | 卸载中止 (没有使用)                            |
| STATUS_UNINSTALL_FAILURE_ABORTED                     | 9    | 卸载中止 (参数无效导致)                        |
| STATUS_UNINSTALL_FAILURE_CONFLICT                    | 10   | 卸载冲突 (卸载系统应用失败, 结束应用进程失败) |
| STATUS_INSTALL_FAILURE_DOWNLOAD_TIMEOUT              | 0x0B | 安装失败 (下载超时)                            |
| STATUS_INSTALL_FAILURE_DOWNLOAD_FAILED               | 0x0C | 安装失败 (下载失败)                            |
| STATUS_RECOVER_FAILURE_INVALID<sup>8+</sup>          | 0x0D | 恢复预置应用失败                                 |
| STATUS_ABILITY_NOT_FOUND                             | 0x40 | Ability未找到                                    |
| STATUS_BMS_SERVICE_ERROR                             | 0x41 | BMS服务错误                                      |
| STATUS_FAILED_NO_SPACE_LEFT<sup>8+</sup>             | 0x42 | 设备空间不足                                     |
| STATUS_GRANT_REQUEST_PERMISSIONS_FAILED<sup>8+</sup> | 0x43 | 应用授权失败                                     |
| STATUS_INSTALL_PERMISSION_DENIED<sup>8+</sup>        | 0x44 | 缺少安装权限                                     |
| STATUS_UNINSTALL_PERMISSION_DENIED<sup>8+</sup>      | 0x45 | 缺少卸载权限                                     |
W
wanghang 已提交
1565

W
wanghang 已提交
1566 1567 1568
## BundleFlag<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.BundleFlag](js-apis-bundleManager.md#bundleflag)替代。
W
wanghang 已提交
1569 1570 1571

包的标志

qq_41863798's avatar
api 9  
qq_41863798 已提交
1572
 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
X
xuezhongzhu 已提交
1573

J
junyi233 已提交
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587
| 名称                                            | 值         | 说明                            |
| ----------------------------------------------- | ---------- | ------------------------------- |
| GET_BUNDLE_DEFAULT                              | 0x00000000 | 获取默认的应用信息              |
| GET_BUNDLE_WITH_ABILITIES                       | 0x00000001 | 获取包括Ability信息的包信息     |
| GET_ABILITY_INFO_WITH_PERMISSION                | 0x00000002 | 获取包括权限的Ability信息       |
| GET_ABILITY_INFO_WITH_APPLICATION               | 0x00000004 | 获取包括Application的ability信息       |
| GET_APPLICATION_INFO_WITH_PERMISSION            | 0x00000008 | 获取包括权限的应用信息          |
| GET_BUNDLE_WITH_REQUESTED_PERMISSION            | 0x00000010 | 获取包括所需权限的包信息        |
| GET_ABILITY_INFO_WITH_METADATA<sup>8+</sup>     | 0x00000020 | 获取ability的元数据信息         |
| GET_APPLICATION_INFO_WITH_METADATA<sup>8+</sup> | 0x00000040 | 获取应用的元数据信息            |
| GET_ABILITY_INFO_SYSTEMAPP_ONLY<sup>8+</sup>    | 0x00000080 | 获取仅包括系统应用的ability信息 |
| GET_ABILITY_INFO_WITH_DISABLE<sup>8+</sup>      | 0x00000100 | 获取包括被禁用的ability信息     |
| GET_APPLICATION_INFO_WITH_DISABLE<sup>8+</sup>  | 0x00000200 | 获取包括被禁用的应用信息        |
| GET_ALL_APPLICATION_INFO                        | 0xFFFF0000 | 获取应用所有的信息              |
W
wanghang 已提交
1588

W
wanghang 已提交
1589 1590
## BundleOptions<sup>deprecated<sup>
> 从API version 9开始不再维护,不推荐使用。
W
wanghang 已提交
1591 1592 1593

包的选项

qq_41863798's avatar
api 9  
qq_41863798 已提交
1594
 **系统能力:** SystemCapability.BundleManager.BundleFramework
X
xuezhongzhu 已提交
1595

J
junyi233 已提交
1596 1597 1598
| 参数名 | 类型   | 可读 | 可写 | 说明                                                  |
| ------ | ------ | ---- | ---- | ----------------------------------------------------- |
| userId | number | 是   | 是   | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 |
W
wanghang 已提交
1599

W
wanghang 已提交
1600 1601 1602
## AbilityType<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.AbilityType](js-apis-bundleManager.md#abilitytype)替代。
W
wanghang 已提交
1603

W
wanghang 已提交
1604 1605
Ability类型

qq_41863798's avatar
api 9  
qq_41863798 已提交
1606
 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
X
xuezhongzhu 已提交
1607

J
junyi233 已提交
1608 1609 1610 1611 1612 1613
| 参数名  | 类型 | 说明                        |
| ------- | ---- | --------------------------- |
| UNKNOWN | 无   | 未知Ability类型             |
| PAGE    | 无   | 表示基于Page模板开发的FA,用于提供与用户交互的能力        |
| SERVICE | 无   | 表示基于Service模板开发的PA,用于提供后台运行任务的能力           |
| DATA    | 无   | 表示基于Data模板开发的PA,用于对外部提供统一的数据访问对象 |
W
wanghang 已提交
1614

W
wanghang 已提交
1615 1616 1617
## DisplayOrientation<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.DisplayOrientation](js-apis-bundleManager.md#displayorientation)替代。
W
wanghang 已提交
1618

W
wanghang 已提交
1619 1620
屏幕显示方向

qq_41863798's avatar
api 9  
qq_41863798 已提交
1621
 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
X
xuezhongzhu 已提交
1622

J
junyi233 已提交
1623 1624 1625 1626 1627 1628
| 参数名        | 类型 | 说明                     |
| ------------- | ---- | ------------------------ |
| UNSPECIFIED   | 无   | 屏幕方向--不指定         |
| LANDSCAPE     | 无   | 屏幕方向--横屏           |
| PORTRAIT      | 无   | 屏幕方向--竖屏           |
| FOLLOW_RECENT | 无   | 屏幕方向--紧跟上一个组件 |
W
wanghang 已提交
1629 1630 1631
## LaunchMode<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.LaunchType](js-apis-bundleManager.md#launchtype)替代。
W
wanghang 已提交
1632

W
wanghang 已提交
1633 1634
启动模式

qq_41863798's avatar
api 9  
qq_41863798 已提交
1635
 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
X
xuezhongzhu 已提交
1636

J
junyi233 已提交
1637 1638 1639 1640
| 参数名    | 类型 | 说明                |
| --------- | ---- | ------------------- |
| SINGLETON | 0    | Ability只有一个实例 |
| STANDARD  | 1    | Ability有多个实例   |
W
wanghang 已提交
1641

W
wanghang 已提交
1642 1643
## AbilitySubType<sup>deprecated<sup>
> 从API version 9开始不再维护,不推荐使用。
W
wanghang 已提交
1644 1645 1646

Ability的子类型

qq_41863798's avatar
api 9  
qq_41863798 已提交
1647
 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
X
xuezhongzhu 已提交
1648

J
junyi233 已提交
1649 1650 1651
| 参数名      | 类型 | 说明                          |
| ----------- | ---- | ----------------------------- |
| UNSPECIFIED | 0    | 未定义Ability子类型           |
W
wanghang 已提交
1652
| CA          | 1    | Ability子类型是带有 UI 的服务 |
qq_41863798's avatar
api 9  
qq_41863798 已提交
1653

W
wanghang 已提交
1654 1655
## ColorMode<sup>deprecated<sup>
> 从API version 9开始不再维护,不推荐使用。
qq_41863798's avatar
qq_41863798 已提交
1656 1657 1658 1659 1660

颜色模式

 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework

J
junyi233 已提交
1661 1662
| 参数名     | 类型 | 说明     |
| ---------- | ---- | -------- |
H
HelloCrease 已提交
1663
| AUTO_MODE  | -1   | 自动模式 |
qq_41863798's avatar
qq_41863798 已提交
1664 1665
| DARK_MODE  | 0    | 黑色模式 |
| LIGHT_MODE | 1    | 亮度模式 |
qq_41863798's avatar
qq_41863798 已提交
1666 1667


W
wanghang 已提交
1668 1669 1670
## GrantStatus<sup>deprecated<sup>

> 从API version 9开始不再维护,建议使用[bundleManager.PermissionGrantState](js-apis-bundleManager.md#permissiongrantstate)替代。
qq_41863798's avatar
qq_41863798 已提交
1671 1672 1673 1674 1675

授予状态

 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework

J
junyi233 已提交
1676 1677 1678 1679
| 参数名             | 类型 | 说明         |
| ------------------ | ---- | ------------ |
| PERMISSION_DENIED  | -1   | 拒绝授予权限 |
| PERMISSION_GRANTED | 0    | 授予权限     |