js-apis-bundleMonitor.md 3.8 KB
Newer Older
W
wanghang 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
# Bundle.bundleMonitor模块(JS端sdk接口)

本模块提供监听应用安装,卸载,更新的能力。

> **说明:** 
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

## 导入模块

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

## 权限列表

| 权限                                 | 权限等级    | 描述                           |
| ------------------------------------ | ----------- | ------------------------------ |
| ohos.permission.LISTEN_BUNDLE_CHANGE | system_core | 可监听应用的安装,卸载,更新。 |

权限等级参考[权限等级说明]([zh-cn/application-dev/security/accesstoken-overview.md · OpenHarmony/docs - Gitee.com](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/security/accesstoken-overview.md))

## BundleChangeInfo

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

J
junyi233 已提交
27
**系统API:**  此接口为系统接口,三方应用不支持调用
W
wanghang 已提交
28 29 30 31 32 33 34 35 36 37 38 39 40 41

| 名称       | 类型   | 可读 | 可写 | 说明                       |
| ---------- | ------ | ---- | ---- | -------------------------- |
| bundleName | string | 是   | 否   | 应用状态发生变化的应用包名 |
| userId     | number | 是   | 否   | 应用状态发生变化的用户id   |

## bundleMonitor.on

on(type: BundleChangedEvent, callback: Callback\<BundleChangedInfo>): void;

注册监听应用的安装,卸载,更新。

**需要权限:**ohos.permission.LISTEN_BUNDLE_CHANGE

J
junyi233 已提交
42
**系统API:**  此接口为系统接口,三方应用不支持调用
W
wanghang 已提交
43 44 45 46 47

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

**参数:**

J
junyi233 已提交
48
| 参数名                       | 类型     | 必填 | 说明               |
W
wanghang 已提交
49 50 51 52 53 54
| ---------------------------- | -------- | ---- | ------------------ |
| BundleChangedEvent           | string   | 是   | 注册监听的事件类型 |
| Callback\<BundleChangedInfo> | callback | 是   | 注册监听的回调函数 |

**相关错误码**

J
junyi233 已提交
55 56 57 58
| 错误码ID | 错误信息                    |
| -------- | --------------------------- |
| 201      | Permission denied.          |
| 401      | The parameter check failed. |
W
wanghang 已提交
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81

**示例:**

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

try {
    bundleMonitor.on('add', (bundleChangeInfo) => {
        console.info(`bundleName : ${bundleChangeInfo.bundleName} userId : ${bundleChangeInfo.userId}`);
	})
} catch (errData) {
    console.log(`errData is errCode:${errData.errCode}  message:${errData.message}`);
}
```

## bundleMonitor.off

off(type: BundleChangedEvent, callback?: Callback\<BundleChangedInfo>): void;

注销监听应用的安装,卸载,更新。

**需要权限:**ohos.permission.LISTEN_BUNDLE_CHANGE

J
junyi233 已提交
82
**系统API:**  此接口为系统接口,三方应用不支持调用
W
wanghang 已提交
83 84 85 86 87

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

**参数:**

J
junyi233 已提交
88
| 参数名                       | 类型     | 必填 | 说明                                                       |
W
wanghang 已提交
89 90 91 92 93 94
| ---------------------------- | -------- | ---- | ---------------------------------------------------------- |
| BundleChangedEvent           | string   | 是   | 注销监听的事件类型                                         |
| Callback\<BundleChangedInfo> | callback | 否   | 注销监听的回调函数,当为空时表示注销当前事件的所有callback |

**相关错误码**

J
junyi233 已提交
95 96 97 98
| 错误码ID | 错误信息                    |
| -------- | --------------------------- |
| 201      | Permission denied.          |
| 401      | The parameter check failed. |
W
wanghang 已提交
99 100 101 102 103 104 105 106 107 108 109 110 111

**示例:**

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

try {
    bundleMonitor.off('add');
} catch (errData) {
    console.log(`errData is errCode:${errData.errCode}  message:${errData.message}`);
}
```