js-apis-Bundle.md 43.6 KB
Newer Older
S
shuaiyutao 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14
# Bundle模块(JS端SDK接口)

## 导入模块

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

## 系统能力

SystemCapability.BundleManager.BundleFramework

## 权限列表

W
wanghang 已提交
15 16 17 18 19
|  权限 | 权限等级 | 描述 |
|-------| --------- | ---- |
| ohos.permission.GET_BUNDLE_INFO | normal | 仅限查询本应用信息 |
| ohos.permission.GET_BUNDLE_INFO_PRIVILEGED | system_basic | 可查询所有应用信息 |
| ohos.permission.INSTALL_BUNDLE | system_core | 可安装、卸载应用 |
S
shuaiyutao 已提交
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35

## bundle.getApplicationInfo

getApplicationInfo(bundleName: string, bundleFlags: number, userId: number): Promise\<ApplicationInfo>

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

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED,ohos.permission.GET_BUNDLE_INFO

**参数:**

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

**返回值:**

| 类型      | 说明 |
| ----------- | -------- |
| Promise\<ApplicationInfo> | Promise形式返回应用程序信息。 |

**示例:**

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



## 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

**参数:**

| 名称        | 类型                            | 必填 | 描述                                                         |
| ----------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| bundleName  | string                          | 是   | 要查询的应用程序包名称。                                     |
W
wanghang 已提交
76 77
| bundleFlags | number                          | 是   | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
| userId      | number                          | 是   | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。                     |
S
shuaiyutao 已提交
78 79 80 81 82
| callback    | AsyncCallback\<ApplicationInfo> | 是   | 程序启动作为入参的回调函数,返回应用程序信息。               |

**示例:**

```js
W
wanghang 已提交
83 84 85 86 87 88 89 90 91 92
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 已提交
93 94 95 96 97 98
```



## bundle.getAllBundleInfo

W
wanghang 已提交
99
getAllBundleInfo(bundleFlag: BundleFlag, userId?: number): Promise<Array\<BundleInfo>>
S
shuaiyutao 已提交
100 101 102 103 104 105 106 107 108 109 110

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

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

**参数:**

| 名称       | 类型       | 必填 | 描述                                                        |
| ---------- | ---------- | ---- | ----------------------------------------------------------- |
W
wanghang 已提交
111 112
| bundleFlag | BundleFlag | 是   | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
| userId     | number     | 否   | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。  |
S
shuaiyutao 已提交
113 114 115 116 117 118 119 120 121 122

**返回值:**

| 类型                        | 说明                                |
| --------------------------- | ----------------------------------- |
| Promise<Array\<BundleInfo>> | Promise形式返回所有可用的BundleInfo |

**示例:**

```js
W
wanghang 已提交
123 124 125 126 127 128 129
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 已提交
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
})
```



## bundle.getAllBundleInfo

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

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

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

**参数:**

| 名称       | 类型                              | 必填 | 描述                                                         |
| ---------- | --------------------------------- | ---- | ------------------------------------------------------------ |
W
wanghang 已提交
149
| bundleFlag | BundleFlag                        | 是   | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。|
S
shuaiyutao 已提交
150 151 152 153 154
| callback   | AsyncCallback<Array\<BundleInfo>> | 是   | 程序启动作为入参的回调函数,返回所有可用的BundleInfo。       |

**示例:**

```js
W
wanghang 已提交
155 156 157 158 159 160 161 162 163
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 已提交
164

W
wanghang 已提交
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195

## bundle.getAllBundleInfo

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

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

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

**参数:**

| 名称       | 类型                              | 必填 | 描述                                                         |
| ---------- | --------------------------------- | ---- | ------------------------------------------------------------ |
| bundleFlag | BundleFlag                        | 是   | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。|
| userId     | number                            | 是   | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。  |
| callback   | AsyncCallback<Array\<BundleInfo>> | 是   | 程序启动作为入参的回调函数,返回所有可用的BundleInfo。       |

**示例:**

```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 已提交
196 197 198 199 200 201
```



## bundle.getBundleInfo

W
wanghang 已提交
202
getBundleInfo(bundleName: string, bundleFlags: number, options?: BundleOptions): Promise\<BundleInfo>
S
shuaiyutao 已提交
203 204 205 206 207 208 209 210 211 212 213 214

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

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED,ohos.permission.GET_BUNDLE_INFO

**参数:**

| 名称        | 类型   | 必填 | 描述                                                         |
| ----------- | ------ | ---- | ------------------------------------------------------------ |
| bundleName  | string | 是   | 包名                                                         |
W
wanghang 已提交
215 216
| bundleFlags | number | 是   | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
| options     | BundleOptions              | 否   | 包含userid和networkid。                                    |
S
shuaiyutao 已提交
217 218 219 220 221 222 223 224 225 226

**返回值:**

| 类型                 | 说明                                       |
| -------------------- | ------------------------------------------ |
| Promise\<BundleInfo> | 返回值为Promise对象,Promise中包含包信息。 |

**示例:**

```js
W
wanghang 已提交
227 228 229 230 231 232 233 234 235 236 237
let bundleName = "com.example.myapplication";
let bundleFlags = 1;
let options = {
  "userId" : 100,
  "networkId" : null
};
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 已提交
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
})
```



## bundle.getBundleInfo

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

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

**需要权限:**

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED,ohos.permission.GET_BUNDLE_INFO

**参数:**

| 名称        | 类型                       | 必填 | 描述                                                         |
| ----------- | -------------------------- | ---- | ------------------------------------------------------------ |
| bundleName  | string                     | 是   | 包名                                                         |
W
wanghang 已提交
258
| bundleFlags | number                     | 是   | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
S
shuaiyutao 已提交
259 260 261 262 263
| callback    | AsyncCallback\<BundleInfo> | 是   | 程序启动作为入参的回调函数,返回包信息。                     |

**示例:**

```js
W
wanghang 已提交
264 265 266 267 268 269 270 271 272
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 已提交
273 274 275
```


W
wanghang 已提交
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
## 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

**参数:**

| 名称        | 类型                       | 必填 | 描述                                                         |
| ----------- | -------------------------- | ---- | ------------------------------------------------------------ |
| bundleName  | string                     | 是   | 包名                                                         |
| bundleFlags | number                     | 是   | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
| options     | BundleOptions              | 是   | 包含userid和networkid。                                    |
| callback    | AsyncCallback\<BundleInfo> | 是   | 程序启动作为入参的回调函数,返回包信息。                     |

**示例:**

```js
let bundleName = "com.example.myapplication";
let bundleFlags = 1;
let options = {
  "userId" : 100,
  "networkId" : null
};
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 已提交
313 314 315 316 317 318 319 320 321

## bundle.getAllApplicationInfo

getAllApplicationInfo(bundleFlags: number, userId: number): Promise<Array\<ApplicationInfo>>

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

**需要权限:**

W
wanghang 已提交
322
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
S
shuaiyutao 已提交
323 324 325 326 327

**参数:**

| 名称        | 类型   | 必填 | 描述                                                   |
| ----------- | ------ | ---- | ------------------------------------------------------ |
W
wanghang 已提交
328 329
| bundleFlags | number | 是   | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
| userId      | number | 是   | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。   |
S
shuaiyutao 已提交
330 331 332 333 334 335 336 337 338 339

**返回值:**

| 类型                             | 说明                                             |
| -------------------------------- | ------------------------------------------------ |
| Promise<Array\<ApplicationInfo>> | 返回值为Promise对象,Promise中包含应用信息列表。 |

**示例:**

```js
W
wanghang 已提交
340 341 342 343 344 345 346
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 已提交
347 348 349 350 351 352 353 354 355 356 357 358 359
})
```



## bundle.getAllApplicationInfo

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

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

**需要权限:**

W
wanghang 已提交
360
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
S
shuaiyutao 已提交
361 362 363 364 365

**参数:**

| 名称        | 类型                                   | 必填 | 描述                                                   |
| ----------- | -------------------------------------- | ---- | ------------------------------------------------------ |
W
wanghang 已提交
366 367
| bundleFlags | number                                 | 是   | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。|
| userId      | number                                 | 是   | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。    |
S
shuaiyutao 已提交
368 369 370 371 372
| callback    | AsyncCallback<Array\<ApplicationInfo>> | 是   | 程序启动作为入参的回调函数,返回应用信息列表。         |

**示例:**

```js
W
wanghang 已提交
373 374 375 376 377 378 379 380 381
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 已提交
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
```



## 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

**参数:**

| 名称        | 类型   | 必填 | 描述                                                         |
| ----------- | ------ | ---- | ------------------------------------------------------------ |
| want        | Want   | 是   | 包含要查询的应用程序包名称的意图。                           |
W
wanghang 已提交
401
| bundleFlags | number | 是   | 用于指定返回abilityInfo信息。默认值:0,取值范围:大于等于0。 |
S
shuaiyutao 已提交
402 403 404 405 406 407 408 409 410 411 412
| userId      | number | 否   | 用户ID。默认值:调用方所在用户,取值范围:大于等于0          |

**返回值:**

| 类型                         | 说明                         |
| ---------------------------- | ---------------------------- |
| Promise<Array\<AbilityInfo>> | Promise形式返回Ability信息。 |

**示例:**

```js
W
wanghang 已提交
413 414 415 416 417 418 419 420 421 422 423
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 已提交
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
})
```



## bundle.queryAbilityByWant

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

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

**参数:**

| 名称        | 类型                               | 必填 | 描述                                                         |
| ----------- | ---------------------------------- | ---- | ------------------------------------------------------------ |
| want        | Want                               | 是   | 指示包含要查询的应用程序包名称的意图。                       |
W
wanghang 已提交
440 441
| bundleFlags | number                             | 是   | 用于指定返回abilityInfo信息。默认值:0,取值范围:大于等于0。 |
| userId      | number                             | 是   | 用户ID。默认值:调用方所在用户,取值范围:大于等于0          |
S
shuaiyutao 已提交
442 443 444 445 446
| callback    | AsyncCallback<Array\<AbilityInfo>> | 是   | 程序启动作为入参的回调函数,返回Ability信息。                |

**示例:**

```js
W
wanghang 已提交
447 448 449 450 451 452 453 454 455 456 457 458 459
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 已提交
460 461 462 463 464 465 466 467 468 469 470 471 472
```

## bundle.queryAbilityByWant

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

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

**参数:**

| 名称        | 类型                               | 必填 | 描述                                                         |
| ----------- | ---------------------------------- | ---- | ------------------------------------------------------------ |
| want        | Want                               | 是   | 指示包含要查询的应用程序包名称的意图。                       |
W
wanghang 已提交
473
| bundleFlags | number                             | 是   | 用于指定返回abilityInfo信息。默认值:0,取值范围:大于等于0。 |
S
shuaiyutao 已提交
474 475 476 477 478
| callback    | AsyncCallback<Array\<AbilityInfo>> | 是   | 程序启动作为入参的回调函数,返回Ability信息。                |

**示例:**

```js
W
wanghang 已提交
479 480 481 482 483 484 485 486 487 488 489 490
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 已提交
491 492 493 494 495 496 497 498 499 500 501 502 503
```

## bundle.getBundleArchiveInfo

getBundleArchiveInfo(hapFilePath: string, bundleFlags: number): Promise\<BundleInfo>

以异步方法从给定的HAP中获取BundleInfo,使用Promise形式返回结果。

**参数:**

| 名称        | 类型   | 必填 | 描述                                                         |
| ----------- | ------ | ---- | ------------------------------------------------------------ |
| hapFilePath | string | 是   | HAP文件路径                                                  |
W
wanghang 已提交
504
| bundleFlags | number | 是   | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
S
shuaiyutao 已提交
505 506 507 508 509 510 511 512 513 514

**返回值:**

| 类型                 | 说明                                       |
| -------------------- | ------------------------------------------ |
| Promise\<BundleInfo> | 返回值为Promise对象,Promise中包含包信息。 |

**示例:**

```js
W
wanghang 已提交
515 516 517 518 519 520 521
let hapFilePath = "/data/test.hap";
let bundleFlags = 1;
bundle.getBundleArchiveInfo(hapFilePath, bundleFlags)
.then((data) => {
    console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
S
shuaiyutao 已提交
522 523 524 525 526 527 528 529 530 531 532 533 534 535
})
```

## bundle.getBundleArchiveInfo

getBundleArchiveInfo(hapFilePath: string, bundleFlags: number, callback: AsyncCallback\<BundleInfo>): void

以异步方法从给定的HAP中获取BundleInfo,使用callback形式返回结果。

**参数:**

| 名称        | 类型                      | 必填 | 描述                                                         |
| ----------- | ------------------------- | ---- | ------------------------------------------------------------ |
| hapFilePath | string                    | 是   | HAP文件路径                                                  |
W
wanghang 已提交
536
| bundleFlags | number                    | 是   | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
S
shuaiyutao 已提交
537 538 539 540 541
| callback    | AsyncCallback<BundleInfo> | 是   | 程序启动作为入参的回调函数,返回包信息。                     |

**示例:**

```js
W
wanghang 已提交
542 543 544 545 546 547 548 549 550
let hapFilePath = "/data/test.hap";
let bundleFlags = 1;
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));
})
S
shuaiyutao 已提交
551 552 553 554 555 556 557 558
```

## bundle.getBundleInstaller

getBundleInstaller(): Promise<BundleInstaller>

以异步方法获取BundleInstaller,使用Promise形式返回结果。

W
wanghang 已提交
559 560 561 562
**需要权限:**

ohos.permission.INSTALL_BUNDLE

S
shuaiyutao 已提交
563 564 565 566 567 568 569 570 571
**返回值:**

| 类型                     | 说明                                                |
| ------------------------ | --------------------------------------------------- |
| Promise<BundleInstaller> | 返回值为Promise对象,Promise中包含BundleInstaller。 |

**示例:**

```js
W
wanghang 已提交
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
let bundleFilePaths = ['/data/test.hap'];
let param = {
    userId : 100,
    installFlag : 1,
    isKeepData : false
};
bundle.getBundleInstaller()
.then((installerObject) => {
    console.info('Operation successful. ');
    installerObject.install(bundleFilePaths, param)
    .then((data) => {
        console.info('Operation successful. Data:' + JSON.stringify(data));
    }).catch((error) => {
        console.error('Operation failed. Cause: ' + JSON.stringify(error));
    })
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
S
shuaiyutao 已提交
589 590 591 592 593 594 595
})
```

## bundle.getBundleInstaller

getBundleInstaller(callback: AsyncCallback<BundleInstaller>): void;

W
wusongqing 已提交
596
以异步方法获取BundleInstaller,使用callback形式返回结果。
S
shuaiyutao 已提交
597

W
wanghang 已提交
598 599 600 601
**需要权限:**

ohos.permission.INSTALL_BUNDLE

S
shuaiyutao 已提交
602 603 604 605 606 607 608 609 610
**参数:**

| 名称     | 类型                           | 必填 | 描述                                              |
| -------- | ------------------------------ | ---- | ------------------------------------------------- |
| callback | AsyncCallback<BundleInstaller> | 是   | 程序启动作为入参的回调函数,返回BundleInstaller。 |

**示例:**

```js
W
wanghang 已提交
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
let bundleFilePaths = ['/data/test.hap'];
let param = {
    userId : 100,
    installFlag : 1,
    isKeepData : false
};
bundle.getBundleInstaller((err, installerObject) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
    }
    console.info('Operation successful. Data:' + JSON.stringify(installerObject));
    installerObject.install(bundleFilePaths, param, (err, data) => {
        if (err) {
            console.error('Operation failed. Cause: ' + JSON.stringify(err));
        }
        console.info('Operation successful. Data:' + JSON.stringify(data));
    })
S
shuaiyutao 已提交
628 629 630 631
})
```


W
wanghang 已提交
632
## bundle.getLaunchWantForBundle
S
shuaiyutao 已提交
633

W
wanghang 已提交
634 635 636
getLaunchWantForBundle(bundleName: string): Promise\<Want>

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

**参数:**

| 名称       | 类型   | 必填 | 描述     |
| ---------- | ------ | ---- | -------- |
W
wanghang 已提交
642
| bundleName | string | 是   | 要查询的应用程序包名称。 |
S
shuaiyutao 已提交
643 644

**返回值:**
W
wanghang 已提交
645 646 647
| 类型                  | 说明                                                         |
| --------------------- | ------------------------------------------------------------ |
| Promise\<Want> | 返回值为Promise对象,Promise中包含拉起指定应用的Want对象。 |
S
shuaiyutao 已提交
648 649 650 651

**示例:**

```js
W
wanghang 已提交
652 653 654 655 656 657 658
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 已提交
659 660
```

W
wanghang 已提交
661
## bundle.getLaunchWantForBundle
S
shuaiyutao 已提交
662

W
wanghang 已提交
663
getLaunchWantForBundle(bundleName: string, callback: AsyncCallback<Want>): void;
S
shuaiyutao 已提交
664

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

**参数:**

W
wanghang 已提交
669 670 671 672
| 名称       | 类型   | 必填 | 描述     |
| ---------- | ------ | ---- | -------- |
| bundleName | string | 是   | 要查询的应用程序包名称。 |
| callback   | AsyncCallback\<Want> | 是   | 程序启动作为入参的回调函数,返回拉起指定应用的want对象。 |
S
shuaiyutao 已提交
673 674 675 676

**示例:**

```js
W
wanghang 已提交
677 678 679 680 681 682 683 684
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 已提交
685 686 687
```


W
wanghang 已提交
688 689 690
## bundle.getNameForUid

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

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

**参数:**

| 名称       | 类型   | 必填 | 描述     |
| ---------- | ------ | ---- | -------- |
W
wanghang 已提交
698
| uid | number | 是   | 要查询的uid。 |
S
shuaiyutao 已提交
699 700 701 702

**返回值:**
| 类型                  | 说明                                                         |
| --------------------- | ------------------------------------------------------------ |
W
wanghang 已提交
703
| Promise\<string> | 返回值为Promise对象,Promise中包含指定uid的包名。 |
S
shuaiyutao 已提交
704 705 706 707

**示例:**

```js
W
wanghang 已提交
708 709 710 711 712 713 714
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 已提交
715 716
```

W
wanghang 已提交
717
## bundle.getNameForUid
S
shuaiyutao 已提交
718

W
wanghang 已提交
719
getNameForUid(uid: number, callback: AsyncCallback<string>): void;
S
shuaiyutao 已提交
720

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

**参数:**

W
wanghang 已提交
725 726 727 728
| 名称       | 类型   | 必填 | 描述     |
| ---------- | ------ | ---- | -------- |
| uid | number | 是   | 要查询的uid。 |
| callback   | AsyncCallback\<string> | 是   | 程序启动作为入参的回调函数,返回指定uid的包名。 |
S
shuaiyutao 已提交
729 730 731 732

**示例:**

```js
W
wanghang 已提交
733 734 735 736 737 738 739 740
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 已提交
741 742
```

W
wanghang 已提交
743

S
shuaiyutao 已提交
744 745 746 747 748 749 750 751 752 753 754 755 756 757
## ElementName

| 名称        | 读写属性 | 类型   | 必填 | 描述                                                         |
| ----------- | -------- | ------ | ---- | ------------------------------------------------------------ |
| deviceId    | 只读     | string | 否   | 表示运行指定Ability的设备ID。                                |
| bundleName  | 只读     | string | 是   | 表示包描述。如果在Want中同时指定了BundleName和AbilityName,则Want可以直接匹配到指定的Ability。 |
| abilityName | 只读     | string | 是   | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName,则Want可以直接匹配到指定的Ability。 |

## InstallStatus

| 名称          | 读写属性 | 类型             | 必填 | 描述                                                         |
| ------------- | -------- | ---------------- | ---- | ------------------------------------------------------------ |
| status        | 只读     | InstallErrorCode | 是   | 安装结果code<br/>SUCCESS = 0<br/>STATUS_INSTALL_FAILURE = 1<br/>STATUS_INSTALL_FAILURE_ABORTED = 2,<br/>STATUS_INSTALL_FAILURE_INVALID = 3<br/>STATUS_INSTALL_FAILURE_CONFLICT = 4<br/>STATUS_INSTALL_FAILURE_STORAGE = 5<br/>STATUS_INSTALL_FAILURE_INCOMPATIBLE = 6<br/>STATUS_INSTALL_FAILURE_DOWNLOAD_TIMEOUT = 0x0B<br/>STATUS_INSTALL_FAILURE_DOWNLOAD_FAILED = 0x0C<br/>STATUS_ABILITY_NOT_FOUND = 0x40<br/>STATUS_BMS_SERVICE_ERROR = 0x41 |
| statusMessage | 只读     | string           | 是   | 安装结果Message                                              |
W
wanghang 已提交
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 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962

## BundleFlag

包的标志

| 名称               | 默认值 | 说明   |
| ------ | ------ | ------ |
| 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 | 0x00000020 | 获取ability的元数据信息 |
| GET_APPLICATION_INFO_WITH_METADATA | 0x00000040 | 获取应用的元数据信息 |
| GET_ABILITY_INFO_SYSTEMAPP_ONLY | 0x00000080 | 获取仅包括系统应用的ability信息 |
| GET_ABILITY_INFO_WITH_DISABLE | 0x00000100 | 获取包括被禁用的ability信息 |
| GET_APPLICATION_INFO_WITH_DISABLE | 0x00000200 | 获取包括被禁用的应用信息 |

## BundleOptions

包的选项

| 名称               | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ |
| userId | number | 是 | 是 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 |
| networkId | string | 是 | 是 | 网络Id,默认值:null。 |

## BundleInfo

应用包的信息。

| 名称               | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ |
| name                     | string                     | 是   | 否   | 应用包的名称                               |
| type                     | string                     | 是   | 否   | 应用包类型                                 |
| appId                    | string                     | 是   | 否   | 应用包里应用程序的id                       |
| uid                      | number                     | 是   | 否   | 应用包里应用程序的uid                      |
| installTime              | number                     | 是   | 否   | HAP包安装时间                              |
| updateTime               | number                     | 是   | 否   | HAP包更新时间                              |
| appInfo                  | ApplicationInfo        | 是   | 否   | 应用程序的配置信息                         |
| abilityInfo              | Array<AbilityInfo>         | 是   | 否   | Ability的配置信息                          |
| reqPermissions           | Array<string>              | 是   | 否   | 应用运行时需向系统申请的权限集合           |
| reqPermissionDetails     | Array<ReqPermissionDetail> | 是   | 否   | 应用运行时需向系统申请的权限集合的详细信息 |
| vendor                   | string                     | 是   | 否   | 应用包的供应商                             |
| versionCode              | number                     | 是   | 否   | 应用包的版本号                             |
| versionName              | string                     | 是   | 否   | 应用包的版本文本描述信息                   |
| compatibleVersion        | number                     | 是   | 否   | 运行应用包所需要最低的SDK版本号            |
| targetVersion            | number                     | 是   | 否   | 运行应用包所需要最高SDK版本号              |
| isCompressNativeLibs     | boolean                    | 是   | 否   | 是否压缩应用包的本地库,默认为true         |
| hapModuleInfo            | Array<HapModuleInfo>       | 是   | 否   | 模块的配置信息                             |
| entryModuleName          | string                     | 是   | 否   | Entry的模块名称                            |
| cpuAbi                   | string                     | 是   | 否   | 应用包的cpuAbi信息                         |
| isSilentInstallation     | string                     | 是   | 否   | 是否通过静默安装                           |
| minCompatibleVersionCode | number                     | 是   | 否   | 分布式场景下的应用包兼容的最低版本         |
| entryInstallationFree | boolean | 是 | 否 | Entry是否支持免安装 |
| reqPermissionStates | Array<number> | 是 | 否 | 申请权限的授予状态 |

## ApplicationInfo

应用程序信息。

| 名称               | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ |
| 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        | 是   | 否   | 应用程序的文件保存路径                     |
| customizeData    | Map<string, Array<CustomizeData>> | 是   | 是   | 应用程序的自定义数据                       |
| codePath | string | 是 | 否 | 应用程序的安装目录 |
| metaData | Map<string, Array<CustomizeData>> | 是 | 否 | 应用程序的自定义元信息 |
| removable | boolean | 是 | 否 | 应用程序是否可以被移除 |
| accessTokenId | number | 是 | 否 | 应用程序的accessTokenId |
| uid | number | 是 | 否 | 应用程序的uid |

## ModuleInfo

应用程序的模块信息。

| 名称               | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ |
| moduleName      | string | 是   | 否   | 模块名称 |
| moduleSourceDir | string | 是   | 否   | 安装目录 |

## CustomizeData

自定义元数据。

| 名称  | 类型   | 可读 | 可写 | 说明             |
| ----- | ------ | ---- | ---- | ---------------- |
| name  | string | 是   | 是   | 自定义元数据名称 |
| value | string | 是   | 是   | 自定义元数据值   |
| extra | string | 是   | 是   | 自定义资源       |


## HapModuleInfo

| 名称               | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ |
| 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 | string | 是 | 否 | 入口ability信息 |

## ReqPermissionDetail

| 名称               | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ |
| name      | string    | 是   | 是   | 需要使用的权限名称   |
| reason    | string    | 是   | 是   | 描述申请权限的原因   |
| usedScene | UsedScene | 是 | 是 | 权限使用的场景和时机 |

## UsedScene

| 名称               | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ |
| abilities | Array<string> | 是   | 是   | 使用到该权限的Ability集合 |
| when      | string        | 是   | 是   | 使用该权限的时机          |


## AbilityInfo

| 名称               | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ |
| 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 | 是   | 否   | 应用程序的配置信息                        |
| formEntity         | number                                                       | 是   | 否   | 显示表单的位置                            |
| minFormHeight      | number                                                       | 是   | 否   | Ability的最小高度                         |
| defaultFormHeight  | number                                                       | 是   | 否   | Ability的默认高度                         |
| minFormWidth       | number                                                       | 是   | 否   | Ability的最小宽度                         |
| defaultFormWidth   | number                                                       | 是   | 否   | Ability的默认宽度                         |
| uri                | string                                                       | 是   | 否   | 获取Ability的统一资源标识符(URI)        |
| customizeData      | Map<string, Array<CustomizeData>> | 是   | 是   | Ability的自定义数据                       |
| labelId            | number                                                       | 是   | 否   | Ability的标签id                           |
| subType            | AbilitySubType | 是   | 否   | Ability中枚举使用的模板的子类型           |
| metaData | Array<Metadata> | 是 | 否 | ability的自定义元信息 |
| enabled | boolean | 是 | 否 | ability是否可用 |

## AbilityType

| 名称    | 类型 | 说明                        |
| ------- | ---- | --------------------------- |
| UNKNOWN | 无   | 未知Ability类型             |
| PAGE    | 无   | Ability有一个UI界面         |
| SERVICE | 无   | Ability没有UI界面           |
| DATA    | 无   | Ability用于提供数据访问服务 |

## DisplayOrientation

| 名称          | 类型 | 说明                     |
| ------------- | ---- | ------------------------ |
| UNSPECIFIED   | 无   | 屏幕方向--不指定         |
| LANDSCAPE     | 无   | 屏幕方向--横屏           |
| PORTRAIT      | 无   | 屏幕方向--竖屏           |
| FOLLOW_RECENT | 无   | 屏幕方向--紧跟上一个组件 |

## LaunchMode

| 名称        | 类型 | 说明                |
| ----------- | ---- | ------------------- |
| UNSPECIFIED | 0    | Ability只有一个示例 |
| STANDARD    | 1    | Ability有多个示例   |