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

qq_41863798's avatar
qq_41863798 已提交
3 4 5
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

S
shuaiyutao 已提交
6 7 8 9 10 11 12 13 14 15 16 17
## 导入模块

```
import bundle from '@ohos.bundle';
```

## 系统能力

SystemCapability.BundleManager.BundleFramework

## 权限列表

H
HelloCrease 已提交
18 19 20
| 权限                                       | 权限等级         | 描述        |
| ---------------------------------------- | ------------ | --------- |
| ohos.permission.GET_BUNDLE_INFO          | normal       | 仅限查询本应用信息 |
W
wanghang 已提交
21
| ohos.permission.GET_BUNDLE_INFO_PRIVILEGED | system_basic | 可查询所有应用信息 |
H
HelloCrease 已提交
22
| ohos.permission.INSTALL_BUNDLE           | system_core  | 可安装、卸载应用  |
S
shuaiyutao 已提交
23 24 25

## bundle.getApplicationInfo

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

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

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED,ohos.permission.GET_BUNDLE_INFO

34 35 36 37
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
38 39
**参数:**

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

**返回值:**

H
HelloCrease 已提交
48 49
| 类型                        | 说明                 |
| ------------------------- | ------------------ |
S
shuaiyutao 已提交
50 51 52 53 54
| Promise\<ApplicationInfo> | Promise形式返回应用程序信息。 |

**示例:**

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



## bundle.getApplicationInfo

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

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

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED,ohos.permission.GET_BUNDLE_INFO

78 79 80 81
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
82 83
**参数:**

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

**示例:**

```js
W
wanghang 已提交
94 95 96 97 98 99 100 101 102 103
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 已提交
104 105 106
```


qq_41863798's avatar
qq_41863798 已提交
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
## bundle.getApplicationInfo

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

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

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED,ohos.permission.GET_BUNDLE_INFO

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

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

**示例:**

```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 已提交
143 144 145

## bundle.getAllBundleInfo

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

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

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

154 155 156 157
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
158 159
**参数:**

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

**返回值:**

H
HelloCrease 已提交
167 168
| 类型                          | 说明                         |
| --------------------------- | -------------------------- |
S
shuaiyutao 已提交
169 170 171 172 173
| Promise<Array\<BundleInfo>> | Promise形式返回所有可用的BundleInfo |

**示例:**

```js
W
wanghang 已提交
174 175 176 177 178 179 180
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 已提交
181 182 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 205
| 名称         | 类型                                | 必填   | 描述                                      |
| ---------- | --------------------------------- | ---- | --------------------------------------- |
| bundleFlag | BundleFlag                        | 是    | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
| callback   | AsyncCallback<Array\<BundleInfo>> | 是    | 程序启动作为入参的回调函数,返回所有可用的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 224 225 226 227 228 229 230

## bundle.getAllBundleInfo

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

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

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

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

SystemCapability.BundleManager.BundleFramework

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

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

**示例:**

```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 已提交
255 256 257 258 259 260
```



## bundle.getBundleInfo

W
wanghang 已提交
261
getBundleInfo(bundleName: string, bundleFlags: number, options?: BundleOptions): Promise\<BundleInfo>
S
shuaiyutao 已提交
262 263 264 265 266 267 268

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

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED,ohos.permission.GET_BUNDLE_INFO

269 270 271 272
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
273 274
**参数:**

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

**返回值:**

H
HelloCrease 已提交
283 284
| 类型                   | 说明                           |
| -------------------- | ---------------------------- |
S
shuaiyutao 已提交
285 286 287 288 289
| Promise\<BundleInfo> | 返回值为Promise对象,Promise中包含包信息。 |

**示例:**

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



## bundle.getBundleInfo

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

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

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED,ohos.permission.GET_BUNDLE_INFO

315 316 317 318
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
319 320
**参数:**

H
HelloCrease 已提交
321 322 323 324 325
| 名称          | 类型                         | 必填   | 描述                                      |
| ----------- | -------------------------- | ---- | --------------------------------------- |
| bundleName  | string                     | 是    | 包名                                      |
| bundleFlags | number                     | 是    | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
| callback    | AsyncCallback\<BundleInfo> | 是    | 程序启动作为入参的回调函数,返回包信息。                    |
S
shuaiyutao 已提交
326 327 328 329

**示例:**

```js
W
wanghang 已提交
330 331 332 333 334 335 336 337 338
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 已提交
339 340 341
```


W
wanghang 已提交
342 343 344 345 346 347 348 349 350 351
## bundle.getBundleInfo

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

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

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED,ohos.permission.GET_BUNDLE_INFO

352 353 354 355
**系统能力:**

SystemCapability.BundleManager.BundleFramework

W
wanghang 已提交
356 357
**参数:**

H
HelloCrease 已提交
358 359 360 361 362 363
| 名称          | 类型                         | 必填   | 描述                                      |
| ----------- | -------------------------- | ---- | --------------------------------------- |
| bundleName  | string                     | 是    | 包名                                      |
| bundleFlags | number                     | 是    | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
| options     | BundleOptions              | 是    | 包含userid。                               |
| callback    | AsyncCallback\<BundleInfo> | 是    | 程序启动作为入参的回调函数,返回包信息。                    |
W
wanghang 已提交
364 365 366 367 368 369 370

**示例:**

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

S
shuaiyutao 已提交
382 383 384

## bundle.getAllApplicationInfo

qq_41863798's avatar
qq_41863798 已提交
385
getAllApplicationInfo(bundleFlags: number, userId?: number): Promise<Array\<ApplicationInfo>>
S
shuaiyutao 已提交
386 387 388 389 390

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

**需要权限:**

W
wanghang 已提交
391
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
S
shuaiyutao 已提交
392

393 394 395 396
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
397 398
**参数:**

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

**返回值:**

H
HelloCrease 已提交
406 407
| 类型                               | 说明                              |
| -------------------------------- | ------------------------------- |
S
shuaiyutao 已提交
408 409 410 411 412
| Promise<Array\<ApplicationInfo>> | 返回值为Promise对象,Promise中包含应用信息列表。 |

**示例:**

```js
W
wanghang 已提交
413 414 415 416 417 418 419
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 已提交
420 421 422 423 424 425 426 427 428
})
```



## bundle.getAllApplicationInfo

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

429
获取指定用户下所有已安装的应用信息,使用callback形式返回结果。
S
shuaiyutao 已提交
430 431 432

**需要权限:**

W
wanghang 已提交
433
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
S
shuaiyutao 已提交
434

435 436 437 438
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
439 440
**参数:**

H
HelloCrease 已提交
441 442 443 444 445
| 名称          | 类型                                     | 必填   | 描述                                      |
| ----------- | -------------------------------------- | ---- | --------------------------------------- |
| bundleFlags | number                                 | 是    | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
| userId      | number                                 | 否    | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。            |
| callback    | AsyncCallback<Array\<ApplicationInfo>> | 是    | 程序启动作为入参的回调函数,返回应用信息列表。                 |
S
shuaiyutao 已提交
446 447 448 449

**示例:**

```js
W
wanghang 已提交
450 451 452 453 454 455 456 457 458
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 已提交
459 460 461
```


qq_41863798's avatar
qq_41863798 已提交
462 463
## bundle.getAllApplicationInfo

qq_41863798's avatar
qq_41863798 已提交
464
getAllApplicationInfo(bundleFlags: number, callback: AsyncCallback<Array\<ApplicationInfo>>) : void;
qq_41863798's avatar
qq_41863798 已提交
465 466 467 468 469 470 471 472 473 474 475 476 477

获取指定用户下所有已安装的应用信息,使用callback形式返回结果。

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

H
HelloCrease 已提交
478 479 480 481
| 名称          | 类型                                     | 必填   | 描述                                      |
| ----------- | -------------------------------------- | ---- | --------------------------------------- |
| bundleFlags | number                                 | 是    | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
| callback    | AsyncCallback<Array\<ApplicationInfo>> | 是    | 程序启动作为入参的回调函数,返回应用信息列表。                 |
qq_41863798's avatar
qq_41863798 已提交
482 483 484 485 486 487 488 489 490 491 492 493 494 495

**示例:**

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

qq_41863798's avatar
api 9  
qq_41863798 已提交
496
## bundle.getAbilityInfo
qq_41863798's avatar
qq_41863798 已提交
497

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

qq_41863798's avatar
qq_41863798 已提交
500
通过包名称和abilityName获取Ability信息,使用Promise形式返回结果。
D
dy 已提交
501 502 503 504 505 506 507 508 509 510 511

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED,ohos.permission.GET_BUNDLE_INFO

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

H
HelloCrease 已提交
512 513
| 名称          | 类型     | 必填   | 描述               |
| ----------- | ------ | ---- | ---------------- |
qq_41863798's avatar
qq_41863798 已提交
514 515
| bundleName  | string | 是    | 应用程序包名。     |
| abilityName | string | 是    | Ability名称。 |
D
dy 已提交
516 517 518

**返回值:**

H
HelloCrease 已提交
519 520
| 类型                    | 说明                    |
| --------------------- | --------------------- |
D
dy 已提交
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537
| Promise\<AbilityInfo> | Promise形式返回Ability信息。 |

**示例:**

```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 已提交
538
getAbilityInfo(bundleName: string, abilityName: string, callback: AsyncCallback\<AbilityInfo>): void;
D
dy 已提交
539

qq_41863798's avatar
qq_41863798 已提交
540
通过包名称和abilityName获取Ability信息,使用callback形式返回结果。
D
dy 已提交
541 542 543 544 545 546 547 548 549 550 551

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED,ohos.permission.GET_BUNDLE_INFO

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

qq_41863798's avatar
qq_41863798 已提交
552 553 554 555
| 名称         | 类型     | 必填   | 描述            |
| ----------- | ------------ | ---- | ---------------- |
| bundleName  | string | 是    | 应用程序包名。     |
| abilityName | string | 是    | Ability名称。 |
H
HelloCrease 已提交
556
| callback    | AsyncCallback\<AbilityInfo> | 是    | 程序启动作为入参的回调函数,返回Ability信息。 |
D
dy 已提交
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571

**示例:**

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

qq_41863798's avatar
qq_41863798 已提交
572
## bundle.getAbilityLabel<sup>8+</sup>
D
dy 已提交
573 574 575

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

qq_41863798's avatar
qq_41863798 已提交
576
通过包名称和abilityName获取应用名称,使用Promise形式返回结果。
D
dy 已提交
577 578 579 580 581 582 583 584 585 586 587

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED,ohos.permission.GET_BUNDLE_INFO

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

H
HelloCrease 已提交
588 589
| 名称          | 类型     | 必填   | 描述               |
| ----------- | ------ | ---- | ---------------- |
qq_41863798's avatar
qq_41863798 已提交
590 591
| bundleName  | string | 是    | 应用程序包名。     |
| abilityName | string | 是    | Ability名称。 |
D
dy 已提交
592 593 594

**返回值:**

H
HelloCrease 已提交
595 596
| 类型               | 说明                 |
| ---------------- | ------------------ |
D
dy 已提交
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
| 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 已提交
612
## bundle.getAbilityLabel<sup>8+</sup>
D
dy 已提交
613 614 615

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

qq_41863798's avatar
qq_41863798 已提交
616
通过包名称和abilityName获取应用名称,使用callback形式返回结果。
D
dy 已提交
617 618 619 620 621 622 623 624 625 626 627

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED,ohos.permission.GET_BUNDLE_INFO

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

H
HelloCrease 已提交
628 629
| 名称          | 类型                     | 必填   | 描述               |
| ----------- | ---------------------- | ---- | ---------------- |
qq_41863798's avatar
qq_41863798 已提交
630 631 632
| bundleName  | string                 | 是    | 应用程序包名。     |
| abilityName | string                 | 是    | Ability名称。 |
| callback    | AsyncCallback\<string> | 是    | 程序启动作为入参的回调函数,返回应用名称信息。        |
D
dy 已提交
633 634 635 636 637 638 639 640 641 642 643 644 645 646 647

**示例:**

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

qq_41863798's avatar
qq_41863798 已提交
648
## bundle.isAbilityEnabled<sup>8+</sup>
D
dy 已提交
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663

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

以异步方法根据给定的意图查询ability是否已经启用,使用Promise形式返回结果。

**需要权限:**



**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

H
HelloCrease 已提交
664 665 666
| 名称   | 类型          | 必填   | 描述           |
| ---- | ----------- | ---- | ------------ |
| info | AbilityInfo | 是    | Ability的配置信息 |
D
dy 已提交
667 668 669

**返回值:**

H
HelloCrease 已提交
670 671
| 类型                | 说明                        |
| ----------------- | ------------------------- |
D
dy 已提交
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
| Promise\<boolean> | Promise形式返回boolean代表是否启用。 |

**示例:**

```js
let Info = {
    bundleName : "com.example.myapplication",
    name : "com.example.myapplication.MainAbility"
};
bundle.isAbilityEnabled(Info)
.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 已提交
689
## bundle.isAbilityEnabled<sup>8+</sup>
D
dy 已提交
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704

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

以异步方法根据给定的意图查询ability是否已经启用,使用callback形式返回结果。

**需要权限:**



**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

H
HelloCrease 已提交
705 706 707 708
| 名称       | 类型                      | 必填   | 描述              |
| -------- | ----------------------- | ---- | --------------- |
| info     | AbilityInfo             | 是    | Ability的配置信息    |
| callback | AsyncCallback\<boolean> | 是    | 返回boolean代表是否启用 |
D
dy 已提交
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725

**示例:**

```js
let Info = {
    bundleName : "com.example.myapplication",
    name : "com.example.myapplication.MainAbility"
};
bundle.isAbilityEnabled(Info, (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 已提交
726
## bundle.isApplicationEnabled<sup>8+</sup>
D
dy 已提交
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741

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

以异步方法根据给定的意图查询指定应用程序是否已经启用,使用Promise形式返回结果。

**需要权限:**



**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

H
HelloCrease 已提交
742 743 744
| 名称         | 类型     | 必填   | 描述           |
| ---------- | ------ | ---- | ------------ |
| bundleName | string | 是    | 要查询的应用程序包名称。 |
D
dy 已提交
745 746 747

**返回值:**

H
HelloCrease 已提交
748 749
| 类型                | 说明                        |
| ----------------- | ------------------------- |
D
dy 已提交
750 751 752 753 754
| Promise\<boolean> | Promise形式返回boolean代表是否启用。 |

**示例:**

```js
qq_41863798's avatar
api 9  
qq_41863798 已提交
755 756
let bundleName = "com.example.myapplication";
bundle.isApplicationEnabled(bundleName)
D
dy 已提交
757 758 759 760 761 762 763
.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 已提交
764
## bundle.isApplicationEnabled<sup>8+</sup>
D
dy 已提交
765 766 767 768 769 770 771 772 773 774 775 776 777 778 779

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

以异步方法根据给定的意图查询指定应用程序是否已经启用,使用callback形式返回结果。

**需要权限:**



**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

H
HelloCrease 已提交
780 781 782 783
| 名称         | 类型                      | 必填   | 描述              |
| ---------- | ----------------------- | ---- | --------------- |
| bundleName | string                  | 是    | 要查询的应用程序包名称。    |
| callback   | AsyncCallback\<boolean> | 是    | 返回boolean代表是否启用 |
D
dy 已提交
784 785 786 787

**示例:**

```js
H
HelloCrease 已提交
788
let bundleName = "com.example.myapplication";
D
dy 已提交
789 790 791 792 793 794 795 796
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 已提交
797 798 799 800 801 802 803 804 805 806 807

## bundle.queryAbilityByWant

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

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

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED,ohos.permission.GET_BUNDLE_INFO

808 809 810 811
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
812 813
**参数:**

H
HelloCrease 已提交
814 815 816 817 818
| 名称          | 类型     | 必填   | 描述                                    |
| ----------- | ------ | ---- | ------------------------------------- |
| want        | Want   | 是    | 包含要查询的应用程序包名称的意图。                     |
| bundleFlags | number | 是    | 用于指定返回abilityInfo信息。默认值:0,取值范围:大于等于0。 |
| userId      | number | 否    | 用户ID。默认值:调用方所在用户,取值范围:大于等于0           |
S
shuaiyutao 已提交
819 820 821

**返回值:**

H
HelloCrease 已提交
822 823
| 类型                           | 说明                    |
| ---------------------------- | --------------------- |
S
shuaiyutao 已提交
824 825 826 827 828
| Promise<Array\<AbilityInfo>> | Promise形式返回Ability信息。 |

**示例:**

```js
W
wanghang 已提交
829 830 831 832 833 834 835 836 837 838 839
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 已提交
840 841 842 843 844 845 846 847 848 849 850
})
```



## bundle.queryAbilityByWant

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

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

X
xuezhongzhu 已提交
851 852 853 854
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
855 856
**参数:**

H
HelloCrease 已提交
857 858 859 860 861 862
| 名称          | 类型                                 | 必填   | 描述                                    |
| ----------- | ---------------------------------- | ---- | ------------------------------------- |
| want        | Want                               | 是    | 指示包含要查询的应用程序包名称的意图。                   |
| bundleFlags | number                             | 是    | 用于指定返回abilityInfo信息。默认值:0,取值范围:大于等于0。 |
| userId      | number                             | 是    | 用户ID。默认值:调用方所在用户,取值范围:大于等于0           |
| callback    | AsyncCallback<Array\<AbilityInfo>> | 是    | 程序启动作为入参的回调函数,返回Ability信息。            |
S
shuaiyutao 已提交
863 864 865 866

**示例:**

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

## bundle.queryAbilityByWant

qq_41863798's avatar
qq_41863798 已提交
884
queryAbilityByWant(want: Want, bundleFlags: number, callback: AsyncCallback<Array\<AbilityInfo>>): void;
S
shuaiyutao 已提交
885 886 887

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

X
xuezhongzhu 已提交
888 889 890 891
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
892 893
**参数:**

H
HelloCrease 已提交
894 895 896 897 898
| 名称          | 类型                                 | 必填   | 描述                                    |
| ----------- | ---------------------------------- | ---- | ------------------------------------- |
| want        | Want                               | 是    | 指示包含要查询的应用程序包名称的意图。                   |
| bundleFlags | number                             | 是    | 用于指定返回abilityInfo信息。默认值:0,取值范围:大于等于0。 |
| callback    | AsyncCallback<Array\<AbilityInfo>> | 是    | 程序启动作为入参的回调函数,返回Ability信息。            |
S
shuaiyutao 已提交
899 900 901 902

**示例:**

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



W
wanghang 已提交
919
## bundle.getLaunchWantForBundle
S
shuaiyutao 已提交
920

W
wanghang 已提交
921 922 923
getLaunchWantForBundle(bundleName: string): Promise\<Want>

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

W
wanghang 已提交
925 926 927 928
**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

929 930 931 932
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
933 934
**参数:**

H
HelloCrease 已提交
935 936 937
| 名称         | 类型     | 必填   | 描述           |
| ---------- | ------ | ---- | ------------ |
| bundleName | string | 是    | 要查询的应用程序包名称。 |
S
shuaiyutao 已提交
938 939

**返回值:**
H
HelloCrease 已提交
940 941
| 类型             | 说明                                     |
| -------------- | -------------------------------------- |
W
wanghang 已提交
942
| Promise\<Want> | 返回值为Promise对象,Promise中包含拉起指定应用的Want对象。 |
S
shuaiyutao 已提交
943 944 945 946

**示例:**

```js
W
wanghang 已提交
947 948 949 950 951 952 953
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 已提交
954 955
```

W
wanghang 已提交
956
## bundle.getLaunchWantForBundle
S
shuaiyutao 已提交
957

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

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

W
wanghang 已提交
962 963 964 965
**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

966 967 968 969
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
970 971
**参数:**

H
HelloCrease 已提交
972 973 974 975
| 名称         | 类型                   | 必填   | 描述                             |
| ---------- | -------------------- | ---- | ------------------------------ |
| bundleName | string               | 是    | 要查询的应用程序包名称。                   |
| callback   | AsyncCallback\<Want> | 是    | 程序启动作为入参的回调函数,返回拉起指定应用的want对象。 |
S
shuaiyutao 已提交
976 977 978 979

**示例:**

```js
W
wanghang 已提交
980 981 982 983 984 985 986 987
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 已提交
988 989 990
```


qq_41863798's avatar
qq_41863798 已提交
991
## bundle.getNameForUid<sup>8+</sup>
W
wanghang 已提交
992 993

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

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

X
xuezhongzhu 已提交
997 998 999 1000
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
1001 1002
**参数:**

H
HelloCrease 已提交
1003 1004 1005
| 名称   | 类型     | 必填   | 描述       |
| ---- | ------ | ---- | -------- |
| uid  | number | 是    | 要查询的uid。 |
S
shuaiyutao 已提交
1006 1007

**返回值:**
H
HelloCrease 已提交
1008 1009
| 类型               | 说明                                |
| ---------------- | --------------------------------- |
W
wanghang 已提交
1010
| Promise\<string> | 返回值为Promise对象,Promise中包含指定uid的包名。 |
S
shuaiyutao 已提交
1011 1012 1013 1014

**示例:**

```js
W
wanghang 已提交
1015 1016 1017 1018 1019 1020 1021
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 已提交
1022 1023
```

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

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

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

X
xuezhongzhu 已提交
1030 1031 1032 1033
**系统能力:**

SystemCapability.BundleManager.BundleFramework

S
shuaiyutao 已提交
1034 1035
**参数:**

H
HelloCrease 已提交
1036 1037 1038 1039
| 名称       | 类型                     | 必填   | 描述                        |
| -------- | ---------------------- | ---- | ------------------------- |
| uid      | number                 | 是    | 要查询的uid。                  |
| callback | AsyncCallback\<string> | 是    | 程序启动作为入参的回调函数,返回指定uid的包名。 |
S
shuaiyutao 已提交
1040 1041 1042 1043

**示例:**

```js
W
wanghang 已提交
1044 1045 1046 1047 1048 1049 1050 1051
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 已提交
1052 1053
```

qq_41863798's avatar
qq_41863798 已提交
1054

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

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

qq_41863798's avatar
api 9  
qq_41863798 已提交
1059
以异步方法通过bundleName和abilityName获取对应Icon的[PixelMap](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-image.md),使用Promise形式返回结果。
qq_41863798's avatar
qq_41863798 已提交
1060

qq_41863798's avatar
qq_41863798 已提交
1061 1062 1063 1064 1065 1066 1067 1068
**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED, ohos.permission.GET_BUNDLE_INFO

**系统能力:**

SystemCapability.BundleManager.BundleFramework

qq_41863798's avatar
qq_41863798 已提交
1069 1070
**参数:**

qq_41863798's avatar
qq_41863798 已提交
1071 1072 1073 1074
| 名称          | 类型                                       | 必填   | 描述                                       |
| ----------- | ---------------------------------------- | ---- | ---------------------------------------- |
| bundleName  | string                                   | 是    | 要查询的bundleName。                          |
| abilityName | string                                   | 是    | 要查询的abilityName。                         |
qq_41863798's avatar
qq_41863798 已提交
1075 1076 1077 1078

**返回值:**
| 类型                  | 说明                                                         |
| --------------------- | ------------------------------------------------------------ |
qq_41863798's avatar
qq_41863798 已提交
1079
| Promise\<image.PixelMap> | 返回值为[PixelMap](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-image.md)。 |
qq_41863798's avatar
qq_41863798 已提交
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.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 已提交
1094
## bundle.getAbilityIcon<sup>8+</sup>
qq_41863798's avatar
qq_41863798 已提交
1095

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

R
RayShih 已提交
1098
以异步方法通过bundleName和abilityName获取对应Icon的[PixelMap](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-image.md),使用callback形式返回结果。
qq_41863798's avatar
qq_41863798 已提交
1099

qq_41863798's avatar
qq_41863798 已提交
1100 1101 1102 1103 1104 1105 1106 1107
**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED, ohos.permission.GET_BUNDLE_INFO

**系统能力:**

SystemCapability.BundleManager.BundleFramework

qq_41863798's avatar
qq_41863798 已提交
1108 1109
**参数:**

qq_41863798's avatar
qq_41863798 已提交
1110 1111 1112 1113 1114
| 名称          | 类型                                       | 必填   | 描述                                       |
| ----------- | ---------------------------------------- | ---- | ---------------------------------------- |
| bundleName  | string                                   | 是    | 要查询的bundleName。                          |
| abilityName | string                                   | 是    | 要查询的abilityName。                         |
| callback   | AsyncCallback\<image.PixelMap> | 是   | 程序启动作为入参的回调函数,返回指定[PixelMap](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-image.md)。 |
qq_41863798's avatar
qq_41863798 已提交
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130

**示例:**

```js
let bundleName = com.example.myapplication;
let abilityName = com.example.myapplication.MainAbility;
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));
})
```


qq_41863798's avatar
qq_41863798 已提交
1131
## bundle.queryExtensionAbilityInfosByWant<sup>9+</sup>
qq_41863798's avatar
api 9  
qq_41863798 已提交
1132

qq_41863798's avatar
qq_41863798 已提交
1133
queryExtensionAbilityInfosByWant(want: Want, extensionFlags: number, userId?: number): Promise<Array\<ExtensionAbilityInfo>>
qq_41863798's avatar
api 9  
qq_41863798 已提交
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146

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

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED, ohos.permission.GET_BUNDLE_INFO

**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

H
HelloCrease 已提交
1147 1148 1149 1150 1151
| 名称             | 类型     | 必填   | 描述                                       |
| -------------- | ------ | ---- | ---------------------------------------- |
| want           | Want   | 是    | 包含要查询的应用程序包名称的意图。                        |
| extensionFlags | number | 是    | 用于指定返回ExtensionAbilityInfo信息。默认值:0,取值范围:大于等于0。 |
| userId         | number | 否    | 用户ID。默认值:调用方所在用户,取值范围:大于等于0              |
qq_41863798's avatar
api 9  
qq_41863798 已提交
1152 1153 1154

**返回值:**

H
HelloCrease 已提交
1155 1156
| 类型                                    | 说明                             |
| ------------------------------------- | ------------------------------ |
qq_41863798's avatar
api 9  
qq_41863798 已提交
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177
| Promise<Array\<ExtensionAbilityInfo>> | Promise形式返回ExtensionAbility信息。 |

**示例:**

```js
let extensionFlags = 0;
let userId = 100;
let want = {
    bundleName : "com.example.myapplication",
    abilityName : "com.example.myapplication.MainAbility"
};
bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, userId)
.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 已提交
1178
## bundle.queryExtensionAbilityInfosByWant<sup>9+</sup>
qq_41863798's avatar
api 9  
qq_41863798 已提交
1179

qq_41863798's avatar
qq_41863798 已提交
1180
queryExtensionAbilityInfosByWant(want: Want, extensionFlags: number, userId: number, callback: AsyncCallback<Array\<ExtensionAbilityInfo>>): void
qq_41863798's avatar
api 9  
qq_41863798 已提交
1181 1182 1183

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

qq_41863798's avatar
qq_41863798 已提交
1184 1185 1186 1187
**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED, ohos.permission.GET_BUNDLE_INFO

qq_41863798's avatar
api 9  
qq_41863798 已提交
1188 1189 1190 1191 1192 1193
**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

H
HelloCrease 已提交
1194 1195 1196 1197 1198 1199
| 名称             | 类型                                       | 必填   | 描述                                       |
| -------------- | ---------------------------------------- | ---- | ---------------------------------------- |
| want           | Want                                     | 是    | 指示包含要查询的应用程序包名称的意图。                      |
| extensionFlags | number                                   | 是    | 用于指定返回ExtensionAbilityInfo信息。默认值:0,取值范围:枚举值,大于等于0。 |
| userId         | number                                   | 是    | 用户ID。默认值:调用方所在用户,取值范围:大于等于0              |
| callback       | AsyncCallback<Array\<ExtensionAbilityInfo>> | 是    | 程序启动作为入参的回调函数,返回ExtensionAbility信息。      |
qq_41863798's avatar
api 9  
qq_41863798 已提交
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218

**示例:**

```js
let extensionFlags = 0;
let userId = 100;
let want = {
    bundleName : "com.example.myapplication",
    abilityName : "com.example.myapplication.MainAbility"
};
bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, userId, (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 已提交
1219
## bundle.queryExtensionAbilityInfosByWant<sup>9+</sup>
qq_41863798's avatar
api 9  
qq_41863798 已提交
1220

qq_41863798's avatar
qq_41863798 已提交
1221
queryExtensionAbilityInfosByWant(want: Want, extensionFlags: number, callback: AsyncCallback<Array\<ExtensionAbilityInfo>>): void;
qq_41863798's avatar
api 9  
qq_41863798 已提交
1222 1223 1224

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

qq_41863798's avatar
qq_41863798 已提交
1225 1226 1227 1228
**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED, ohos.permission.GET_BUNDLE_INFO

qq_41863798's avatar
api 9  
qq_41863798 已提交
1229 1230 1231 1232 1233 1234
**系统能力:**

SystemCapability.BundleManager.BundleFramework

**参数:**

H
HelloCrease 已提交
1235 1236 1237 1238 1239
| 名称             | 类型                                       | 必填   | 描述                                       |
| -------------- | ---------------------------------------- | ---- | ---------------------------------------- |
| want           | Want                                     | 是    | 指示包含要查询的应用程序包名称的意图。                      |
| extensionFlags | number                                   | 是    | 用于指定返回ExtensionAbilityInfo信息。默认值:0,取值范围:大于等于0。 |
| callback       | AsyncCallback<Array\<ExtensionAbilityInfo>> | 是    | 程序启动作为入参的回调函数,返回ExtensionAbility信息。      |
qq_41863798's avatar
api 9  
qq_41863798 已提交
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257

**示例:**

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

S
shuaiyutao 已提交
1258 1259
## ElementName

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

H
HelloCrease 已提交
1262 1263 1264 1265 1266 1267 1268
| 名称          | 读写属性 | 类型     | 必填   | 描述                                       |
| ----------- | ---- | ------ | ---- | ---------------------------------------- |
| deviceId    | 只读   | string | 否    | 表示运行指定Ability的设备ID。                      |
| bundleName  | 只读   | string | 是    | 表示包描述。如果在Want中同时指定了BundleName和AbilityName,则Want可以直接匹配到指定的Ability。 |
| abilityName | 只读   | string | 是    | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName,则Want可以直接匹配到指定的Ability。 |
| uri         | 只读   | string | 否    | 资源标识符。                                   |
| shortName   | 只读   | string | 否    | ElementName的简名。                          |
S
shuaiyutao 已提交
1269

qq_41863798's avatar
qq_41863798 已提交
1270
## InstallErrorCode
S
shuaiyutao 已提交
1271

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

H
HelloCrease 已提交
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295
| 名称                                       | 默认值  | 说明                        |
| ---------------------------------------- | ---- | ------------------------- |
| 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 已提交
1296 1297 1298 1299 1300

## BundleFlag

包的标志

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

H
HelloCrease 已提交
1303 1304 1305 1306 1307 1308 1309 1310 1311
| 名称                                       | 默认值        | 说明                  |
| ---------------------------------------- | ---------- | ------------------- |
| 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 已提交
1312
| GET_BUNDLE_WITH_EXTENSION_ABILITY<sup>9+</sup> | 0x00000020 | 获取包括Ability信息的扩展包信息 |
H
HelloCrease 已提交
1313
| GET_APPLICATION_INFO_WITH_METADATA<sup>8+</sup> | 0x00000040 | 获取应用的元数据信息          |
qq_41863798's avatar
qq_41863798 已提交
1314
| GET_ABILITY_INFO_SYSTEMAPP_ONLY<sup>8+</sup> | 0x00000080 | 获取仅包括系统应用的ability信息 |
H
HelloCrease 已提交
1315 1316 1317
| GET_ABILITY_INFO_WITH_DISABLE<sup>8+</sup> | 0x00000100 | 获取包括被禁用的ability信息   |
| GET_APPLICATION_INFO_WITH_DISABLE<sup>8+</sup> | 0x00000200 | 获取包括被禁用的应用信息        |
| GET_ALL_APPLICATION_INFO                 | 0xFFFF0000 | 获取应用所有的信息           |
W
wanghang 已提交
1318 1319 1320 1321 1322

## BundleOptions

包的选项

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

H
HelloCrease 已提交
1325 1326 1327
| 名称     | 类型     | 可读   | 可写   | 说明                           |
| ------ | ------ | ---- | ---- | ---------------------------- |
| userId | number | 是    | 是    | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 |
W
wanghang 已提交
1328 1329 1330

## BundleInfo

W
wanghang 已提交
1331
应用包的信息
W
wanghang 已提交
1332

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

H
HelloCrease 已提交
1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360
| 名称                                | 类型                           | 可读   | 可写   | 说明                    |
| --------------------------------- | ---------------------------- | ---- | ---- | --------------------- |
| name                              | string                       | 是    | 否    | 应用包的名称                |
| type                              | string                       | 是    | 否    | 应用包类型                 |
| appId                             | string                       | 是    | 否    | 应用包里应用程序的id           |
| uid                               | number                       | 是    | 否    | 应用包里应用程序的uid          |
| installTime                       | number                       | 是    | 否    | HAP包安装时间              |
| updateTime                        | number                       | 是    | 否    | HAP包更新时间              |
| appInfo                           | ApplicationInfo              | 是    | 否    | 应用程序的配置信息             |
| abilityInfos                      | Array\<AbilityInfo>          | 是    | 否    | Ability的配置信息          |
| reqPermissions                    | Array\<string>               | 是    | 否    | 应用运行时需向系统申请的权限集合      |
| reqPermissionDetails              | Array\<ReqPermissionDetail>  | 是    | 否    | 应用运行时需向系统申请的权限集合的详细信息 |
| vendor                            | string                       | 是    | 否    | 应用包的供应商               |
| versionCode                       | number                       | 是    | 否    | 应用包的版本号               |
| versionName                       | string                       | 是    | 否    | 应用包的版本文本描述信息          |
| compatibleVersion                 | number                       | 是    | 否    | 运行应用包所需要最低的SDK版本号     |
| targetVersion                     | number                       | 是    | 否    | 运行应用包所需要最高SDK版本号      |
| isCompressNativeLibs              | boolean                      | 是    | 否    | 是否压缩应用包的本地库,默认为true   |
| hapModuleInfos                    | Array\<HapModuleInfo>        | 是    | 否    | 模块的配置信息               |
| entryModuleName                   | string                       | 是    | 否    | Entry的模块名称            |
| cpuAbi                            | string                       | 是    | 否    | 应用包的cpuAbi信息          |
| isSilentInstallation              | string                       | 是    | 否    | 是否通过静默安装              |
| minCompatibleVersionCode          | number                       | 是    | 否    | 分布式场景下的应用包兼容的最低版本     |
| entryInstallationFree             | boolean                      | 是    | 否    | Entry是否支持免安装          |
| reqPermissionStates<sup>8+</sup>  | Array\<number>               | 是    | 否    | 申请权限的授予状态             |
| extensionAbilityInfo<sup>9+</sup> | Array\<ExtensionAbilityInfo> | 是    | 否    | ability的可扩展信息         |
W
wanghang 已提交
1361 1362 1363

## ApplicationInfo

W
wanghang 已提交
1364
应用程序信息
W
wanghang 已提交
1365

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

qq_41863798's avatar
qq_41863798 已提交
1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391
| 名称                         | 类型                                 | 可读   | 可写   | 说明                    |
| -------------------------- | ---------------------------------- | ---- | ---- | --------------------- |
| name                       | string                             | 是    | 否    | 应用程序的名称               |
| description                | string                             | 是    | 否    | 应用程序的描述               |
| descriptionId              | number                             | 是    | 否    | 应用程序的描述id             |
| systemApp                  | boolean                            | 是    | 否    | 判断是否为系统应用程序,默认为false  |
| enabled                    | boolean                            | 是    | 否    | 判断应用程序是否可以使用,默认为true  |
| label                      | string                             | 是    | 否    | 应用程序的标签               |
| labelId                    | string                             | 是    | 否    | 应用程序的标签id             |
| icon                       | string                             | 是    | 否    | 应用程序的图标               |
| iconId                     | string                             | 是    | 否    | 应用程序的图标id             |
| process                    | string                             | 是    | 否    | 应用程序的进程,如果不设置,默认为包的名称 |
| supportedModes             | number                             | 是    | 否    | 应用程序支持的运行模式           |
| moduleSourceDirs           | Array\<string>                     | 是    | 否    | 应用程序的资源存放的相对路径        |
| permissions                | Array\<string>                     | 是    | 否    | 访问应用程序所需的权限           |
| moduleInfos                | Array\<ModuleInfo>                 | 是    | 否    | 应用程序的模块信息             |
| entryDir                   | string                             | 是    | 否    | 应用程序的文件保存路径           |
| codePath<sup>8+</sup>      | string                             | 是    | 否    | 应用程序的安装目录             |
| metaData<sup>8+</sup>      | Map<string, Array\<CustomizeData>> | 是    | 否    | 应用程序的自定义元信息           |
| metaData<sup>9+</sup>      | Map<string, Array\<Metadata>>      | 是    | 否    | 应用程序的元信息              |
| removable<sup>8+</sup>     | boolean                            | 是    | 否    | 应用程序是否可以被移除           |
| accessTokenId<sup>8+</sup> | number                             | 是    | 否    | 应用程序的accessTokenId    |
| uid<sup>8+</sup>           | number                             | 是    | 否    | 应用程序的uid              |
| entityType<sup>9+</sup>    | string                             | 是    | 否    | 应用程序的实体类型             |
W
wanghang 已提交
1392 1393 1394

## ModuleInfo

W
wanghang 已提交
1395
应用程序的模块信息
W
wanghang 已提交
1396

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

H
HelloCrease 已提交
1399 1400 1401 1402
| 名称              | 类型     | 可读   | 可写   | 说明   |
| --------------- | ------ | ---- | ---- | ---- |
| moduleName      | string | 是    | 否    | 模块名称 |
| moduleSourceDir | string | 是    | 否    | 安装目录 |
W
wanghang 已提交
1403 1404 1405

## CustomizeData

W
wanghang 已提交
1406
自定义元数据
W
wanghang 已提交
1407

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

H
HelloCrease 已提交
1410 1411 1412 1413 1414
| 名称                 | 类型     | 可读   | 可写   | 说明       |
| ------------------ | ------ | ---- | ---- | -------- |
| name               | string | 是    | 是    | 自定义元数据名称 |
| value              | string | 是    | 是    | 自定义元数据值  |
| extra<sup>8+</sup> | string | 是    | 是    | 自定义资源    |
W
wanghang 已提交
1415 1416 1417 1418


## HapModuleInfo

W
wanghang 已提交
1419 1420
Hap模块信息

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

qq_41863798's avatar
qq_41863798 已提交
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442
| 名称                                | 类型                           | 可读   | 可写   | 说明                 |
| --------------------------------- | ---------------------------- | ---- | ---- | ------------------ |
| name                              | string                       | 是    | 否    | 模块名称               |
| description                       | string                       | 是    | 否    | 模块描述信息             |
| descriptionId                     | number                       | 是    | 否    | 描述信息ID             |
| icon                              | string                       | 是    | 否    | 模块图标               |
| label                             | string                       | 是    | 否    | 模块标签               |
| labelId                           | number                       | 是    | 否    | 模块标签ID             |
| iconId                            | number                       | 是    | 否    | 模块图标ID             |
| backgroundImg                     | string                       | 是    | 否    | 模块背景图片             |
| supportedModes                    | number                       | 是    | 否    | 模块支持的模式            |
| reqCapabilities                   | Array\<string>               | 是    | 否    | 模块运行需要的能力          |
| deviceTypes                       | Array\<string>               | 是    | 否    | 支持运行的设备类型          |
| abilityInfo                       | Array\<AbilityInfo>          | 是    | 否    | Ability信息          |
| moduleName                        | string                       | 是    | 否    | 模块名                |
| mainAbilityName                   | string                       | 是    | 否    | 入口Ability名称        |
| installationFree                  | boolean                      | 是    | 否    | 是否支持免安装            |
| mainElementName<sup>9+</sup>      | string                       | 是    | 否    | 入口ability信息        |
| extensionAbilityInfo<sup>9+</sup> | Array\<ExtensionAbilityInfo> | 是    | 否    | extensionAbility信息 |
| metadata<sup>9+</sup>             | Array\<Metadata>             | 是    | 否    | Ability的元信息        |
W
wanghang 已提交
1443 1444 1445

## ReqPermissionDetail

W
wanghang 已提交
1446 1447
应用运行时需向系统申请的权限集合的详细信息

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

H
HelloCrease 已提交
1450 1451 1452 1453 1454
| 名称        | 类型        | 可读   | 可写   | 说明         |
| --------- | --------- | ---- | ---- | ---------- |
| name      | string    | 是    | 是    | 需要使用的权限名称  |
| reason    | string    | 是    | 是    | 描述申请权限的原因  |
| usedScene | UsedScene | 是    | 是    | 权限使用的场景和时机 |
W
wanghang 已提交
1455 1456 1457

## UsedScene

W
wanghang 已提交
1458 1459
描述权限使用的场景和时机

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

H
HelloCrease 已提交
1462 1463 1464 1465
| 名称        | 类型             | 可读   | 可写   | 说明               |
| --------- | -------------- | ---- | ---- | ---------------- |
| abilities | Array\<string> | 是    | 是    | 使用到该权限的Ability集合 |
| when      | string         | 是    | 是    | 使用该权限的时机         |
W
wanghang 已提交
1466 1467 1468 1469


## AbilityInfo

W
wanghang 已提交
1470 1471
Ability信息

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

H
HelloCrease 已提交
1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503
| 名称                    | 类型                    | 可读   | 可写   | 说明                       |
| --------------------- | --------------------- | ---- | ---- | ------------------------ |
| bundleName            | string                | 是    | 否    | 应用包名                     |
| name                  | string                | 是    | 否    | Ability名称                |
| label                 | string                | 是    | 否    | Ability对用户显示的名称          |
| description           | string                | 是    | 否    | Ability的描述               |
| icon                  | string                | 是    | 否    | Ability的图标资源文件索引         |
| descriptionId         | number                | 是    | 否    | Ability的描述id             |
| iconId                | number                | 是    | 否    | Ability的图标id             |
| moduleName            | string                | 是    | 否    | Ability所属的HAP包的名称        |
| process               | string                | 是    | 否    | Ability的进程,如果不设置,默认为包的名称 |
| targetAbility         | string                | 是    | 否    | 当前Ability重用的目标Ability    |
| backgroundModes       | number                | 是    | 否    | 表示后台服务的类型                |
| isVisible             | boolean               | 是    | 否    | 判断Ability是否可以被其他应用调用     |
| formEnabled           | boolean               | 是    | 否    | 判断Ability是否提供卡片能力        |
| type                  | AbilityType           | 是    | 否    | Ability类型                |
| orientation           | DisplayOrientation    | 是    | 否    | Ability的显示模式             |
| launchMode            | LaunchMode            | 是    | 否    | Ability的启动模式             |
| permissions           | Array\<string>        | 是    | 否    | 被其他应用Ability调用时需要申请的权限集合 |
| deviceTypes           | Array\<string>        | 是    | 否    | Ability支持的设备类型           |
| deviceCapabilities    | Array\<string>        | 是    | 否    | Ability需要的设备能力           |
| readPermission        | string                | 是    | 否    | 读取Ability数据所需的权限         |
| writePermission       | string                | 是    | 否    | 向Ability写数据所需的权限         |
| applicationInfo       | ApplicationInfo       | 是    | 否    | 应用程序的配置信息                |
| uri                   | string                | 是    | 否    | 获取Ability的统一资源标识符(URI)   |
| labelId               | number                | 是    | 否    | Ability的标签id             |
| subType               | AbilitySubType        | 是    | 否    | Ability中枚举使用的模板的子类型      |
| metaData<sup>8+</sup> | Array\<CustomizeData> | 是    | 否    | ability的自定义信息            |
| metaData<sup>9+</sup> | Array\<Metadata>      | 是    | 否    | ability的元信息              |
| enabled<sup>8+</sup>  | boolean               | 是    | 否    | ability是否可用              |
W
wanghang 已提交
1504 1505 1506

## AbilityType

W
wanghang 已提交
1507 1508
Ability类型

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

H
HelloCrease 已提交
1511 1512 1513 1514 1515 1516
| 名称      | 类型   | 说明                |
| ------- | ---- | ----------------- |
| UNKNOWN | 无    | 未知Ability类型       |
| PAGE    | 无    | Ability有一个UI界面    |
| SERVICE | 无    | Ability没有UI界面     |
| DATA    | 无    | Ability用于提供数据访问服务 |
W
wanghang 已提交
1517 1518 1519

## DisplayOrientation

W
wanghang 已提交
1520 1521
屏幕显示方向

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

H
HelloCrease 已提交
1524 1525 1526 1527 1528 1529
| 名称            | 类型   | 说明            |
| ------------- | ---- | ------------- |
| UNSPECIFIED   | 无    | 屏幕方向--不指定     |
| LANDSCAPE     | 无    | 屏幕方向--横屏      |
| PORTRAIT      | 无    | 屏幕方向--竖屏      |
| FOLLOW_RECENT | 无    | 屏幕方向--紧跟上一个组件 |
W
wanghang 已提交
1530 1531 1532

## LaunchMode

W
wanghang 已提交
1533 1534
启动模式

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

H
HelloCrease 已提交
1537 1538 1539 1540
| 名称        | 类型   | 说明            |
| --------- | ---- | ------------- |
| SINGLETON | 0    | Ability只有一个示例 |
| STANDARD  | 1    | Ability有多个示例  |
W
wanghang 已提交
1541 1542 1543 1544 1545

## AbilitySubType

Ability的子类型

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

H
HelloCrease 已提交
1548 1549 1550
| 名称          | 类型   | 说明                   |
| ----------- | ---- | -------------------- |
| UNSPECIFIED | 0    | 未定义Ability子类型        |
W
wanghang 已提交
1551
| CA          | 1    | Ability子类型是带有 UI 的服务 |
qq_41863798's avatar
api 9  
qq_41863798 已提交
1552 1553


qq_41863798's avatar
qq_41863798 已提交
1554
## ExtensionAbilityType<sup>9+</sup>
qq_41863798's avatar
api 9  
qq_41863798 已提交
1555 1556 1557

ExtensionAbility的类型

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

H
HelloCrease 已提交
1560 1561 1562
| 名称                             | 类型   | 说明                        |
| ------------------------------ | ---- | ------------------------- |
| FORM<sup>9+</sup>              | 0    | ExtensionAbility的类型包括卡片   |
qq_41863798's avatar
qq_41863798 已提交
1563
| WORK_SCHEDULER<sup>9+</sup>    | 1    | ExtensionAbility的类型包括行程安排 |
H
HelloCrease 已提交
1564 1565 1566 1567 1568 1569 1570 1571
| 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的类型包括墙纸   |
| UNSPECIFIED<sup>9+</sup>       | 9    | ExtensionAbility未指定类型     |
qq_41863798's avatar
qq_41863798 已提交
1572 1573

## ExtensionFlag<sup>9+</sup>
qq_41863798's avatar
api 9  
qq_41863798 已提交
1574 1575 1576

扩展标志

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

H
HelloCrease 已提交
1579 1580 1581 1582 1583
| 名称                                       | 默认值        | 说明                             |
| ---------------------------------------- | ---------- | ------------------------------ |
| 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 已提交
1584
| GET_EXTENSION_INFO_WITH_METADATA<sup>9+</sup> | 0x00000020 | 获取携带元数据信息的extensionAbilityInfo |
qq_41863798's avatar
api 9  
qq_41863798 已提交
1585 1586


qq_41863798's avatar
qq_41863798 已提交
1587 1588 1589 1590 1591 1592
## ColorMode

颜色模式

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

H
HelloCrease 已提交
1593 1594 1595
| 名称         | 类型   | 说明   |
| ---------- | ---- | ---- |
| AUTO_MODE  | -1   | 自动模式 |
qq_41863798's avatar
qq_41863798 已提交
1596 1597
| DARK_MODE  | 0    | 黑色模式 |
| LIGHT_MODE | 1    | 亮度模式 |
qq_41863798's avatar
qq_41863798 已提交
1598 1599 1600 1601 1602 1603 1604 1605


## GrantStatus

授予状态

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

H
HelloCrease 已提交
1606 1607 1608 1609
| 名称                 | 类型   | 说明   |
| ------------------ | ---- | ---- |
| PERMISSION_DENIED  | -1   | 拒绝许可 |
| PERMISSION_GRANTED | 0    | 批准   |
qq_41863798's avatar
qq_41863798 已提交
1610 1611


qq_41863798's avatar
qq_41863798 已提交
1612
## ExtensionAbilityInfo<sup>9+</sup>
qq_41863798's avatar
api 9  
qq_41863798 已提交
1613 1614 1615

ExtensionAbility信息

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

H
HelloCrease 已提交
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633
| 名称                                | 类型                          | 可读   | 可写   | 说明                                |
| --------------------------------- | --------------------------- | ---- | ---- | --------------------------------- |
| bundleName<sup>9+</sup>           | string                      | 是    | 否    | 应用包名                              |
| moduleName<sup>9+</sup>           | string                      | 是    | 否    | ExtensionAbility所属的HAP包的名称        |
| name<sup>9+</sup>                 | string                      | 是    | 否    | ExtensionAbility名称                |
| labelId<sup>9+</sup>              | number                      | 是    | 否    | ExtensionAbility的标签id             |
| descriptionId<sup>9+</sup>        | number                      | 是    | 否    | ExtensionAbility的描述id             |
| iconId<sup>9+</sup>               | number                      | 是    | 否    | ExtensionAbility的图标id             |
| isVisible<sup>9+</sup>            | boolean                     | 是    | 否    | 判断ExtensionAbility是否可以被其他应用调用     |
| extensionAbilityType<sup>9+</sup> | bundle.ExtensionAbilityType | 是    | 否    | ExtensionAbility类型                |
| permissions<sup>9+</sup>          | Array\<string>              | 是    | 否    | 被其他应用ExtensionAbility调用时需要申请的权限集合 |
| applicationInfo<sup>9+</sup>      | ApplicationInfo             | 是    | 否    | 应用程序的配置信息                         |
| metaData<sup>9+</sup>             | Array\<Metadata>            | 是    | 否    | ExtensionAbility的元信息              |
| enabled<sup>9+</sup>              | boolean                     | 是    | 否    | ExtensionAbility是否可用              |
| readPermission<sup>9+</sup>       | string                      | 是    | 否    | 读取ExtensionAbility数据所需的权限         |
| writePermission<sup>9+</sup>      | string                      | 是    | 否    | 向ExtensionAbility写数据所需的权限         |
qq_41863798's avatar
qq_41863798 已提交
1634 1635 1636


## Metadata<sup>9+</sup>
qq_41863798's avatar
api 9  
qq_41863798 已提交
1637 1638 1639

元数据信息

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

H
HelloCrease 已提交
1642 1643 1644 1645 1646
| 名称                    | 类型     | 可读   | 可写   | 说明    |
| --------------------- | ------ | ---- | ---- | ----- |
| name<sup>9+</sup>     | string | 是    | 是    | 元数据名称 |
| value<sup>9+</sup>    | string | 是    | 是    | 元数据值  |
| resource<sup>9+</sup> | string | 是    | 是    | 元数据资源 |