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

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

5 6
> **说明:**
> 
S
shuaiyutao 已提交
7 8
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 
> API9 当前为Canary版本,仅供试用,不保证接口可稳定调用。
S
shuaiyutao 已提交
9 10
## 导入模块

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

## 系统能力

SystemCapability.BundleManager.BundleFramework

## 权限列表

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

权限等级参考[权限等级说明](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/security/accesstoken-overview.md#%E6%9D%83%E9%99%90%E7%AD%89%E7%BA%A7%E8%AF%B4%E6%98%8E)
S
shuaiyutao 已提交
29 30 31

## bundle.getApplicationInfo

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

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

**需要权限:**

J
junyi233 已提交
38
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
S
shuaiyutao 已提交
39

40 41 42 43
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
44 45
**参数:**

H
HelloCrease 已提交
46 47 48 49 50
| 名称          | 类型     | 必填   | 描述                                      |
| ----------- | ------ | ---- | --------------------------------------- |
| bundleName  | string | 是    | 要查询的应用程序包名称。                            |
| bundleFlags | number | 是    | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
| userId      | number | 否    | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。            |
S
shuaiyutao 已提交
51 52 53

**返回值:**

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

**示例:**

```js
W
wanghang 已提交
61 62 63 64 65 66 67 68
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 已提交
69 70 71 72 73 74 75
})
```

## bundle.getApplicationInfo

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

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

**需要权限:**

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

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

SystemCapability.BundleManager.BundleFramework

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

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

**示例:**

```js
W
wanghang 已提交
98 99 100 101 102 103 104 105 106 107
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 已提交
108 109
```

qq_41863798's avatar
qq_41863798 已提交
110 111 112 113 114 115 116 117
## bundle.getApplicationInfo

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

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

**需要权限:**

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

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

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

**示例:**

```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));
 })
```

S
shuaiyutao 已提交
146 147
## bundle.getAllBundleInfo

W
wanghang 已提交
148
getAllBundleInfo(bundleFlag: BundleFlag, userId?: number): Promise<Array\<BundleInfo>>
S
shuaiyutao 已提交
149 150 151 152 153 154 155

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

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

156 157 158 159
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
160 161
**参数:**

H
HelloCrease 已提交
162 163 164 165
| 名称         | 类型         | 必填   | 描述                                      |
| ---------- | ---------- | ---- | --------------------------------------- |
| bundleFlag | BundleFlag | 是    | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
| userId     | number     | 否    | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。            |
S
shuaiyutao 已提交
166 167 168

**返回值:**

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

**示例:**

```js
W
wanghang 已提交
176 177 178 179 180 181 182
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 已提交
183 184 185 186 187 188 189 190 191 192 193 194 195
})
```

## bundle.getAllBundleInfo

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

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

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

196 197 198 199
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
200 201
**参数:**

H
HelloCrease 已提交
202 203 204
| 名称         | 类型                                | 必填   | 描述                                      |
| ---------- | --------------------------------- | ---- | --------------------------------------- |
| bundleFlag | BundleFlag                        | 是    | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
J
junyi233 已提交
205
| callback   | AsyncCallback<Array\<[BundleInfo](js-apis-bundle-BundleInfo.md)>> | 是    | 程序启动作为入参的回调函数,返回所有可用的BundleInfo。        |
S
shuaiyutao 已提交
206 207 208 209

**示例:**

```js
W
wanghang 已提交
210 211 212 213 214 215 216 217 218
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 已提交
219

W
wanghang 已提交
220 221 222 223
## bundle.getAllBundleInfo

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

224
以异步方法获取系统中指定用户下所有可用的BundleInfo,使用callback形式返回结果。
W
wanghang 已提交
225 226 227 228 229

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

230 231 232 233
**系统能力:**

SystemCapability.BundleManager.BundleFramework

W
wanghang 已提交
234 235
**参数:**

H
HelloCrease 已提交
236 237 238 239
| 名称         | 类型                                | 必填   | 描述                                      |
| ---------- | --------------------------------- | ---- | --------------------------------------- |
| bundleFlag | BundleFlag                        | 是    | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
| userId     | number                            | 是    | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。            |
J
junyi233 已提交
240
| callback   | AsyncCallback<Array\<[BundleInfo](js-apis-bundle-BundleInfo.md)>> | 是    | 程序启动作为入参的回调函数,返回所有可用的BundleInfo。        |
W
wanghang 已提交
241 242 243 244 245 246 247 248 249 250 251 252 253

**示例:**

```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 已提交
254 255 256 257
```

## bundle.getBundleInfo

W
wanghang 已提交
258
getBundleInfo(bundleName: string, bundleFlags: number, options?: BundleOptions): Promise\<BundleInfo>
S
shuaiyutao 已提交
259 260 261 262 263

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

**需要权限:**

J
junyi233 已提交
264
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
S
shuaiyutao 已提交
265

266 267 268 269
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
270 271
**参数:**

H
HelloCrease 已提交
272 273 274 275
| 名称          | 类型            | 必填   | 描述                                      |
| ----------- | ------------- | ---- | --------------------------------------- |
| bundleName  | string        | 是    | 包名                                      |
| bundleFlags | number        | 是    | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
J
junyi233 已提交
276
| options     | [BundleOptions](#bundleoptions) | 否    | 包含userid。                               |
S
shuaiyutao 已提交
277 278 279

**返回值:**

H
HelloCrease 已提交
280 281
| 类型                   | 说明                           |
| -------------------- | ---------------------------- |
J
junyi233 已提交
282
| Promise\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 返回值为Promise对象,Promise中包含包信息。 |
S
shuaiyutao 已提交
283 284 285 286

**示例:**

```js
W
wanghang 已提交
287 288 289
let bundleName = "com.example.myapplication";
let bundleFlags = 1;
let options = {
qq_41863798's avatar
qq_41863798 已提交
290
  "userId" : 100
W
wanghang 已提交
291 292 293 294 295 296
};
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 已提交
297 298 299 300 301 302 303 304 305 306 307
})
```

## bundle.getBundleInfo

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

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

**需要权限:**

J
junyi233 已提交
308
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
S
shuaiyutao 已提交
309

310 311 312 313
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
314 315
**参数:**

H
HelloCrease 已提交
316 317 318 319
| 名称          | 类型                         | 必填   | 描述                                      |
| ----------- | -------------------------- | ---- | --------------------------------------- |
| bundleName  | string                     | 是    | 包名                                      |
| bundleFlags | number                     | 是    | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
J
junyi233 已提交
320
| callback    | AsyncCallback\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 是    | 程序启动作为入参的回调函数,返回包信息。                    |
S
shuaiyutao 已提交
321 322 323 324

**示例:**

```js
W
wanghang 已提交
325 326 327 328 329 330 331 332 333
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 已提交
334 335 336
```


W
wanghang 已提交
337 338 339 340 341 342 343 344
## bundle.getBundleInfo

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

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

**需要权限:**

J
junyi233 已提交
345
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
W
wanghang 已提交
346

347 348 349 350
**系统能力:**

SystemCapability.BundleManager.BundleFramework

W
wanghang 已提交
351 352
**参数:**

H
HelloCrease 已提交
353 354 355 356
| 名称          | 类型                         | 必填   | 描述                                      |
| ----------- | -------------------------- | ---- | --------------------------------------- |
| bundleName  | string                     | 是    | 包名                                      |
| bundleFlags | number                     | 是    | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
J
junyi233 已提交
357 358
| options     | [BundleOptions](#bundleoptions)              | 是    | 包含userid。                               |
| callback    | AsyncCallback\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 是    | 程序启动作为入参的回调函数,返回包信息。                    |
W
wanghang 已提交
359 360 361 362 363 364 365

**示例:**

```js
let bundleName = "com.example.myapplication";
let bundleFlags = 1;
let options = {
qq_41863798's avatar
qq_41863798 已提交
366
  "userId" : 100
W
wanghang 已提交
367 368 369 370 371 372 373 374 375 376
};
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));
})
```

J
junyi233 已提交
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836
## bundle.getBundleInstaller

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

获取用于安装包的接口

**需要权限:**

ohos.permission.INSTALL_BUNDLE

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**返回值:**

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

## bundle.getBundleInstaller

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

获取用于安装包的接口

**需要权限:**

ohos.permission.INSTALL_BUNDLE

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

| 名称     | 类型                                                         | 必填 | 描述             |
| -------- | ------------------------------------------------------------ | ---- | ---------------- |
| callback | AsyncCallback<[BundleInstaller](js-apis-bundle-BundleInstaller.md)> | 是   | 安装应用程序包。 |

## bundle.cleanBundleCacheFiles<sup>8+</sup>

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

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

**需要权限:**

ohos.permission.REMOVE_CACHE_FILES

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

| 名称       | 类型                | 必填 | 描述                                  |
| ---------- | ------------------- | ---- | ------------------------------------- |
| bundleName | string              | 是   | 指示要清除其缓存数据的应用程序包名称. |
| callback   | AsyncCallback<void> | 是   | 为返回操作结果而调用的回调。          |

## bundle.cleanBundleCacheFiles<sup>8+</sup>

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

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

**需要权限:**

ohos.permission.REMOVE_CACHE_FILES

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

| 名称       | 类型   | 必填 | 描述                                  |
| ---------- | ------ | ---- | ------------------------------------- |
| bundleName | string | 是   | 指示要清除其缓存数据的应用程序包名称. |

**返回值:**

| 类型          | 说明                                 |
| ------------- | ------------------------------------ |
| Promise<void> | 返回值为Promise对象,Promise中为空。 |

## bundle.setApplicationEnabled<sup>8+</sup>

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

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

**需要权限:**

ohos.permission.CHANGE_ABILITY_ENABLED_STATE

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

| 名称       | 类型                | 必填 | 描述                                            |
| ---------- | ------------------- | ---- | ----------------------------------------------- |
| bundleName | string              | 是   | 应用程序包名称。                                |
| isEnable   | boolean             | 是   | 指定是否启用应用程序。true表示启用,false禁用。 |
| callback   | AsyncCallback<void> | 是   | 为返回操作结果而调用的回调。                    |

## bundle.setApplicationEnabled<sup>8+</sup>

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

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

**需要权限:**

ohos.permission.CHANGE_ABILITY_ENABLED_STATE

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

| 名称       | 类型    | 必填 | 描述                                            |
| ---------- | ------- | ---- | ----------------------------------------------- |
| bundleName | string  | 是   | 应用程序包名称。                                |
| isEnable   | boolean | 是   | 指定是否启用应用程序。true表示启用,false禁用。 |

**返回值:**

| 类型          | 说明                                 |
| ------------- | ------------------------------------ |
| Promise<void> | 返回值为Promise对象,Promise中为空。 |

## bundle.setAbilityEnabled<sup>8+</sup>

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

设置是否启用指定的功能

**需要权限:**

ohos.permission.CHANGE_ABILITY_ENABLED_STATE

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

| 名称     | 类型                                         | 必填 | 描述                                            |
| -------- | -------------------------------------------- | ---- | ----------------------------------------------- |
| info     | [AbilityInfo](js-apis-bundle-AbilityInfo.md) | 是   | Ability信息。                                   |
| isEnable | boolean                                      | 是   | 指定是否启用应用程序。true表示启用,false禁用。 |
| callback | AsyncCallback<void>                          | 是   | 为返回操作结果而调用的回调。                    |

## bundle.setAbilityEnabled<sup>8+</sup>

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

设置是否启用指定的功能

**需要权限:**

ohos.permission.CHANGE_ABILITY_ENABLED_STATE

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

| 名称     | 类型                                         | 必填 | 描述                                            |
| -------- | -------------------------------------------- | ---- | ----------------------------------------------- |
| info     | [AbilityInfo](js-apis-bundle-AbilityInfo.md) | 是   | Ability信息。                                   |
| isEnable | boolean                                      | 是   | 指定是否启用应用程序。true表示启用,false禁用。 |

**返回值:**

| 类型          | 说明                                 |
| ------------- | ------------------------------------ |
| Promise<void> | 返回值为Promise对象,Promise中为空。 |

## bundle.getPermissionDef<sup>8+</sup>

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

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

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

| 名称           | 类型                                                         | 必填 | 描述                                             |
| -------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------ |
| permissionName | string                                                       | 是   | 指定权限的名称。                                 |
| callback       | AsyncCallback<[PermissionDef](js-apis-bundle-PermissionDef)> | 是   | 程序启动作为入参的回调函数,返回定义的权限信息。 |

## bundle.getPermissionDef<sup>8+</sup>

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

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

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

| 名称           | 类型   | 必填 | 描述             |
| -------------- | ------ | ---- | ---------------- |
| permissionName | string | 是   | 指定权限的名称。 |

**返回值:**

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

## bundle.setModuleUpgradeFlag<sup>9+</sup>

setModuleUpgradeFlag(bundleName: string, moduleName: string, upgradeFlag: UpgradeFlag, callback: AsyncCallback&lt;void&gt;):void;

设置模块是否需要升级

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

| 名称        | 类型                        | 必填 | 描述                         |
| ----------- | --------------------------- | ---- | ---------------------------- |
| bundleName  | string                      | 是   | 应用程序包名称。             |
| moduleName  | string                      | 是   | 应用程序模块名称。           |
| upgradeFlag | [UpgradeFlag](#upgradeflag) | 是   | 仅供内部系统使用标志位       |
| callback    | AsyncCallback<void>         | 是   | 为返回操作结果而调用的回调。 |

## bundle.setModuleUpgradeFlag<sup>9+</sup>

setModuleUpgradeFlag(bundleName: string, moduleName: string, upgradeFlag: UpgradeFlag): Promise&lt;void&gt;

设置模块是否需要升级

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

| 名称        | 类型                        | 必填 | 描述                   |
| ----------- | --------------------------- | ---- | ---------------------- |
| bundleName  | string                      | 是   | 应用程序包名称。       |
| moduleName  | string                      | 是   | 应用程序模块名称。     |
| upgradeFlag | [UpgradeFlag](#upgradeflag) | 是   | 仅供内部系统使用标志位 |

**返回值:**

| 类型          | 说明                                 |
| ------------- | ------------------------------------ |
| Promise<void> | 返回值为Promise对象,Promise中为空。 |

## bundle.isModuleRemovable<sup>9+</sup>

isModuleRemovable(bundleName: string, moduleName: string, callback: AsyncCallback&lt;boolean&gt;): void;

检查指定模块是否被移除

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

| 名称       | 类型                   | 必填 | 描述                                          |
| ---------- | ---------------------- | ---- | --------------------------------------------- |
| bundleName | string                 | 是   | 应用程序包名称。                              |
| moduleName | string                 | 是   | 应用程序模块名称。                            |
| callback   | AsyncCallback<boolean> | 是   | 程序启动作为入参的回调函数,返回boolean信息。 |

## bundle.isModuleRemovable<sup>9+</sup>

isModuleRemovable(bundleName: string, moduleName: string): Promise&lt;boolean&gt;

检查指定模块是否被移除

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

| 名称       | 类型   | 必填 | 描述               |
| ---------- | ------ | ---- | ------------------ |
| bundleName | string | 是   | 应用程序包名称。   |
| moduleName | string | 是   | 应用程序模块名称。 |

**返回值:**

| 类型             | 说明                         |
| ---------------- | ---------------------------- |
| Promise<boolean> | Promise形式返回boolean信息。 |

## bundle.getBundlePackInfo<sup>9+</sup>

getBundlePackInfo(bundleName: string, bundlePackFlag : pack.BundlePackFlag, callback: AsyncCallback&lt;pack.BundlePackInfo&gt;): void;

基于bundleName和bundleFlags获取bundlePackInfo

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

| 名称           | 类型                               | 必填 | 描述                                                 |
| -------------- | ---------------------------------- | ---- | ---------------------------------------------------- |
| bundleName     | string                             | 是   | 应用程序包名称。                                     |
| bundlePackFlag | pack.BundlePackFlag                | 是   | 指示要查询的应用包标志                               |
| callback       | AsyncCallback<pack.BundlePackInfo> | 是   | 程序启动作为入参的回调函数,返回BundlePackInfo信息。 |

## bundle.getBundlePackInfo<sup>9+</sup>

getBundlePackInfo(bundleName: string, bundlePackFlag : pack.BundlePackFlag): Promise&lt;pack.BundlePackInfo&gt;;

基于bundleName和bundleFlags获取bundlePackInfo

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

| 名称           | 类型                | 必填 | 描述                   |
| -------------- | ------------------- | ---- | ---------------------- |
| bundleName     | string              | 是   | 应用程序包名称。       |
| bundlePackFlag | pack.BundlePackFlag | 是   | 指示要查询的应用包标志 |

**返回值:**

| 类型                         | 说明                                |
| ---------------------------- | ----------------------------------- |
| Promise<pack.BundlePackInfo> | Promise形式返回BundlePackInfo信息。 |

## bundle.getDispatcherVersion<sup>9+</sup>

getDispatcherVersion(callback: AsyncCallback&lt;DispatchInfo&gt;): void;

获取有关dispatcher版本的信息

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**参数:**

| 名称     | 类型                                                   | 必填 | 描述                                                         |
| -------- | ------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback<[DispatchInfo](js-apis-dispatchInfo.md)> | 是   | 程序启动作为入参的回调函数,返回[DispatchInfo](js-apis-dispatchInfo.md)信息。 |

## bundle.getDispatcherVersion<sup>9+</sup>

getDispatcherVersion(): Promise&lt;DispatchInfo&gt;;

获取有关dispatcher版本的信息

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**系统API:**

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

**返回值:**

| 类型                                             | 说明                                                         |
| ------------------------------------------------ | ------------------------------------------------------------ |
| Promise<[DispatchInfo](js-apis-dispatchInfo.md)> | Promise形式返回[DispatchInfo](js-apis-dispatchInfo.md)信息。 |
S
shuaiyutao 已提交
837 838 839

## bundle.getAllApplicationInfo

qq_41863798's avatar
qq_41863798 已提交
840
getAllApplicationInfo(bundleFlags: number, userId?: number): Promise<Array\<ApplicationInfo>>
S
shuaiyutao 已提交
841 842 843 844 845

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

**需要权限:**

W
wanghang 已提交
846
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
S
shuaiyutao 已提交
847

848 849 850 851
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
852 853
**参数:**

H
HelloCrease 已提交
854 855 856 857
| 名称          | 类型     | 必填   | 描述                                      |
| ----------- | ------ | ---- | --------------------------------------- |
| bundleFlags | number | 是    | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
| userId      | number | 否    | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。            |
S
shuaiyutao 已提交
858 859 860

**返回值:**

H
HelloCrease 已提交
861 862
| 类型                               | 说明                              |
| -------------------------------- | ------------------------------- |
J
junyi233 已提交
863
| Promise<Array\<[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)>> | 返回值为Promise对象,Promise中包含应用信息列表。 |
S
shuaiyutao 已提交
864 865 866 867

**示例:**

```js
W
wanghang 已提交
868 869 870 871 872 873 874
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 已提交
875 876 877 878 879 880 881 882 883
})
```



## bundle.getAllApplicationInfo

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

884
获取指定用户下所有已安装的应用信息,使用callback形式返回结果。
S
shuaiyutao 已提交
885 886 887

**需要权限:**

W
wanghang 已提交
888
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
S
shuaiyutao 已提交
889

890 891 892 893
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
894 895
**参数:**

H
HelloCrease 已提交
896 897 898 899
| 名称          | 类型                                     | 必填   | 描述                                      |
| ----------- | -------------------------------------- | ---- | --------------------------------------- |
| bundleFlags | number                                 | 是    | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
| userId      | number                                 | 否    | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。            |
J
junyi233 已提交
900
| callback    | AsyncCallback<Array\<[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)>> | 是    | 程序启动作为入参的回调函数,返回应用信息列表。                 |
S
shuaiyutao 已提交
901 902 903 904

**示例:**

```js
W
wanghang 已提交
905 906 907 908 909 910 911 912 913
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 已提交
914 915 916
```


qq_41863798's avatar
qq_41863798 已提交
917 918
## bundle.getAllApplicationInfo

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

921
获取所有已安装的应用信息,使用callback形式返回结果。
qq_41863798's avatar
qq_41863798 已提交
922 923 924 925 926 927 928 929 930 931 932

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

H
HelloCrease 已提交
933 934 935
| 名称          | 类型                                     | 必填   | 描述                                      |
| ----------- | -------------------------------------- | ---- | --------------------------------------- |
| bundleFlags | number                                 | 是    | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
J
junyi233 已提交
936
| callback    | AsyncCallback<Array\<[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)>> | 是    | 程序启动作为入参的回调函数,返回应用信息列表。                 |
qq_41863798's avatar
qq_41863798 已提交
937 938 939 940 941 942 943 944 945 946 947 948 949 950

**示例:**

```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 已提交
951 952
## bundle.getBundleArchiveInfo

953
getBundleArchiveInfo(hapFilePath: string, bundleFlags: number) : Promise\<BundleInfo>
W
wanghang 已提交
954 955 956 957 958 959 960 961 962 963 964 965

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

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

| 名称         | 类型     | 必填   | 描述           |
| ---------- | ------ | ---- | ------------ |
| hapFilePath | string | 是    | HAP存放路径。路径应指向当前应用程序的数据目录的相对目录。 |
966
| bundleFlags | number | 是    | 用于指定要返回的BundleInfo对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
W
wanghang 已提交
967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987

**返回值:**
| 类型             | 说明                                     |
| -------------- | -------------------------------------- |
| 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));
})
```

## bundle.getBundleArchiveInfo

988
getBundleArchiveInfo(hapFilePath: string, bundleFlags: number, callback: AsyncCallback\<BundleInfo>) : void
W
wanghang 已提交
989 990 991 992 993 994 995 996 997 998 999 1000

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

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

| 名称         | 类型     | 必填   | 描述           |
| ---------- | ------ | ---- | ------------ |
| hapFilePath | string | 是    | HAP存放路径。路径应指向当前应用程序的数据目录的相对目录。 |
1001 1002
| bundleFlags | number | 是    | 用于指定要返回的BundleInfo对象中包含信息的标记。默认值:0,取值范围:大于等于0。|
| callback| AsyncCallback\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 是    | 程序启动作为入参的回调函数,返回HAP包中包含的应用程序包的信息。|
W
wanghang 已提交
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018

**示例:**

```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));
})
```


qq_41863798's avatar
api 9  
qq_41863798 已提交
1019
## bundle.getAbilityInfo
qq_41863798's avatar
qq_41863798 已提交
1020

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

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

**需要权限:**

J
junyi233 已提交
1027
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
D
dy 已提交
1028 1029 1030 1031 1032 1033 1034

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

H
HelloCrease 已提交
1035 1036
| 名称          | 类型     | 必填   | 描述               |
| ----------- | ------ | ---- | ---------------- |
qq_41863798's avatar
qq_41863798 已提交
1037 1038
| bundleName  | string | 是    | 应用程序包名。     |
| abilityName | string | 是    | Ability名称。 |
D
dy 已提交
1039 1040 1041

**返回值:**

H
HelloCrease 已提交
1042 1043
| 类型                    | 说明                    |
| --------------------- | --------------------- |
J
junyi233 已提交
1044
| Promise\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | Promise形式返回Ability信息。 |
D
dy 已提交
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060

**示例:**

```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));
})
```

## bundle.getAbilityInfo

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

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

**需要权限:**

J
junyi233 已提交
1067
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
D
dy 已提交
1068 1069 1070 1071 1072 1073 1074

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

qq_41863798's avatar
qq_41863798 已提交
1075 1076 1077 1078
| 名称         | 类型     | 必填   | 描述            |
| ----------- | ------------ | ---- | ---------------- |
| bundleName  | string | 是    | 应用程序包名。     |
| abilityName | string | 是    | Ability名称。 |
J
junyi233 已提交
1079
| callback    | AsyncCallback\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 是    | 程序启动作为入参的回调函数,返回Ability信息。 |
D
dy 已提交
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093

**示例:**

```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));
})
```
1094 1095 1096 1097 1098 1099 1100 1101
## bundle.getAbilityInfo<sup>9+</sup>

getAbilityInfo(bundleName: string, moduleName: string, abilityName: string): Promise\<AbilityInfo>

通过包名称、moduleName和abilityName获取Ability信息,使用Promise形式返回结果。

**需要权限:**

J
junyi233 已提交
1102
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

| 名称          | 类型     | 必填   | 描述               |
| ----------- | ------ | ---- | ---------------- |
| bundleName  | string | 是    | 应用程序包名。     |
| moduleName  | string | 是    | Module名称。     |
| abilityName | string | 是    | Ability名称。 |

**返回值:**

| 类型                    | 说明                    |
| --------------------- | --------------------- |
J
junyi233 已提交
1120
| Promise\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | Promise形式返回Ability信息。 |
1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143

**示例:**

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

## bundle.getAbilityInfo<sup>9+</sup>

getAbilityInfo(bundleName: string, moduleName: string, abilityName: string, callback: AsyncCallback\<AbilityInfo>): void;

通过包名称、moduleName和abilityName获取Ability信息,使用callback形式返回结果。

**需要权限:**

J
junyi233 已提交
1144
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

| 名称         | 类型     | 必填   | 描述            |
| ----------- | ------------ | ---- | ---------------- |
| bundleName  | string | 是    | 应用程序包名。     |
| moduleName  | string | 是    | Module名称。     |
| abilityName | string | 是    | Ability名称。 |
J
junyi233 已提交
1157
| callback    | AsyncCallback\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 是    | 程序启动作为入参的回调函数,返回Ability信息。 |
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172

**示例:**

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

qq_41863798's avatar
qq_41863798 已提交
1174
## bundle.getAbilityLabel<sup>8+</sup>
D
dy 已提交
1175 1176 1177

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

qq_41863798's avatar
qq_41863798 已提交
1178
通过包名称和abilityName获取应用名称,使用Promise形式返回结果。
D
dy 已提交
1179 1180 1181

**需要权限:**

J
junyi233 已提交
1182
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
D
dy 已提交
1183 1184 1185 1186 1187 1188 1189

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

H
HelloCrease 已提交
1190 1191
| 名称          | 类型     | 必填   | 描述               |
| ----------- | ------ | ---- | ---------------- |
qq_41863798's avatar
qq_41863798 已提交
1192 1193
| bundleName  | string | 是    | 应用程序包名。     |
| abilityName | string | 是    | Ability名称。 |
D
dy 已提交
1194 1195 1196

**返回值:**

H
HelloCrease 已提交
1197 1198
| 类型               | 说明                 |
| ---------------- | ------------------ |
D
dy 已提交
1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
| 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));
})
```

qq_41863798's avatar
qq_41863798 已提交
1214
## bundle.getAbilityLabel<sup>8+</sup>
D
dy 已提交
1215 1216 1217

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

qq_41863798's avatar
qq_41863798 已提交
1218
通过包名称和abilityName获取应用名称,使用callback形式返回结果。
D
dy 已提交
1219 1220 1221

**需要权限:**

J
junyi233 已提交
1222
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
D
dy 已提交
1223 1224 1225 1226 1227 1228 1229

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

H
HelloCrease 已提交
1230 1231
| 名称          | 类型                     | 必填   | 描述               |
| ----------- | ---------------------- | ---- | ---------------- |
qq_41863798's avatar
qq_41863798 已提交
1232 1233 1234
| bundleName  | string                 | 是    | 应用程序包名。     |
| abilityName | string                 | 是    | Ability名称。 |
| callback    | AsyncCallback\<string> | 是    | 程序启动作为入参的回调函数,返回应用名称信息。        |
D
dy 已提交
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248

**示例:**

```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));
})
```
1249 1250 1251 1252 1253 1254 1255 1256
## bundle.getAbilityLabel<sup>9+</sup>

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

通过包名称、moduleName和abilityName获取应用名称,使用Promise形式返回结果。

**需要权限:**

J
junyi233 已提交
1257
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

| 名称          | 类型     | 必填   | 描述               |
| ----------- | ------ | ---- | ---------------- |
| bundleName  | string | 是    | 应用程序包名。     |
| moduleName  | string | 是    | Module名称。     |
| abilityName | string | 是    | Ability名称。 |

**返回值:**

| 类型               | 说明                 |
| ---------------- | ------------------ |
| Promise\<string> | Promise形式返回应用名称信息。 |

**示例:**

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

## bundle.getAbilityLabel<sup>9+</sup>

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

通过包名称、moduleName和abilityName获取应用名称,使用callback形式返回结果。

**需要权限:**

J
junyi233 已提交
1299
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

| 名称          | 类型                     | 必填   | 描述               |
| ----------- | ---------------------- | ---- | ---------------- |
| bundleName  | string                 | 是    | 应用程序包名。     |
| moduleName  | string | 是    | Module名称。     |
| abilityName | string                 | 是    | Ability名称。 |
| callback    | AsyncCallback\<string> | 是    | 程序启动作为入参的回调函数,返回应用名称信息。        |

**示例:**

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

qq_41863798's avatar
qq_41863798 已提交
1329
## bundle.isAbilityEnabled<sup>8+</sup>
D
dy 已提交
1330 1331 1332

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

1333
以异步方法根据给定的AbilityInfo查询ability是否已经启用,使用Promise形式返回结果。
D
dy 已提交
1334 1335 1336 1337 1338 1339 1340

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

H
HelloCrease 已提交
1341 1342
| 名称   | 类型          | 必填   | 描述           |
| ---- | ----------- | ---- | ------------ |
J
junyi233 已提交
1343
| info | [AbilityInfo](js-apis-bundle-AbilityInfo.md) | 是    | Ability的配置信息 |
D
dy 已提交
1344 1345 1346

**返回值:**

H
HelloCrease 已提交
1347 1348
| 类型                | 说明                        |
| ----------------- | ------------------------- |
D
dy 已提交
1349 1350 1351 1352 1353
| Promise\<boolean> | Promise形式返回boolean代表是否启用。 |

**示例:**

```js
W
wanghang 已提交
1354 1355 1356 1357 1358 1359 1360 1361
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 已提交
1362 1363 1364
})
```

qq_41863798's avatar
qq_41863798 已提交
1365
## bundle.isAbilityEnabled<sup>8+</sup>
D
dy 已提交
1366 1367 1368

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

1369
以异步方法根据给定的AbilityInfo查询ability是否已经启用,使用callback形式返回结果。
D
dy 已提交
1370 1371 1372 1373 1374 1375 1376

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

H
HelloCrease 已提交
1377 1378
| 名称       | 类型                      | 必填   | 描述              |
| -------- | ----------------------- | ---- | --------------- |
J
junyi233 已提交
1379
| info     | [AbilityInfo](js-apis-bundle-AbilityInfo.md)             | 是    | Ability的配置信息    |
H
HelloCrease 已提交
1380
| callback | AsyncCallback\<boolean> | 是    | 返回boolean代表是否启用 |
D
dy 已提交
1381 1382 1383 1384

**示例:**

```js
W
wanghang 已提交
1385 1386 1387 1388
let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityInfo(bundleName, abilityName).then((abilityInfo)=>{
    bundle.isAbilityEnabled(abilityInfo, (err, data) => {
D
dy 已提交
1389 1390 1391 1392 1393
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
W
wanghang 已提交
1394
    })
D
dy 已提交
1395 1396 1397
})
```

qq_41863798's avatar
qq_41863798 已提交
1398
## bundle.isApplicationEnabled<sup>8+</sup>
D
dy 已提交
1399 1400 1401

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

1402
以异步方法根据给定的bundleName查询指定应用程序是否已经启用,使用Promise形式返回结果。
D
dy 已提交
1403 1404 1405 1406 1407 1408 1409

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

H
HelloCrease 已提交
1410 1411 1412
| 名称         | 类型     | 必填   | 描述           |
| ---------- | ------ | ---- | ------------ |
| bundleName | string | 是    | 要查询的应用程序包名称。 |
D
dy 已提交
1413 1414 1415

**返回值:**

H
HelloCrease 已提交
1416 1417
| 类型                | 说明                        |
| ----------------- | ------------------------- |
D
dy 已提交
1418 1419 1420 1421 1422
| Promise\<boolean> | Promise形式返回boolean代表是否启用。 |

**示例:**

```js
qq_41863798's avatar
api 9  
qq_41863798 已提交
1423 1424
let bundleName = "com.example.myapplication";
bundle.isApplicationEnabled(bundleName)
D
dy 已提交
1425 1426 1427 1428 1429 1430 1431
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})
```

qq_41863798's avatar
qq_41863798 已提交
1432
## bundle.isApplicationEnabled<sup>8+</sup>
D
dy 已提交
1433 1434 1435

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

1436
以异步方法根据给定的bundleName查询指定应用程序是否已经启用,使用callback形式返回结果。
D
dy 已提交
1437 1438 1439 1440 1441 1442 1443

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

H
HelloCrease 已提交
1444 1445 1446 1447
| 名称         | 类型                      | 必填   | 描述              |
| ---------- | ----------------------- | ---- | --------------- |
| bundleName | string                  | 是    | 要查询的应用程序包名称。    |
| callback   | AsyncCallback\<boolean> | 是    | 返回boolean代表是否启用 |
D
dy 已提交
1448 1449 1450 1451

**示例:**

```js
H
HelloCrease 已提交
1452
let bundleName = "com.example.myapplication";
D
dy 已提交
1453 1454 1455 1456 1457 1458 1459 1460
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 已提交
1461 1462 1463 1464 1465 1466 1467 1468 1469

## bundle.queryAbilityByWant

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

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

**需要权限:**

J
junyi233 已提交
1470
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
S
shuaiyutao 已提交
1471

1472 1473 1474 1475
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
1476 1477
**参数:**

H
HelloCrease 已提交
1478 1479
| 名称          | 类型     | 必填   | 描述                                    |
| ----------- | ------ | ---- | ------------------------------------- |
J
junyi233 已提交
1480
| want        | [Want](js-apis-application-Want.md)   | 是    | 包含要查询的应用程序包名称的意图。                     |
H
HelloCrease 已提交
1481 1482
| bundleFlags | number | 是    | 用于指定返回abilityInfo信息。默认值:0,取值范围:大于等于0。 |
| userId      | number | 否    | 用户ID。默认值:调用方所在用户,取值范围:大于等于0           |
S
shuaiyutao 已提交
1483 1484 1485

**返回值:**

H
HelloCrease 已提交
1486 1487
| 类型                           | 说明                    |
| ---------------------------- | --------------------- |
J
junyi233 已提交
1488
| Promise<Array\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)>> | Promise形式返回Ability信息。 |
S
shuaiyutao 已提交
1489 1490 1491 1492

**示例:**

```js
W
wanghang 已提交
1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503
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 已提交
1504 1505 1506 1507 1508 1509 1510 1511 1512
})
```



## bundle.queryAbilityByWant

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

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

J
junyi233 已提交
1515 1516 1517 1518
**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

X
xuezhongzhu 已提交
1519 1520 1521 1522
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
1523 1524
**参数:**

H
HelloCrease 已提交
1525 1526
| 名称          | 类型                                 | 必填   | 描述                                    |
| ----------- | ---------------------------------- | ---- | ------------------------------------- |
J
junyi233 已提交
1527
| want        | [Want](js-apis-application-Want.md)                               | 是    | 指示包含要查询的应用程序包名称的意图。                   |
H
HelloCrease 已提交
1528 1529
| bundleFlags | number                             | 是    | 用于指定返回abilityInfo信息。默认值:0,取值范围:大于等于0。 |
| userId      | number                             | 是    | 用户ID。默认值:调用方所在用户,取值范围:大于等于0           |
J
junyi233 已提交
1530
| callback    | AsyncCallback<Array\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)>> | 是    | 程序启动作为入参的回调函数,返回Ability信息。            |
S
shuaiyutao 已提交
1531 1532 1533 1534

**示例:**

```js
W
wanghang 已提交
1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547
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 已提交
1548 1549 1550 1551
```

## bundle.queryAbilityByWant

qq_41863798's avatar
qq_41863798 已提交
1552
queryAbilityByWant(want: Want, bundleFlags: number, callback: AsyncCallback<Array\<AbilityInfo>>): void;
S
shuaiyutao 已提交
1553 1554 1555

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

J
junyi233 已提交
1556 1557 1558 1559
**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO

X
xuezhongzhu 已提交
1560 1561 1562 1563
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
1564 1565
**参数:**

H
HelloCrease 已提交
1566 1567
| 名称          | 类型                                 | 必填   | 描述                                    |
| ----------- | ---------------------------------- | ---- | ------------------------------------- |
J
junyi233 已提交
1568
| want        | [Want](js-apis-application-Want.md)                               | 是    | 指示包含要查询的应用程序包名称的意图。                   |
H
HelloCrease 已提交
1569
| bundleFlags | number                             | 是    | 用于指定返回abilityInfo信息。默认值:0,取值范围:大于等于0。 |
J
junyi233 已提交
1570
| callback    | AsyncCallback<Array\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)>> | 是    | 程序启动作为入参的回调函数,返回Ability信息。            |
S
shuaiyutao 已提交
1571 1572 1573 1574

**示例:**

```js
W
wanghang 已提交
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586
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 已提交
1587 1588 1589 1590
```



W
wanghang 已提交
1591
## bundle.getLaunchWantForBundle
S
shuaiyutao 已提交
1592

W
wanghang 已提交
1593 1594 1595
getLaunchWantForBundle(bundleName: string): Promise\<Want>

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

W
wanghang 已提交
1597 1598 1599 1600
**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

1601 1602 1603 1604
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
1605 1606
**参数:**

H
HelloCrease 已提交
1607 1608 1609
| 名称         | 类型     | 必填   | 描述           |
| ---------- | ------ | ---- | ------------ |
| bundleName | string | 是    | 要查询的应用程序包名称。 |
S
shuaiyutao 已提交
1610 1611

**返回值:**
H
HelloCrease 已提交
1612 1613
| 类型             | 说明                                     |
| -------------- | -------------------------------------- |
J
junyi233 已提交
1614
| Promise\<[Want](js-apis-application-Want.md)> | 返回值为Promise对象,Promise中包含拉起指定应用的Want对象。 |
S
shuaiyutao 已提交
1615 1616 1617 1618

**示例:**

```js
W
wanghang 已提交
1619 1620 1621 1622 1623 1624 1625
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 已提交
1626 1627
```

W
wanghang 已提交
1628
## bundle.getLaunchWantForBundle
S
shuaiyutao 已提交
1629

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

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

W
wanghang 已提交
1634 1635 1636 1637
**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

1638 1639 1640 1641
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
1642 1643
**参数:**

H
HelloCrease 已提交
1644 1645 1646
| 名称         | 类型                   | 必填   | 描述                             |
| ---------- | -------------------- | ---- | ------------------------------ |
| bundleName | string               | 是    | 要查询的应用程序包名称。                   |
J
junyi233 已提交
1647
| callback   | AsyncCallback\<[Want](js-apis-application-Want.md)> | 是    | 程序启动作为入参的回调函数,返回拉起指定应用的want对象。 |
S
shuaiyutao 已提交
1648 1649 1650 1651

**示例:**

```js
W
wanghang 已提交
1652 1653 1654 1655 1656 1657 1658 1659
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 已提交
1660 1661 1662
```


qq_41863798's avatar
qq_41863798 已提交
1663
## bundle.getNameForUid<sup>8+</sup>
W
wanghang 已提交
1664 1665

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

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

X
xuezhongzhu 已提交
1669 1670 1671 1672
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
1673 1674
**参数:**

H
HelloCrease 已提交
1675 1676 1677
| 名称   | 类型     | 必填   | 描述       |
| ---- | ------ | ---- | -------- |
| uid  | number | 是    | 要查询的uid。 |
S
shuaiyutao 已提交
1678 1679

**返回值:**
H
HelloCrease 已提交
1680 1681
| 类型               | 说明                                |
| ---------------- | --------------------------------- |
W
wanghang 已提交
1682
| Promise\<string> | 返回值为Promise对象,Promise中包含指定uid的包名。 |
S
shuaiyutao 已提交
1683 1684 1685 1686

**示例:**

```js
W
wanghang 已提交
1687 1688 1689 1690 1691 1692 1693
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 已提交
1694 1695
```

qq_41863798's avatar
qq_41863798 已提交
1696
## bundle.getNameForUid<sup>8+</sup>
S
shuaiyutao 已提交
1697

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

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

X
xuezhongzhu 已提交
1702 1703 1704 1705
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
1706 1707
**参数:**

H
HelloCrease 已提交
1708 1709 1710 1711
| 名称       | 类型                     | 必填   | 描述                        |
| -------- | ---------------------- | ---- | ------------------------- |
| uid      | number                 | 是    | 要查询的uid。                  |
| callback | AsyncCallback\<string> | 是    | 程序启动作为入参的回调函数,返回指定uid的包名。 |
S
shuaiyutao 已提交
1712 1713 1714 1715

**示例:**

```js
W
wanghang 已提交
1716 1717 1718 1719 1720 1721 1722 1723
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 已提交
1724 1725
```

qq_41863798's avatar
qq_41863798 已提交
1726

qq_41863798's avatar
qq_41863798 已提交
1727
## bundle.getAbilityIcon<sup>8+</sup>
qq_41863798's avatar
qq_41863798 已提交
1728

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

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

qq_41863798's avatar
qq_41863798 已提交
1733 1734
**需要权限:**

J
junyi233 已提交
1735
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
qq_41863798's avatar
qq_41863798 已提交
1736 1737 1738 1739 1740

**系统能力:**

SystemCapability.BundleManager.BundleFramework

qq_41863798's avatar
qq_41863798 已提交
1741 1742
**参数:**

qq_41863798's avatar
qq_41863798 已提交
1743 1744 1745 1746
| 名称          | 类型                                       | 必填   | 描述                                       |
| ----------- | ---------------------------------------- | ---- | ---------------------------------------- |
| bundleName  | string                                   | 是    | 要查询的bundleName。                          |
| abilityName | string                                   | 是    | 要查询的abilityName。                         |
qq_41863798's avatar
qq_41863798 已提交
1747 1748 1749 1750

**返回值:**
| 类型                  | 说明                                                         |
| --------------------- | ------------------------------------------------------------ |
1751
| Promise\<image.PixelMap> | 返回值为[PixelMap](js-apis-image.md)。 |
qq_41863798's avatar
qq_41863798 已提交
1752 1753 1754 1755

**示例:**

```js
1756 1757
let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
qq_41863798's avatar
qq_41863798 已提交
1758 1759 1760 1761 1762 1763 1764 1765
bundle.getAbilityIcon(bundleName, abilityName)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})
```

qq_41863798's avatar
qq_41863798 已提交
1766
## bundle.getAbilityIcon<sup>8+</sup>
qq_41863798's avatar
qq_41863798 已提交
1767

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

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

qq_41863798's avatar
qq_41863798 已提交
1772 1773
**需要权限:**

J
junyi233 已提交
1774
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
qq_41863798's avatar
qq_41863798 已提交
1775 1776 1777 1778 1779

**系统能力:**

SystemCapability.BundleManager.BundleFramework

qq_41863798's avatar
qq_41863798 已提交
1780 1781
**参数:**

qq_41863798's avatar
qq_41863798 已提交
1782 1783 1784 1785
| 名称          | 类型                                       | 必填   | 描述                                       |
| ----------- | ---------------------------------------- | ---- | ---------------------------------------- |
| bundleName  | string                                   | 是    | 要查询的bundleName。                          |
| abilityName | string                                   | 是    | 要查询的abilityName。                         |
1786
| callback   | AsyncCallback\<image.PixelMap> | 是   | 程序启动作为入参的回调函数,返回指定[PixelMap](js-apis-image.md)。 |
qq_41863798's avatar
qq_41863798 已提交
1787 1788 1789 1790

**示例:**

```js
1791 1792
let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
qq_41863798's avatar
qq_41863798 已提交
1793 1794 1795 1796 1797 1798 1799 1800 1801
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));
})
```

1802 1803 1804 1805
## bundle.getAbilityIcon<sup>9+</sup>

getAbilityIcon(bundleName: string, moduleName: string, abilityName: string): Promise\<image.PixelMap>;

1806
以异步方法通过bundleName、moduleName和abilityName获取对应Icon的[PixelMap](js-apis-image.md),使用Promise形式返回结果。
1807 1808 1809

**需要权限:**

J
junyi233 已提交
1810
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

| 名称          | 类型                                       | 必填   | 描述                                       |
| ----------- | ---------------------------------------- | ---- | ---------------------------------------- |
| bundleName  | string                                   | 是    | 要查询的bundleName。                          |
| moduleName  | string                                   | 是    | moduleName。                          |
| abilityName | string                                   | 是    | 要查询的abilityName。                         |

**返回值:**
| 类型                  | 说明                                                         |
| --------------------- | ------------------------------------------------------------ |
1827
| Promise\<image.PixelMap> | 返回值为[PixelMap](js-apis-image.md)。 |
1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846

**示例:**

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

## bundle.getAbilityIcon<sup>9+</sup>

getAbilityIcon(bundleName: string, moduleName: string, abilityName: string, callback: AsyncCallback\<image.PixelMap>): void;

1847
以异步方法通过bundleName、moduleName和abilityName获取对应Icon的[PixelMap](js-apis-image.md),使用callback形式返回结果。
1848 1849 1850

**需要权限:**

J
junyi233 已提交
1851
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

| 名称          | 类型                                       | 必填   | 描述                                       |
| ----------- | ---------------------------------------- | ---- | ---------------------------------------- |
| bundleName  | string                                   | 是    | 要查询的bundleName。                          |
| moduleName  | string                                   | 是    | moduleName。                          |
| abilityName | string                                   | 是    | 要查询的abilityName。                         |
1864
| callback   | AsyncCallback\<image.PixelMap> | 是   | 程序启动作为入参的回调函数,返回指定[PixelMap](js-apis-image.md)。 |
1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879

**示例:**

```js
let bundleName = "com.example.myapplication";
let moduleName = "entry";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityIcon(bundleName, moduleName, abilityName, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
})
```
qq_41863798's avatar
qq_41863798 已提交
1880

S
s00494828 已提交
1881
## bundle.queryExtensionAbilityInfos<sup>9+</sup>
qq_41863798's avatar
api 9  
qq_41863798 已提交
1882

S
s00494828 已提交
1883
queryExtensionAbilityInfos(want: Want, extensionType: number, extensionFlags: number, userId?: number): Promise<Array\<ExtensionAbilityInfo>>
qq_41863798's avatar
api 9  
qq_41863798 已提交
1884 1885 1886 1887 1888

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

**需要权限:**

J
junyi233 已提交
1889
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
qq_41863798's avatar
api 9  
qq_41863798 已提交
1890 1891 1892 1893 1894 1895 1896

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

H
HelloCrease 已提交
1897 1898
| 名称             | 类型     | 必填   | 描述                                       |
| -------------- | ------ | ---- | ---------------------------------------- |
J
junyi233 已提交
1899 1900 1901
| want           | [Want](js-apis-application-Want.md)   | 是    | 包含要查询的应用程序包名称的意图。                        |
| extensionType  | number | 是    | 用于指定查找的extensionAbilityInfo的类型。 默认值:0,取值范围:枚举值: [ExtensionAbilityType](#ExtensionAbilityType9) |
| extensionFlags | number | 是    | 用于指定返回ExtensionAbilityInfo信息。默认值:0,取值范围:枚举值: [ExtensionFlags](#ExtensionFlag9) |
H
HelloCrease 已提交
1902
| userId         | number | 否    | 用户ID。默认值:调用方所在用户,取值范围:大于等于0              |
qq_41863798's avatar
api 9  
qq_41863798 已提交
1903 1904 1905

**返回值:**

H
HelloCrease 已提交
1906 1907
| 类型                                    | 说明                             |
| ------------------------------------- | ------------------------------ |
J
junyi233 已提交
1908
| Promise<Array\<[ExtensionAbilityInfo](js-apis-bundle-ExtensionAbilityInfo.md)>> | Promise形式返回ExtensionAbility信息。 |
qq_41863798's avatar
api 9  
qq_41863798 已提交
1909 1910 1911 1912

**示例:**

```js
S
s00494828 已提交
1913
let extensionType = 0;
qq_41863798's avatar
api 9  
qq_41863798 已提交
1914 1915 1916 1917 1918 1919
let extensionFlags = 0;
let userId = 100;
let want = {
    bundleName : "com.example.myapplication",
    abilityName : "com.example.myapplication.MainAbility"
};
S
s00494828 已提交
1920
bundle.queryExtensionAbilityInfos(want, extensionType, extensionFlags, userId)
qq_41863798's avatar
api 9  
qq_41863798 已提交
1921 1922 1923 1924 1925 1926 1927 1928 1929
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
})
```



S
s00494828 已提交
1930
## bundle.queryExtensionAbilityInfos<sup>9+</sup>
qq_41863798's avatar
api 9  
qq_41863798 已提交
1931

S
s00494828 已提交
1932
queryExtensionAbilityInfos(want: Want, extensionType: number, extensionFlags: number, userId: number, callback: AsyncCallback<Array\<ExtensionAbilityInfo>>): void
qq_41863798's avatar
api 9  
qq_41863798 已提交
1933

1934
以异步方法根据给定的意图获取指定用户下的ExtensionAbility信息,使用callback形式返回结果。
qq_41863798's avatar
api 9  
qq_41863798 已提交
1935

qq_41863798's avatar
qq_41863798 已提交
1936 1937
**需要权限:**

J
junyi233 已提交
1938
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
qq_41863798's avatar
qq_41863798 已提交
1939

qq_41863798's avatar
api 9  
qq_41863798 已提交
1940 1941 1942 1943 1944 1945
**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

J
junyi233 已提交
1946 1947 1948 1949 1950 1951 1952
| 名称           | 类型                                                         | 必填 | 描述                                                         |
| -------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| want           | [Want](js-apis-application-Want.md)                                                        | 是   | 指示包含要查询的应用程序包名称的意图。                       |
| extensionType  | number                                                       | 是   | 用于指定查找的extensionAbilityInfo的类型。 默认值:0,取值范围:枚举值: [ExtensionAbilityType](#ExtensionAbilityType9) |
| extensionFlags | number                                                       | 是   | 用于指定返回ExtensionAbilityInfo信息。默认值:0,取值范围:枚举值:  [ExtensionFlags](#ExtensionFlag9)|
| userId         | number                                                       | 是   | 用户ID。默认值:调用方所在用户,取值范围:大于等于0          |
| callback       | AsyncCallback<Array\<[ExtensionAbilityInfo](js-apis-bundle-ExtensionAbilityInfo.md)>> | 是   | 程序启动作为入参的回调函数,返回ExtensionAbility信息。       |
qq_41863798's avatar
api 9  
qq_41863798 已提交
1953 1954 1955 1956

**示例:**

```js
S
s00494828 已提交
1957
let extensionType = 0;
qq_41863798's avatar
api 9  
qq_41863798 已提交
1958 1959 1960 1961 1962 1963
let extensionFlags = 0;
let userId = 100;
let want = {
    bundleName : "com.example.myapplication",
    abilityName : "com.example.myapplication.MainAbility"
};
S
s00494828 已提交
1964 1965 1966 1967 1968 1969 1970
const receiver = function onReceive(err, data) {
    var errValue = JSON.stringify(err)
    var dataValue = JSON.stringify(data)
    console.error('Operation failed. Cause: ' + errValue);
    console.error('Operation failed. Cause: ' + dataValue);
}
bundle.queryExtensionAbilityInfos(want, extensionType, extensionFlags, userId, receiver)
qq_41863798's avatar
api 9  
qq_41863798 已提交
1971 1972
```

S
s00494828 已提交
1973
## bundle.queryExtensionAbilityInfos<sup>9+</sup>
qq_41863798's avatar
api 9  
qq_41863798 已提交
1974

S
s00494828 已提交
1975
queryExtensionAbilityInfos(want: Want, extensionType: number, extensionFlags: number, callback: AsyncCallback<Array\<ExtensionAbilityInfo>>): void;
qq_41863798's avatar
api 9  
qq_41863798 已提交
1976 1977 1978

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

qq_41863798's avatar
qq_41863798 已提交
1979 1980
**需要权限:**

J
junyi233 已提交
1981
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO
qq_41863798's avatar
qq_41863798 已提交
1982

qq_41863798's avatar
api 9  
qq_41863798 已提交
1983 1984 1985 1986 1987 1988
**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

H
HelloCrease 已提交
1989 1990
| 名称             | 类型                                       | 必填   | 描述                                       |
| -------------- | ---------------------------------------- | ---- | ---------------------------------------- |
J
junyi233 已提交
1991 1992 1993 1994
| want           | [Want](js-apis-application-Want.md)                                     | 是    | 指示包含要查询的应用程序包名称的意图。                      |
| extensionType  | number                                   | 是    | 用于指定查找的extensionAbilityInfo的类型。 默认值:0,取值范围:枚举值: [ExtensionAbilityType](#ExtensionAbilityType9) |
| extensionFlags | number                                   | 是    | 用于指定返回ExtensionAbilityInfo信息。默认值:0,取值范围:枚举值: [ExtensionFlags](#ExtensionFlag9) |
| callback       | AsyncCallback<Array\<[ExtensionAbilityInfo](js-apis-bundle-ExtensionAbilityInfo.md)>> | 是    | 程序启动作为入参的回调函数,返回ExtensionAbility信息。      |
qq_41863798's avatar
api 9  
qq_41863798 已提交
1995 1996 1997 1998

**示例:**

```js
S
s00494828 已提交
1999
let extensionType = 0;
qq_41863798's avatar
api 9  
qq_41863798 已提交
2000 2001 2002 2003 2004
let extensionFlags = 0;
let want = {
    bundleName : "com.example.myapplication",
    abilityName : "com.example.myapplication.MainAbility"
};
S
s00494828 已提交
2005 2006 2007 2008 2009 2010 2011
const receiver = function onReceive(err, data) {
    var errValue = JSON.stringify(err)
    var dataValue = JSON.stringify(data)
    console.error('Operation failed. Cause: ' + errValue);
    console.error('Operation failed. Cause: ' + dataValue);
}
bundle.queryExtensionAbilityInfos(want, extensionType, extensionFlags, receiver)
qq_41863798's avatar
api 9  
qq_41863798 已提交
2012 2013
```

S
shilei 已提交
2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057
## bundle.getProfileByAbility<sup>9+</sup>

getProfileByAbility(moduleName: string, abilityName: string, metadataName: string, callback: AsyncCallback\<Array\<string>>): void;

以异步方法根据给定的moduleName,abilityName,metadataName来获取[metadata](js-apis-bundle-Metadata.md)中的配置文件的json字符串,使用callback形式返回结果。 该接口只能用来获取当前应用的配置文件的json字符串,不能在当前应用获取其他应用的配置文件json字符串。

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

**参数:**

| 名称             | 类型                                | 必填   | 描述                                       |
| ---------------- | ---------------------------------- | ---- | ---------------------------------------- |
| moduleName     | string                               | 是    | 表示要获取的配置文件所属的module。              |
| abilityName    | string                               | 是    | 表示要获取的配置文件所属的ability。             |
| metadataName   | string                               | 是    | 表示要获取的配置文件所属的metadata。            |
| callback       | AsyncCallback\<Array\<string>>        | 是    | 程序启动作为入参的回调函数,返回配置文件的json字符串数组。   |

**示例:**

```js
let moduleName = 'entry';
let abilityName = 'MainAbility';
let metadataName = 'ohos.ability.shortcuts';
const caller = function callback(err, data) {
    console.error('Operation errcode is: ' + err);
    console.error('Operation result is: ' + data);
}
bundle.getProfileByAbility(moduleName, abilityName, metadataName, caller)
```

## bundle.getProfileByAbility<sup>9+</sup>

getProfileByAbility(moduleName: string, abilityName: string, metadataName?: string): Promise\<Array\<string>>;

以异步方法根据给定的moduleName,abilityName,metadataName来获取[metadata](js-apis-bundle-Metadata.md)中的配置文件的json字符串,使用Promise形式返回结果。 该接口只能用来获取当前应用的配置文件的json字符串,不能在当前应用获取其他应用的配置文件json字符串。

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

**参数:**

| 名称             | 类型                                | 必填   | 描述                                       |
| ---------------- | ---------------------------------- | ---- | ---------------------------------------- |
| moduleName     | string                               | 是    | 表示要获取的配置文件所属的module。              |
| abilityName    | string                               | 是    | 表示要获取的配置文件所属的ability。             |
2058
| metadataName   | string                               | 否    | 表示要获取的配置文件所属的metadata。            |
S
shilei 已提交
2059

2060 2061 2062 2063 2064 2065
**返回值:**

| 类型                                    | 说明                             |
| ------------------------------------- | ------------------------------ |
| Promise\<Array\<string>> | Promise形式返回配置文件的json字符串数组。 |

S
shilei 已提交
2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093
**示例:**

```js
let moduleName = 'entry';
let abilityName = 'MainAbility';
let metadataName = 'ohos.ability.shortcuts';

bundle.getProfileByAbility(moduleName, abilityName, metadataName).then(data=>{
    console.error('Operation result is: ' + data);
}).catch(err=>{
    console.error('Operation errcode is: ' + err);
})
```

## bundle.getProfileByExtensionAbility<sup>9+</sup>

getProfileByExtensionAbility(moduleName: string, extensionAbilityName: string, metadataName: string, callback: AsyncCallback\<Array\<string>>): void;

以异步方法根据给定的moduleName,extensionAbilityName,metadataName来获取[metadata](js-apis-bundle-Metadata.md)中的配置文件的json字符串,使用callback形式返回结果。 该接口只能用来获取当前应用的配置文件的json字符串,不能在当前应用获取其他应用的配置文件json字符串。

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

**参数:**

| 名称             | 类型                                | 必填   | 描述                                       |
| ---------------- | ---------------------------------- | ---- | ---------------------------------------- |
| moduleName     | string                               | 是    | 表示要获取的配置文件所属的module。              |
| extensionAbilityName    | string                               | 是    | 表示要获取的配置文件所属的extensionAbility。             |
2094
| metadataName   | string                               | 是    | 表示要获取的配置文件所属的metadata。            |
S
shilei 已提交
2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125
| callback       | AsyncCallback\<Array\<string>>        | 是    | 程序启动作为入参的回调函数,返回配置文件的json字符串数组。   |

**示例:**

```js
let moduleName = 'entry';
let extensionAbilityName = 'Form';
let metadataName = 'ohos.extension.form';
const caller = function callback(err, data) {
    console.error('Operation errcode is: ' + err);
    console.error('Operation result is: ' + data);
}
bundle.getProfileByExtensionAbility(moduleName, extensionAbilityName, metadataName, caller)
```

## bundle.getProfileByExtensionAbility<sup>9+</sup>

getProfileByExtensionAbility(moduleName: string, extensionAbilityName: string, metadataName?: string): Promise\<Array\<string>>;

以异步方法根据给定的moduleName,extensionAbilityName,metadataName来获取[metadata](js-apis-bundle-Metadata.md)中的配置文件的json字符串,使用Promise形式返回结果。 该接口只能用来获取当前应用的配置文件的json字符串,不能在当前应用获取其他应用的配置文件json字符串。

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

**参数:**

| 名称             | 类型                                | 必填   | 描述                                       |
| ---------------- | ---------------------------------- | ---- | ---------------------------------------- |
| moduleName     | string                               | 是    | 表示要获取的配置文件所属的module。              |
| extensionAbilityName    | string                               | 是    | 表示要获取的配置文件所属的extensionAbility。             |
| metadataName   | string                               | 否    | 表示要获取的配置文件所属的metadata。            |

2126 2127 2128 2129 2130 2131
**返回值:**

| 类型                                    | 说明                             |
| ------------------------------------- | ------------------------------ |
| Promise\<Array\<string>> | Promise形式返回配置文件的json字符串数组。 |

S
shilei 已提交
2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145
**示例:**

```js
let moduleName = 'entry';
let extensionAbilityName = 'Form';
let metadataName = 'ohos.extension.form';

bundle.getProfileByExtensionAbility(moduleName, extensionAbilityName, metadataName).then(data=>{
    console.error('Operation result is: ' + data);
}).catch(err=>{
    console.error('Operation errcode is: ' + err);
})
```

2146 2147 2148 2149
## bundle.setDisposedStatus<sup>9+</sup>

setDisposedStatus(bundleName: string, status: number, callback: AsyncCallback\<void>): void;

2150
此接口为系统接口,以异步方法根据给定的bundleName和status来设置对应应用的处置状态,使用callback形式返回结果。
2151

2152
**需要权限:** ohos.permission.MANAGE_DISPOSED_APP_STATUS
2153 2154 2155

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

J
junyi233 已提交
2156 2157
**系统API:**  此接口为系统接口,三方应用不支持调用

2158 2159 2160 2161 2162
**参数:**

| 名称             | 类型                                | 必填   | 描述                                       |
| ---------------- | ---------------------------------- | ---- | ---------------------------------------- |
| bundleName     | string                               | 是    | 表示要被设置处置状态的应用包名。              |
2163
| status    | number                               | 是    | 表示要设置的处置状态值。该值预留用于应用市场设置应用的处置状态,默认为0,不做处置。             |
2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181
| callback       | AsyncCallback\<void>        | 是    | 程序启动作为入参的回调函数,无返回值。   |

**示例:**

```js
let bundleName = 'com.ohos.camera';
let status = 1;
const caller = function callback(err, data) {
    console.error('Operation err is: ' + err);
    console.error('Operation result is: ' + data);
}
bundle.setDisposedStatus(bundleName, status, caller)
```

## bundle.setDisposedStatus<sup>9+</sup>

setDisposedStatus(bundleName: string, status: number): Promise\<void>;

2182
此接口为系统接口,以异步方法根据给定的bundleName和status来设置对应应用的处置状态,使用Promise形式返回结果。
2183

2184
**需要权限:** ohos.permission.MANAGE_DISPOSED_APP_STATUS
2185 2186 2187

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

J
junyi233 已提交
2188 2189
**系统API:**  此接口为系统接口,三方应用不支持调用

2190 2191 2192 2193 2194
**参数:**

| 名称             | 类型                                | 必填   | 描述                                       |
| ---------------- | ---------------------------------- | ---- | ---------------------------------------- |
| bundleName     | string                               | 是    | 表示要被设置处置状态的应用包名。              |
2195
| status    | number                               | 是    | 表示要设置的处置状态值。该值预留用于应用市场设置应用的处置状态,默认为0,不做处置。             |
2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217

**返回值:**

| 类型                                    | 说明                             |
| ------------------------------------- | ------------------------------ |
| Promise\<void> | Promise形式,无返回值。 |

**示例:**

```js
let bundleName = 'com.ohos.camera';
let status = 1;

bundle.setDisposedStatus(bundleName, status).then(data=>{
    console.error('Operation result is: ' + data);
}).catch(err=>{
    console.error('Operation err is: ' + err);
})
```

## bundle.getDisposedStatus<sup>9+</sup>

J
junyi233 已提交
2218
getDisposedStatus(bundleName: string, callback: AsyncCallback\<number>): void;
2219

2220
**需要权限:** ohos.permission.MANAGE_DISPOSED_APP_STATUS
2221 2222 2223

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

J
junyi233 已提交
2224 2225
**系统API:**  此接口为系统接口,三方应用不支持调用

2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245
**参数:**

| 名称             | 类型                                | 必填   | 描述                                       |
| ---------------- | ---------------------------------- | ---- | ---------------------------------------- |
| bundleName     | string                               | 是    | 表示要获取处置状态的应用包名。              |
| callback       | AsyncCallback\<number>        | 是    | 程序启动作为入参的回调函数,返回应用的处置状态值。   |

**示例:**

```js
let bundleName = 'com.ohos.camera';
const caller = function callback(err, data) {
    console.error('Operation err is: ' + err);
    console.error('Operation result is: ' + data);
}
bundle.getDisposedStatus(bundleName, caller)
```

## bundle.getDisposedStatus<sup>9+</sup>

J
junyi233 已提交
2246
getDisposedStatus(bundleName: string): Promise\<number>;
2247

2248
此接口为系统接口,以异步方法根据给定的bundleName来获取对应应用的处置状态,使用Promise形式返回结果。
2249

2250
**需要权限:** ohos.permission.MANAGE_DISPOSED_APP_STATUS
2251 2252 2253

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

J
junyi233 已提交
2254 2255
**系统API:**  此接口为系统接口,三方应用不支持调用

2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279
**参数:**

| 名称             | 类型                                | 必填   | 描述                                       |
| ---------------- | ---------------------------------- | ---- | ---------------------------------------- |
| bundleName     | string                               | 是    | 表示要获取处置状态的应用包名。              |

**返回值:**

| 类型                                    | 说明                             |
| ------------------------------------- | ------------------------------ |
| Promise\<number> | Promise返回应用的处置状态。 |

**示例:**

```js
let bundleName = 'com.ohos.camera';

bundle.getDisposedStatus(bundleName).then(data=>{
    console.error('Operation result is: ' + data);
}).catch(err=>{
    console.error('Operation err is: ' + err);
})
```

qq_41863798's avatar
qq_41863798 已提交
2280
## InstallErrorCode
S
shuaiyutao 已提交
2281

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

H
HelloCrease 已提交
2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305
| 名称                                       | 默认值  | 说明                        |
| ---------------------------------------- | ---- | ------------------------- |
| 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 已提交
2306 2307 2308 2309 2310

## BundleFlag

包的标志

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

H
HelloCrease 已提交
2313 2314 2315 2316 2317 2318 2319 2320 2321
| 名称                                       | 默认值        | 说明                  |
| ---------------------------------------- | ---------- | ------------------- |
| GET_BUNDLE_DEFAULT                       | 0x00000000 | 获取默认的应用信息           |
| GET_BUNDLE_WITH_ABILITIES                | 0x00000001 | 获取包括Ability信息的包信息   |
| GET_ABILITY_INFO_WITH_PERMISSION         | 0x00000002 | 获取包括权限的Ability信息    |
| GET_ABILITY_INFO_WITH_APPLICATION        | 0x00000004 | 获取包括应用的Ability信息    |
| GET_APPLICATION_INFO_WITH_PERMISSION     | 0x00000008 | 获取包括权限的应用信息         |
| GET_BUNDLE_WITH_REQUESTED_PERMISSION     | 0x00000010 | 获取包括所需权限的包信息        |
| GET_ABILITY_INFO_WITH_METADATA<sup>8+</sup> | 0x00000020 | 获取ability的元数据信息     |
qq_41863798's avatar
qq_41863798 已提交
2322
| GET_BUNDLE_WITH_EXTENSION_ABILITY<sup>9+</sup> | 0x00000020 | 获取包括Ability信息的扩展包信息 |
H
HelloCrease 已提交
2323
| GET_APPLICATION_INFO_WITH_METADATA<sup>8+</sup> | 0x00000040 | 获取应用的元数据信息          |
qq_41863798's avatar
qq_41863798 已提交
2324
| GET_ABILITY_INFO_SYSTEMAPP_ONLY<sup>8+</sup> | 0x00000080 | 获取仅包括系统应用的ability信息 |
H
HelloCrease 已提交
2325 2326
| GET_ABILITY_INFO_WITH_DISABLE<sup>8+</sup> | 0x00000100 | 获取包括被禁用的ability信息   |
| GET_APPLICATION_INFO_WITH_DISABLE<sup>8+</sup> | 0x00000200 | 获取包括被禁用的应用信息        |
S
shilei 已提交
2327
| GET_APPLICATION_INFO_WITH_CERTIFICATE_FINGERPRINT <sup>9+</sup> | 0x00000400 | 获取包括应用申请的签名证书的指纹信息        |
H
HelloCrease 已提交
2328
| GET_ALL_APPLICATION_INFO                 | 0xFFFF0000 | 获取应用所有的信息           |
D
dujingcheng 已提交
2329
| GET_BUNDLE_WITH_HASH_VALUE<sup>9+</sup> | 0x00000030 | 获取包含Hash值的包信息.       |
W
wanghang 已提交
2330 2331 2332 2333 2334

## BundleOptions

包的选项

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

H
HelloCrease 已提交
2337 2338 2339
| 名称     | 类型     | 可读   | 可写   | 说明                           |
| ------ | ------ | ---- | ---- | ---------------------------- |
| userId | number | 是    | 是    | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 |
W
wanghang 已提交
2340 2341 2342

## AbilityType

W
wanghang 已提交
2343 2344
Ability类型

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

H
HelloCrease 已提交
2347 2348 2349 2350 2351 2352
| 名称      | 类型   | 说明                |
| ------- | ---- | ----------------- |
| UNKNOWN | 无    | 未知Ability类型       |
| PAGE    | 无    | Ability有一个UI界面    |
| SERVICE | 无    | Ability没有UI界面     |
| DATA    | 无    | Ability用于提供数据访问服务 |
W
wanghang 已提交
2353 2354 2355

## DisplayOrientation

W
wanghang 已提交
2356 2357
屏幕显示方向

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

H
HelloCrease 已提交
2360 2361 2362 2363 2364 2365
| 名称            | 类型   | 说明            |
| ------------- | ---- | ------------- |
| UNSPECIFIED   | 无    | 屏幕方向--不指定     |
| LANDSCAPE     | 无    | 屏幕方向--横屏      |
| PORTRAIT      | 无    | 屏幕方向--竖屏      |
| FOLLOW_RECENT | 无    | 屏幕方向--紧跟上一个组件 |
J
junyi233 已提交
2366 2367 2368 2369 2370 2371 2372 2373 2374
| LANDSCAPE_INVERTED<sup>9+</sup> |无    | 屏幕方向--反向横屏     |
| PORTRAIT_INVERTED<sup>9+</sup> |无    | 屏幕方向--反向竖屏     |
| AUTO_ROTATION<sup>9+</sup> |无    | 屏幕方向--随传感器旋转     |
| AUTO_ROTATION_LANDSCAPE<sup>9+</sup> |无    | 屏幕方向--传感器横屏旋转,包括了横屏和反向横屏     |
| AUTO_ROTATION_PORTRAIT<sup>9+</sup> |无    | 屏幕方向--传感器竖屏旋转,包括了竖屏和反向竖屏     |
| AUTO_ROTATION_RESTRICTED<sup>9+</sup> |无    | 屏幕方向--传感器开关打开,方向可随传感器旋转     |
| AUTO_ROTATION_LANDSCAPE_RESTRICTED<sup>9+</sup> |无    | 屏幕方向--传感器开关打开,方向可随传感器旋转为横屏, 包括了横屏和反向横屏     |
| AUTO_ROTATION_PORTRAIT_RESTRICTED<sup>9+</sup> |无    | 屏幕方向--传感器开关打开,方向随可传感器旋转为竖屏, 包括了横屏和反向横屏     |
| LOCKED<sup>9+</sup> |无    | 屏幕方向--传感器开关关闭,方向锁定     |
W
wanghang 已提交
2375 2376
## LaunchMode

W
wanghang 已提交
2377 2378
启动模式

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

H
HelloCrease 已提交
2381 2382 2383 2384
| 名称        | 类型   | 说明            |
| --------- | ---- | ------------- |
| SINGLETON | 0    | Ability只有一个示例 |
| STANDARD  | 1    | Ability有多个示例  |
W
wanghang 已提交
2385 2386 2387 2388 2389

## AbilitySubType

Ability的子类型

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

H
HelloCrease 已提交
2392 2393 2394
| 名称          | 类型   | 说明                   |
| ----------- | ---- | -------------------- |
| UNSPECIFIED | 0    | 未定义Ability子类型        |
W
wanghang 已提交
2395
| CA          | 1    | Ability子类型是带有 UI 的服务 |
qq_41863798's avatar
api 9  
qq_41863798 已提交
2396

qq_41863798's avatar
qq_41863798 已提交
2397
## ExtensionAbilityType<sup>9+</sup>
qq_41863798's avatar
api 9  
qq_41863798 已提交
2398 2399 2400

ExtensionAbility的类型

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

H
HelloCrease 已提交
2403 2404 2405
| 名称                             | 类型   | 说明                        |
| ------------------------------ | ---- | ------------------------- |
| FORM<sup>9+</sup>              | 0    | ExtensionAbility的类型包括卡片   |
qq_41863798's avatar
qq_41863798 已提交
2406
| WORK_SCHEDULER<sup>9+</sup>    | 1    | ExtensionAbility的类型包括行程安排 |
H
HelloCrease 已提交
2407 2408 2409 2410 2411 2412 2413
| INPUT_METHOD<sup>9+</sup>      | 2    | ExtensionAbility的类型包括输入法  |
| SERVICE<sup>9+</sup>           | 3    | ExtensionAbility的类型包括服务   |
| ACCESSIBILITY<sup>9+</sup>     | 4    | ExtensionAbility的类型包括无障碍  |
| DATA_SHARE<sup>9+</sup>        | 5    | ExtensionAbility的类型包括数据共享 |
| FILE_SHARE<sup>9+</sup>        | 6    | ExtensionAbility的类型包括文件共享 |
| STATIC_SUBSCRIBER<sup>9+</sup> | 7    | ExtensionAbility的类型包括订阅者  |
| WALLPAPER<sup>9+</sup>         | 8    | ExtensionAbility的类型包括墙纸   |
J
junyi233 已提交
2414 2415
| BACKUP<sup>9+</sup> | 9    | ExtensionAbility的类型包括数据备份恢复 |
| WINDOW<sup>9+</sup> | 10 | ExtensionAbility的类型包括窗口类型扩展信息 |
2416
| ENTERPRISE_ADMIN<sup>9+</sup>  | 11   | ExtensionAbility的类型包括企业管理员   |
2417 2418 2419
| THUMBNAIL<sup>9+</sup> | 13 | ExtensionAbility的类型包括缩略图 |
| PREVIEW<sup>9+</sup> | 14 | ExtensionAbility的类型包括预览 |
| UNSPECIFIED<sup>9+</sup>       | 255   | ExtensionAbility未指定类型     |
qq_41863798's avatar
qq_41863798 已提交
2420 2421

## ExtensionFlag<sup>9+</sup>
qq_41863798's avatar
api 9  
qq_41863798 已提交
2422 2423 2424

扩展标志

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

H
HelloCrease 已提交
2427 2428 2429 2430 2431
| 名称                                       | 默认值        | 说明                             |
| ---------------------------------------- | ---------- | ------------------------------ |
| GET_EXTENSION_INFO_DEFAULT<sup>9+</sup>  | 0x00000000 | 获取默认的extensionAbilityInfo      |
| GET_EXTENSION_INFO_WITH_PERMISSION<sup>9+</sup> | 0x00000002 | 获取携带权限信息的extensionAbilityInfo  |
| GET_EXTENSION_INFO_WITH_APPLICATION<sup>9+</sup> | 0x00000004 | 获取携带应用信息的extensionAbilityInfo  |
qq_41863798's avatar
qq_41863798 已提交
2432
| GET_EXTENSION_INFO_WITH_METADATA<sup>9+</sup> | 0x00000020 | 获取携带元数据信息的extensionAbilityInfo |
qq_41863798's avatar
api 9  
qq_41863798 已提交
2433

qq_41863798's avatar
qq_41863798 已提交
2434 2435 2436 2437 2438 2439
## ColorMode

颜色模式

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

H
HelloCrease 已提交
2440 2441 2442
| 名称         | 类型   | 说明   |
| ---------- | ---- | ---- |
| AUTO_MODE  | -1   | 自动模式 |
qq_41863798's avatar
qq_41863798 已提交
2443 2444
| DARK_MODE  | 0    | 黑色模式 |
| LIGHT_MODE | 1    | 亮度模式 |
qq_41863798's avatar
qq_41863798 已提交
2445 2446 2447 2448 2449 2450 2451 2452


## GrantStatus

授予状态

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

H
HelloCrease 已提交
2453 2454 2455 2456
| 名称                 | 类型   | 说明   |
| ------------------ | ---- | ---- |
| PERMISSION_DENIED  | -1   | 拒绝许可 |
| PERMISSION_GRANTED | 0    | 批准   |
S
shilei 已提交
2457 2458 2459 2460 2461 2462 2463 2464 2465

## SupportWindowMode

支持窗口模式

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

| 名称                 | 类型   | 说明   |
| ------------------ | ---- | ---- |
J
junyi233 已提交
2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482
| FULL_SCREEN<sup>9+</sup> | 0   | 全屏模式 |
| SPLIT<sup>9+</sup> | 1    | 分屏模式   |
| FLOATING<sup>9+</sup> | 2    | 悬浮模式   |

## UpgradeFlag

此项仅供内部系统使用

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

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

| 名称                          | 值   | 说明             |
| ----------------------------- | ---- | ---------------- |
| NOT_UPGRADE<sup>9+</sup>      | 0    | 模块无需升级     |
| SINGLE_UPGRADE<sup>9+</sup>   | 1    | 单个模块需要升级 |
| RELATION_UPGRADE<sup>9+</sup> | 2    | 关系模块需要升级 |