js-apis-commonEvent.md 49.7 KB
Newer Older
X
xuchenghua09 已提交
1 2
# 公共事件模块

Z
zengyawen 已提交
3 4
> **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
X
xuchenghua09 已提交
5 6 7

## 权限列表

Z
zengyawen 已提交
8 9
| 系统公共事件宏      | 系统公共事件名称          | 订阅者所需权限     |
| ------------ | ------------------ | ---------------------- |
X
xuchenghua09 已提交
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
| COMMON_EVENT_BOOT_COMPLETED                                  | usual.event.BOOT_COMPLETED                                  | ohos.permission.RECEIVER_STARTUP_COMPLETED                   |
| COMMON_EVENT_SHUTDOWN                                        | usual.event.SHUTDOWN                                        | 无                                                           |
| COMMON_EVENT_BATTERY_CHANGED                                 | usual.event.BATTERY_CHANGED                                 | 无                                                           |
| COMMON_EVENT_BATTERY_LOW                                     | usual.event.BATTERY_LOW                                     | 无                                                           |
| COMMON_EVENT_BATTERY_OKAY                                    | usual.event.BATTERY_OKAY                                    | 无                                                           |
| COMMON_EVENT_POWER_CONNECTED                                 | usual.event.POWER_CONNECTED                                 | 无                                                           |
| COMMON_EVENT_POWER_DISCONNECTED                              | usual.event.POWER_DISCONNECTED                              | 无                                                           |
| COMMON_EVENT_SCREEN_OFF                                      | usual.event.SCREEN_OFF                                      | 无                                                           |
| COMMON_EVENT_SCREEN_ON                                       | usual.event.SCREEN_ON                                       | 无                                                           |
| COMMON_EVENT_USER_PRESENT                                    | usual.event.USER_PRESENT                                    | 无                                                           |
| COMMON_EVENT_TIME_TICK                                       | usual.event.TIME_TICK                                       | 无                                                           |
| COMMON_EVENT_TIME_CHANGED                                    | usual.event.TIME_CHANGED                                    | 无                                                           |
| COMMON_EVENT_DATE_CHANGED                                    | usual.event.DATE_CHANGED                                    | 无                                                           |
| COMMON_EVENT_TIMEZONE_CHANGED                                | usual.event.TIMEZONE_CHANGED                                | 无                                                           |
| COMMON_EVENT_CLOSE_SYSTEM_DIALOGS                            | usual.event.CLOSE_SYSTEM_DIALOGS                            | 无                                                           |
| COMMON_EVENT_PACKAGE_ADDED                                   | usual.event.PACKAGE_ADDED                                   | 无                                                           |
| COMMON_EVENT_PACKAGE_REPLACED                                | usual.event.PACKAGE_REPLACED                                | 无                                                           |
| COMMON_EVENT_MY_PACKAGE_REPLACED                             | usual.event.MY_PACKAGE_REPLACED                             | 无                                                           |
| COMMON_EVENT_PACKAGE_REMOVED                                 | usual.event.PACKAGE_REMOVED                                 | 无                                                           |
| COMMON_EVENT_PACKAGE_FULLY_REMOVED                           | usual.event.PACKAGE_FULLY_REMOVED                           | 无                                                           |
| COMMON_EVENT_PACKAGE_CHANGED                                 | usual.event.PACKAGE_CHANGED                                 | 无                                                           |
| COMMON_EVENT_PACKAGE_RESTARTED                               | usual.event.PACKAGE_RESTARTED                               | 无                                                           |
| COMMON_EVENT_PACKAGE_DATA_CLEARED                            | usual.event.PACKAGE_DATA_CLEARED                            | 无                                                           |
| COMMON_EVENT_PACKAGES_SUSPENDED                              | usual.event.PACKAGES_SUSPENDED                              | 无                                                           |
| COMMON_EVENT_PACKAGES_UNSUSPENDED                            | usual.event.PACKAGES_UNSUSPENDED                            | 无                                                           |
| COMMON_EVENT_MY_PACKAGE_SUSPENDED                            | usual.event.MY_PACKAGE_SUSPENDED                            | 无                                                           |
| COMMON_EVENT_MY_PACKAGE_UNSUSPENDED                          | usual.event.MY_PACKAGE_UNSUSPENDED                          | 无                                                           |
| COMMON_EVENT_UID_REMOVED                                     | usual.event.UID_REMOVED                                     | 无                                                           |
| COMMON_EVENT_PACKAGE_FIRST_LAUNCH                            | usual.event.PACKAGE_FIRST_LAUNCH                            | 无                                                           |
| COMMON_EVENT_PACKAGE_NEEDS_VERIFICATION                      | usual.event.PACKAGE_NEEDS_VERIFICATION                      | 无                                                           |
| COMMON_EVENT_PACKAGE_VERIFIED                                | usual.event.PACKAGE_VERIFIED                                | 无                                                           |
| COMMON_EVENT_EXTERNAL_APPLICATIONS_AVAILABLE                 | usual.event.EXTERNAL_APPLICATIONS_AVAILABLE                 | 无                                                           |
| COMMON_EVENT_EXTERNAL_APPLICATIONS_UNAVAILABLE               | usual.event.EXTERNAL_APPLICATIONS_UNAVAILABLE               | 无                                                           |
| COMMON_EVENT_CONFIGURATION_CHANGED                           | usual.event.CONFIGURATION_CHANGED                           | 无                                                           |
| COMMON_EVENT_LOCALE_CHANGED                                  | usual.event.LOCALE_CHANGED                                  | 无                                                           |
| COMMON_EVENT_MANAGE_PACKAGE_STORAGE                          | usual.event.MANAGE_PACKAGE_STORAGE                          | 无                                                           |
| COMMON_EVENT_DRIVE_MODE                                      | common.event.DRIVE_MODE                                     | 无                                                           |
| COMMON_EVENT_HOME_MODE                                       | common.event.HOME_MODE                                      | 无                                                           |
| COMMON_EVENT_OFFICE_MODE                                     | common.event.OFFICE_MODE                                    | 无                                                           |
| COMMON_EVENT_USER_STARTED                                    | usual.event.USER_STARTED                                    | 无                                                           |
| COMMON_EVENT_USER_BACKGROUND                                 | usual.event.USER_BACKGROUND                                 | 无                                                           |
| COMMON_EVENT_USER_FOREGROUND                                 | usual.event.USER_FOREGROUND                                 | 无                                                           |
| COMMON_EVENT_USER_SWITCHED                                   | usual.event.USER_SWITCHED                                   | ohos.permission.MANAGE_USERS                                 |
| COMMON_EVENT_USER_UNLOCKED                                   | usual.event.USER_UNLOCKED                                   | 无                                                           |
| COMMON_EVENT_USER_STOPPED                                    | usual.event.USER_STOPPED                                    | 无                                                           |
| COMMON_EVENT_HWID_LOGIN                                      | common.event.HWID_LOGIN                                     | 无                                                           |
| COMMON_EVENT_HWID_LOGOUT                                     | common.event.HWID_LOGOUT                                    | 无                                                           |
| COMMON_EVENT_HWID_TOKEN_INVALID                              | common.event.HWID_TOKEN_INVALID                             | 无                                                           |
| COMMON_EVENT_HWID_LOGOFF                                     | common.event.HWID_LOGOFF                                    | 无                                                           |
| COMMON_EVENT_WIFI_POWER_STATE                                | usual.event.wifi.POWER_STATE                                | 无                                                           |
| COMMON_EVENT_WIFI_SCAN_FINISHED                              | usual.event.wifi.SCAN_FINISHED                              | ohos.permission.LOCATION                                     |
| COMMON_EVENT_WIFI_RSSI_VALUE                                 | usual.event.wifi.RSSI_VALUE                                 | ohos.permission.GET_WIFI_INFO                                |
| COMMON_EVENT_WIFI_CONN_STATE                                 | usual.event.wifi.CONN_STATE                                 | 无                                                           |
| COMMON_EVENT_WIFI_HOTSPOT_STATE                              | usual.event.wifi.HOTSPOT_STATE                              | 无                                                           |
| COMMON_EVENT_WIFI_AP_STA_JOIN                                | usual.event.wifi.WIFI_HS_STA_JOIN                           | ohos.permission.GET_WIFI_INFO                                |
| COMMON_EVENT_WIFI_AP_STA_LEAVE                               | usual.event.wifi.WIFI_HS_STA_LEAVE                          | ohos.permission.GET_WIFI_INFO                                |
| COMMON_EVENT_WIFI_P2P_CONN_STATE                             | usual.event.wifi.p2p.CONN_STATE_CHANGE                      | ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION   |
| COMMON_EVENT_WIFI_P2P_STATE_CHANGED                          | usual.event.wifi.p2p.STATE_CHANGE                           | ohos.permission.GET_WIFI_INFO                                |
| COMMON_EVENT_WIFI_P2P_PEERS_STATE_CHANGED                    | usual.event.wifi.p2p.DEVICES_CHANGE                         | ohos.permission.GET_WIFI_INFO                                |
| COMMON_EVENT_WIFI_P2P_PEERS_DISCOVERY_STATE_CHANGED          | usual.event.wifi.p2p.PEER_DISCOVERY_STATE_CHANGE            | ohos.permission.GET_WIFI_INFO                                |
| COMMON_EVENT_WIFI_P2P_CURRENT_DEVICE_STATE_CHANGED           | usual.event.wifi.p2p.CURRENT_DEVICE_CHANGE                  | ohos.permission.GET_WIFI_INFO                                |
| COMMON_EVENT_WIFI_P2P_GROUP_STATE_CHANGED                    | usual.event.wifi.p2p.GROUP_STATE_CHANGED                    | ohos.permission.GET_WIFI_INFO                                |
| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_AVRCP_CONNECT_STATE_UPDATE | usual.event.bluetooth.a2dpsource.AVRCP_CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_SDP_RESULT               | usual.event.bluetooth.remotedevice.SDP_RESULT               | 无                                                           |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIRING_CANCEL           | usual.event.bluetooth.remotedevice.PAIRING_CANCEL           | 无                                                           |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_REQ              | usual.event.bluetooth.remotedevice.CONNECT_REQ              | 无                                                           |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_REPLY            | usual.event.bluetooth.remotedevice.CONNECT_REPLY            | 无                                                           |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_CANCEL           | usual.event.bluetooth.remotedevice.CONNECT_CANCEL           | 无                                                           |
| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_CONNECT_STATE_UPDATE    | usual.event.bluetooth.handsfreeunit.CONNECT_STATE_UPDATE    | 无                                                           |
| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AUDIO_STATE_UPDATE      | usual.event.bluetooth.handsfreeunit.AUDIO_STATE_UPDATE      | 无                                                           |
| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AG_COMMON_EVENT         | usual.event.bluetooth.handsfreeunit.AG_COMMON_EVENT         | 无                                                           |
| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AG_CALL_STATE_UPDATE    | usual.event.bluetooth.handsfreeunit.AG_CALL_STATE_UPDATE    | 无                                                           |
| COMMON_EVENT_BLUETOOTH_HOST_REQ_DISCOVERABLE                 | usual.event.bluetooth.host.REQ_DISCOVERABLE                 | 无                                                           |
| COMMON_EVENT_NFC_ACTION_ADAPTER_STATE_CHANGED                | usual.event.nfc.action.ADAPTER_STATE_CHANGED                | 无                                                           |
| COMMON_EVENT_DISCHARGING                                     | usual.event.DISCHARGING                                     | 无                                                           |
| COMMON_EVENT_CHARGING                                        | usual.event.CHARGING                                        | 无                                                           |
| COMMON_EVENT_DEVICE_IDLE_MODE_CHANGED                        | usual.event.DEVICE_IDLE_MODE_CHANGED                        | 无                                                           |
| COMMON_EVENT_POWER_SAVE_MODE_CHANGED                         | usual.event.POWER_SAVE_MODE_CHANGED                         | 无                                                           |
| COMMON_EVENT_USER_ADDED                                      | usual.event.USER_ADDED                                      | ohos.permission.MANAGE_USERS                                 |
| COMMON_EVENT_USER_REMOVED                                    | usual.event.USER_REMOVED                                    | ohos.permission.MANAGE_USERS                                 |
| COMMON_EVENT_LOCATION_MODE_STATE_CHANGED                     | usual.event.location.MODE_STATE_CHANGED                     | 无                                                           |
| COMMON_EVENT_IVI_SLEEP                                       | common.event.IVI_SLEEP                                      | 无                                                           |
| COMMON_EVENT_IVI_PAUSE                                       | common.event.IVI_PAUSE                                      | 无                                                           |
| COMMON_EVENT_IVI_STANDBY                                     | common.event.IVI_STANDBY                                    | 无                                                           |
| COMMON_EVENT_IVI_LASTMODE_SAVE                               | common.event.IVI_LASTMODE_SAVE                              | 无                                                           |
| COMMON_EVENT_IVI_VOLTAGE_ABNORMAL                            | common.event.IVI_VOLTAGE_ABNORMAL                           | 无                                                           |
| COMMON_EVENT_IVI_HIGH_TEMPERATURE                            | common.event.IVI_HIGH_TEMPERATURE                           | 无                                                           |
| COMMON_EVENT_IVI_EXTREME_TEMPERATURE                         | common.event.IVI_EXTREME_TEMPERATURE                        | 无                                                           |
| COMMON_EVENT_IVI_TEMPERATURE_ABNORMAL                        | common.event.IVI_TEMPERATURE_ABNORMAL                       | 无                                                           |
| COMMON_EVENT_IVI_VOLTAGE_RECOVERY                            | common.event.IVI_VOLTAGE_RECOVERY                           | 无                                                           |
| COMMON_EVENT_IVI_TEMPERATURE_RECOVERY                        | common.event.IVI_TEMPERATURE_RECOVERY                       | 无                                                           |
| COMMON_EVENT_IVI_ACTIVE                                      | common.event.IVI_ACTIVE                                     | 无                                                           |
| COMMON_EVENT_USB_DEVICE_ATTACHED                             | usual.event.hardware.usb.action.USB_DEVICE_ATTACHED         | 无                                                           |
| COMMON_EVENT_USB_DEVICE_DETACHED                             | usual.event.hardware.usb.action.USB_DEVICE_DETACHED         | 无                                                           |
| COMMON_EVENT_USB_ACCESSORY_ATTACHED                          | usual.event.hardware.usb.action.USB_ACCESSORY_ATTACHED      | 无                                                           |
| COMMON_EVENT_USB_ACCESSORY_DETACHED                          | usual.event.hardware.usb.action.USB_ACCESSORY_DETACHED      | 无                                                           |
Z
zengyawen 已提交
106 107 108 109 110
| COMMON_EVENT_DISK_REMOVED                                    | usual.event.data.DISK_REMOVED                               | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_DISK_UNMOUNTED                                  | usual.event.data.DISK_UNMOUNTED                             | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_DISK_MOUNTED                                    | usual.event.data.DISK_MOUNTED                               | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_DISK_BAD_REMOVAL                                | usual.event.data.DISK_BAD_REMOVAL                           | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_DISK_EJECT                                      | usual.event.data.DISK_EJECT                                 | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE |
X
xuchenghua09 已提交
111 112 113 114 115
| COMMON_EVENT_AIRPLANE_MODE_CHANGED                           | usual.event.AIRPLANE_MODE                                   | 无                                                           |

## 导入模块

```js
Z
zengsiyu 已提交
116
import CommonEvent from '@ohos.commonEvent';
X
xuchenghua09 已提交
117 118
```

Z
zero-cyc 已提交
119
## 系统能力
X
xuchenghua09 已提交
120

Z
zero-cyc 已提交
121 122 123
```js
SystemCapability.Notification.CommonEvent
```
X
xuchenghua09 已提交
124

Z
zengyawen 已提交
125
## CommonEvent.publish
X
xuchenghua09 已提交
126

Z
zengyawen 已提交
127
publish(event: string, callback: AsyncCallback\<void>): void
X
xuchenghua09 已提交
128

Z
zengyawen 已提交
129
发布公共事件(callback形式)。
X
xuchenghua09 已提交
130

Z
zengyawen 已提交
131
**参数:**
X
xuchenghua09 已提交
132

Z
zengyawen 已提交
133 134 135 136
| 名称     | 读写属性 | 类型                 | 必填 | 描述                   |
| -------- | -------- | -------------------- | ---- | ---------------------- |
| event    | 只读     | string               | 是   | 表示要发送的公共事件。 |
| callback | 只读     | AsyncCallback\<void> | 是   | 表示被指定的回调方法。 |
X
xuchenghua09 已提交
137

Z
zengyawen 已提交
138
**示例:**
X
xuchenghua09 已提交
139 140 141 142 143 144 145 146 147 148 149 150 151

```js
//发布公共事件回调
function PublishCallBack(err) {
	console.info("==========================>PublishCallBack=======================>");
    console.info("==========================>err:=======================>", err.code);
}
//发布公共事件
CommonEvent.publish("publish_event", PublishCallBack);
```



Z
zengyawen 已提交
152
## CommonEvent.publish
X
xuchenghua09 已提交
153

Z
zengyawen 已提交
154
publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\<void>): void
X
xuchenghua09 已提交
155

Z
zengyawen 已提交
156
发布公共事件指定发布信息(callback形式)。
X
xuchenghua09 已提交
157

Z
zengyawen 已提交
158
**参数:**
X
xuchenghua09 已提交
159

Z
zengyawen 已提交
160 161 162 163 164
| 名称     | 读写属性 | 类型                   | 必填 | 描述                   |
| -------- | -------- | ---------------------- | ---- | ---------------------- |
| event    | 只读     | string                 | 是   | 表示要发布的公共事件。  |
| options  | 只读     | [CommonEventPublishData](#commoneventpublishdata) | 是   | 表示发布公共事件的属性。 |
| callback | 只读     | AsyncCallback\<void>   | 是   | 表示被指定的回调方法。  |
X
xuchenghua09 已提交
165

Z
zengyawen 已提交
166
**示例:**
X
xuchenghua09 已提交
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185


```js
//公共事件相关信息
var options = {
	code: 0;			 //公共事件的初始代码
	data: "initial data";//公共事件的初始数据
	isOrdered: true;	 //有序公共事件
}
//发布公共事件回调
function PublishCallBack(err) {
	console.info("==========================>PublishCallBack=======================>");
}
//发布公共事件
CommonEvent.publish("publish_event", options, PublishCallBack);
```



Z
zengsiyu 已提交
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
## CommonEvent.publishAsUser

publishAsUser(event: string, userId: number, callback: AsyncCallback\<void>): void

向指定用户发布公共事件(callback形式)。

**参数:**

| 名称     | 读写属性 | 类型                 | 必填 | 描述                               |
| -------- | -------- | -------------------- | ---- | ---------------------------------- |
| event    | 只读     | string               | 是   | 表示要发送的公共事件。             |
| userId   | 只读     | number               | 是   | 表示指定向该用户ID发送此公共事件。 |
| callback | 只读     | AsyncCallback\<void> | 是   | 表示被指定的回调方法。             |

**示例:**

```js
//发布公共事件回调
function PublishAsUserCallBack(err) {
	if (err.code) {
        console.info("publishAsUser failed " + JSON.stringify(err));
    } else {
        console.info("publishAsUser");
    }
}
//指定发送的用户
var userId = 100;
//发布公共事件
CommonEvent.publish("publish_event", userId, PublishAsUserCallBack);
```



## CommonEvent.publishAsUser

publishAsUser(event: string, userId: number, options: CommonEventPublishData, callback: AsyncCallback\<void>): void

向指定用户发布公共事件并指定发布信息(callback形式)。

**参数:**

| 名称     | 读写属性 | 类型                   | 必填 | 描述                   |
| -------- | -------- | ---------------------- | ---- | ---------------------- |
| event    | 只读     | string                 | 是   | 表示要发布的公共事件。  |
| userId | 只读 | number | 是 | 表示指定向该用户ID发送此公共事件。 |
| options  | 只读     | [CommonEventPublishData](#commoneventpublishdata) | 是   | 表示发布公共事件的属性。 |
| callback | 只读     | AsyncCallback\<void>   | 是   | 表示被指定的回调方法。  |

**示例:**


```js
//公共事件相关信息
var options = {
	code: 0;			 //公共事件的初始代码
	data: "initial data";//公共事件的初始数据
}
//发布公共事件回调
function PublishAsUserCallBack(err) {
	if (err.code) {
        console.info("publishAsUser failed " + JSON.stringify(err));
    } else {
        console.info("publishAsUser");
    }
}
//指定发送的用户
var userId = 100;
//发布公共事件
CommonEvent.publish("publish_event", userId, options, PublishAsUserCallBack);
```



Z
zengyawen 已提交
259
## CommonEvent.createSubscriber
X
xuchenghua09 已提交
260

Z
zengyawen 已提交
261
createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback\<CommonEventSubscriber>): void
X
xuchenghua09 已提交
262

Z
zengyawen 已提交
263
创建订阅者(callback形式)。
X
xuchenghua09 已提交
264

Z
zengyawen 已提交
265
**参数:**
X
xuchenghua09 已提交
266

Z
zengyawen 已提交
267 268 269 270
| 名称          | 读写属性 | 类型                                                         | 必填 | 描述                       |
| ------------- | -------- | ------------------------------------------------------------ | ---- | -------------------------- |
| subscribeInfo | 只读     | [CommonEventSubscribeInfo](#commoneventsubscribeinfo)        | 是   | 表示订阅信息。             |
| callback      | 只读     | AsyncCallback\<[CommonEventSubscriber](#commoneventsubscriber)> | 是   | 表示创建订阅者的回调方法。 |
X
xuchenghua09 已提交
271

Z
zengyawen 已提交
272
**示例:**
X
xuchenghua09 已提交
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291


```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//订阅者信息
var subscribeInfo = {
	events: ["event"]
};
//创建订阅者回调
function CreateSubscriberCallBack(err, data) {
    console.info("==========================>CreateSubscriberCallBack=======================>");
    subscriber = data;
}
//创建订阅者
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
```



Z
zengyawen 已提交
292
## CommonEvent.createSubscriber
X
xuchenghua09 已提交
293

Z
zengyawen 已提交
294
createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise\<CommonEventSubscriber>
X
xuchenghua09 已提交
295

Z
zengyawen 已提交
296
创建订阅者(Promise形式)。
X
xuchenghua09 已提交
297

Z
zengyawen 已提交
298
**参数:**
X
xuchenghua09 已提交
299

Z
zengyawen 已提交
300 301 302
| 名称          | 读写属性 | 类型                                                  | 必填 | 描述           |
| ------------- | -------- | ----------------------------------------------------- | ---- | -------------- |
| subscribeInfo | 只读     | [CommonEventSubscribeInfo](#commoneventsubscribeinfo) | 是   | 表示订阅信息。 |
X
xuchenghua09 已提交
303

Z
zengyawen 已提交
304 305 306 307
**返回值:**
| 类型                                                      | 说明             |
| --------------------------------------------------------- | ---------------- |
| Promise\<[CommonEventSubscriber](#commoneventsubscriber)> | 返回订阅者对象。 |
X
xuchenghua09 已提交
308

Z
zengyawen 已提交
309
**示例:**
X
xuchenghua09 已提交
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325

```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//订阅者信息
var subscribeInfo = {
	events: ["event"]
};
//创建订阅者
CommonEvent.createSubscriber(subscribeInfo).then((data) => {
	console.info("==========================>createSubscriberPromise=======================>");
    subscriber = data;
});
```



Z
zengyawen 已提交
326
## CommonEvent.subscribe
X
xuchenghua09 已提交
327

Z
zengyawen 已提交
328
subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\<CommonEventData>): void
X
xuchenghua09 已提交
329

Z
zengyawen 已提交
330
订阅公共事件(callback形式)。
X
xuchenghua09 已提交
331

Z
zengyawen 已提交
332
**参数:**
X
xuchenghua09 已提交
333

Z
zengyawen 已提交
334 335 336 337
| 名称       | 读写属性 | 类型                                                | 必填 | 描述                             |
| ---------- | -------- | --------------------------------------------------- | ---- | -------------------------------- |
| subscriber | 只读     | [CommonEventSubscriber](#commoneventsubscriber)     | 是   | 表示订阅者对象。                 |
| callback   | 只读     | AsyncCallback\<[CommonEventData](#commoneventdata)> | 是   | 表示接收公共事件数据的回调函数。 |
X
xuchenghua09 已提交
338

Z
zengyawen 已提交
339
**示例:**
X
xuchenghua09 已提交
340

Z
zengyawen 已提交
341
无序事件:
X
xuchenghua09 已提交
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363

```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//订阅者信息
var subscribeInfo = {
    events: ["event"]
};
//订阅公共事件回调
function SubscribeCallBack(err, data) {
    console.info("==========================>SubscribeCallBack=======================>");
}
//创建订阅者回调
function CreateSubscriberCallBack(err, data) {
    console.info("==========================>CreateSubscriberCallBack=======================>");
    subscriber = data;
    //订阅公共事件
    CommonEvent.subscribe(subscriber, SubscribeCallBack);
}
//创建订阅者
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
```

Z
zengyawen 已提交
364
 有序事件:
X
xuchenghua09 已提交
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407

```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//订阅者信息
var subscribeInfo = {
    events: ["event"]
};

//设置有序公共事件的结果代码回调
function SetCodeCallBack(err) {
    console.info("==========================>SetCodeCallBack=======================>");
}
//设置有序公共事件的结果数据回调
function SetDataCallBack(err) {
    console.info("==========================>SetDataCallBack=======================>");
}
//完成本次有序公共事件处理回调
function FinishCommonEventCallBack(err) {
    console.info("==========================>FinishCommonEventCallBack=======================>");
}
//订阅公共事件回调
function SubscribeCallBack(err, data) {
    console.info("==========================>SubscribeCallBack=======================>");
    //设置有序公共事件的结果代码
    subscriber.setCode(0, SetCodeCallBack);
    //设置有序公共事件的结果数据
    subscriber.setData("publish_data_changed", SetDataCallBack);
    //完成本次有序公共事件处理
    subscriber.finishCommonEvent(FinishCommonEventCallBack)
}

//创建订阅者回调
function CreateSubscriberCallBack(err, data) {
    console.info("==========================>CreateSubscriberCallBack=======================>");
    subscriber = data;
    //订阅公共事件
    CommonEvent.subscribe(subscriber, SubscribeCallBack);
}

//创建订阅者
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
```

Z
zengyawen 已提交
408
 
X
xuchenghua09 已提交
409

Z
zengyawen 已提交
410
## CommonEvent.unsubscribe
X
xuchenghua09 已提交
411

Z
zengyawen 已提交
412
unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback\<void>): void
X
xuchenghua09 已提交
413

Z
zengyawen 已提交
414
取消订阅公共事件(callback形式)。
X
xuchenghua09 已提交
415

Z
zengyawen 已提交
416
**参数:**
X
xuchenghua09 已提交
417

Z
zengyawen 已提交
418 419 420 421
| 名称       | 读写属性 | 类型                  | 必填 | 描述                     |
| ---------- | -------- | --------------------- | ---- | ------------------------ |
| subscriber | 只读     | CommonEventSubscriber | 是   | 表示订阅者对象。         |
| callback   | 只读     | AsyncCallback\<void>  | 是   | 表示取消订阅的回调方法。 |
X
xuchenghua09 已提交
422

Z
zengyawen 已提交
423
**示例:**
X
xuchenghua09 已提交
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451

```js
var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//订阅者信息
var subscribeInfo = {
	events: ["event"]
};
//订阅公共事件回调
function SubscribeCallBack(err, data) {
	console.info("==========================>SubscribeCallBack=======================>");
}
//创建订阅者回调
function CreateSubscriberCallBack(err, data) {
	console.info("==========================>CreateSubscriberCallBack=======================>");
	subscriber = data;
	//订阅公共事件
	CommonEvent.subscribe(subscriber, SubscribeCallBack);
}
//取消订阅公共事件回调
function UnsubscribeCallBack(err) {
	console.info("==========================>UnsubscribeCallBack=======================>");
}
//创建订阅者
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
//取消订阅公共事件
CommonEvent.unsubscribe(subscriber, UnsubscribeCallBack);
```

Z
zengyawen 已提交
452
## CommonEventPublishData
X
xuchenghua09 已提交
453 454 455 456 457 458 459 460 461 462

| 名称                  | 读写属性 | 类型                 | 必填 | 描述                         |
| --------------------- | -------- | -------------------- | ---- | ---------------------------- |
| bundleName            | 只读     | string               | 否   | 表示包名称                   |
| code                  | 只读     | number               | 否   | 表示公共事件的结果代码       |
| data                  | 只读     | string               | 否   | 表示公共事件的自定义结果数据 |
| subscriberPermissions | 只读     | Array\<string>       | 否   | 表示订阅者的权限             |
| isOrdered             | 只读     | boolean              | 否   | 表示是否是有序事件           |
| parameters            | 只读     | {[key: string]: any} | 否   | 表示公共事件的附加信息       |

Z
zengyawen 已提交
463
## CommonEventSubscribeInfo
X
xuchenghua09 已提交
464 465 466 467 468 469 470 471 472

| 名称                | 读写属性 | 类型           | 必填 | 描述                                                         |
| ------------------- | -------- | -------------- | ---- | ------------------------------------------------------------ |
| events              | 只读     | Array\<string> | 是   | 表示要发送的公共事件                                         |
| publisherPermission | 只读     | string         | 否   | 表示发布者的权限                                             |
| publisherDeviceId   | 只读     | string         | 否   | 表示设备ID,该值必须是同一ohos网络上的现有设备ID             |
| userId              | 只读     | number         | 否   | 表示用户ID。此参数是可选的,默认值当前用户的ID。如果指定了此参数,则该值必须是系统中现有的用户ID。 |
| priority            | 只读     | number         | 否   | 表示订阅者的优先级。值的范围是-100到1000                     |

Z
zengyawen 已提交
473
## CommonEventData
X
xuchenghua09 已提交
474 475 476 477 478 479 480 481 482

| 名称       | 读写属性 | 类型                 | 必填 | 描述                                                   |
| ---------- | -------- | -------------------- | ---- | ------------------------------------------------------ |
| event      | 只读     | string               | 是   | 表示当前接收的公共事件名称                             |
| bundleName | 只读     | string               | 否   | 表示包名称                                             |
| code       | 只读     | number               | 否   | 表示公共事件的结果代码,用于传递int类型的数据          |
| data       | 只读     | string               | 否   | 表示公共事件的自定义结果数据,用于传递string类型的数据 |
| parameters | 只读     | {[key: string]: any} | 否   | 表示公共事件的附加信息                                 |

Z
zengyawen 已提交
483
## CommonEventSubscriber
X
xuchenghua09 已提交
484

Z
zengyawen 已提交
485
### getCode
X
xuchenghua09 已提交
486

Z
zengyawen 已提交
487
getCode(callback: AsyncCallback\<number>): void
X
xuchenghua09 已提交
488

Z
zengyawen 已提交
489
获取公共事件的结果代码(callback形式)。
X
xuchenghua09 已提交
490

Z
zengyawen 已提交
491
**参数:**
X
xuchenghua09 已提交
492

Z
zengyawen 已提交
493 494 495
| 参数名   | 类型                   | 必填 | 描述               |
| -------- | ---------------------- | ---- | ------------------ |
| callback | AsyncCallback\<number> | 是   | 公共事件的结果代码 |
X
xuchenghua09 已提交
496

Z
zengyawen 已提交
497
**示例:**
X
xuchenghua09 已提交
498

Z
zengyawen 已提交
499 500 501 502 503 504 505 506 507 508
```js
var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function getCodeCallback(err, data) {
    console.info("==========================>getCodeCallback=======================>");
    console.info("==========================>err:=======================>", err.code);
    console.info("==========================>code:=======================>", data);
}
subscriber.getCode(getCodeCallback);
```
X
xuchenghua09 已提交
509

Z
zengyawen 已提交
510
### getCode
X
xuchenghua09 已提交
511

Z
zengyawen 已提交
512
getCode(): Promise\<number>
X
xuchenghua09 已提交
513

Z
zengyawen 已提交
514
获取公共事件的结果代码(Promise形式)。
X
xuchenghua09 已提交
515

Z
zengyawen 已提交
516
**返回值:**
X
xuchenghua09 已提交
517

Z
zengyawen 已提交
518 519 520
| 类型             | 说明                 |
| ---------------- | -------------------- |
| Promise\<number> | 公共事件的结果代码。 |
X
xuchenghua09 已提交
521

Z
zengyawen 已提交
522
**示例:**
X
xuchenghua09 已提交
523

Z
zengyawen 已提交
524 525 526 527 528 529 530
```js
var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.getCode().then((data) => {
	console.info("==========================>getCodePromise=======================>");
    console.info("==========================>code:=======================>", data);
});
```
X
xuchenghua09 已提交
531

Z
zengyawen 已提交
532
### setCode
X
xuchenghua09 已提交
533

Z
zengyawen 已提交
534
setCode(code: number, callback: AsyncCallback\<void>): void
X
xuchenghua09 已提交
535

Z
zengyawen 已提交
536
设置公共事件的结果代码(callback形式)。
X
xuchenghua09 已提交
537

Z
zengyawen 已提交
538
**参数:**
X
xuchenghua09 已提交
539

Z
zengyawen 已提交
540 541 542 543
| 参数名   | 类型                 | 必填 | 描述                   |
| -------- | -------------------- | ---- | ---------------------- |
| code     | number               | 是   | 公共事件的结果代码。   |
| callback | AsyncCallback\<void> | 是   | 表示被指定的回调方法。 |
X
xuchenghua09 已提交
544

Z
zengyawen 已提交
545
**示例:**
X
xuchenghua09 已提交
546

Z
zengyawen 已提交
547 548 549 550 551 552 553 554 555
```js
var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function setCodeCallback(err) {
    console.info("==========================>setCodeCallback=======================>");
    console.info("==========================>err:=======================>", err.code);
}
subscriber.setCode(1, setCodeCallback);
```
X
xuchenghua09 已提交
556

Z
zengyawen 已提交
557
### setCode
X
xuchenghua09 已提交
558

Z
zengyawen 已提交
559
setCode(code: number): Promise\<void>
X
xuchenghua09 已提交
560

Z
zengyawen 已提交
561
设置公共事件的结果代码(Promise形式)。
X
xuchenghua09 已提交
562

Z
zengyawen 已提交
563
**参数:**
X
xuchenghua09 已提交
564

Z
zengyawen 已提交
565 566 567
| 参数名 | 类型   | 必填 | 描述               |
| ------ | ------ | ---- | ------------------ |
| code   | number | 是   | 公共事件的结果代码 |
X
xuchenghua09 已提交
568

Z
zengyawen 已提交
569
**示例:**
X
xuchenghua09 已提交
570

Z
zengyawen 已提交
571 572 573 574 575 576
```js
var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.setCode(1).then(() => {
	console.info("==========================>setCodePromise=======================>");
});
```
X
xuchenghua09 已提交
577

Z
zengyawen 已提交
578
### getData
X
xuchenghua09 已提交
579

Z
zengyawen 已提交
580
getData(callback: AsyncCallback\<string>): void
X
xuchenghua09 已提交
581

Z
zengyawen 已提交
582
获取公共事件的结果数据(callback形式)。
X
xuchenghua09 已提交
583

Z
zengyawen 已提交
584
**参数:**
X
xuchenghua09 已提交
585

Z
zengyawen 已提交
586 587 588
| 参数名   | 类型                   | 必填 | 描述                 |
| -------- | ---------------------- | ---- | -------------------- |
| callback | AsyncCallback\<string> | 是   | 公共事件的结果数据。 |
X
xuchenghua09 已提交
589

Z
zengyawen 已提交
590
**示例:**
X
xuchenghua09 已提交
591

Z
zengyawen 已提交
592 593 594 595 596 597 598 599 600 601
```js
var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function getDataCallback(err, data) {
    console.info("==========================>getDataCallback=======================>");
    console.info("==========================>err:=======================>", err.code);
    console.info("==========================>data:=======================>", data);
}
subscriber.getData(getDataCallback);
```
X
xuchenghua09 已提交
602

Z
zengyawen 已提交
603
### getData
X
xuchenghua09 已提交
604

Z
zengyawen 已提交
605
getData(): Promise\<string>
X
xuchenghua09 已提交
606

Z
zengyawen 已提交
607
获取公共事件的结果数据(Promise形式)。
X
xuchenghua09 已提交
608

Z
zengyawen 已提交
609
**返回值:**
X
xuchenghua09 已提交
610

Z
zengyawen 已提交
611 612 613
| 类型             | 说明               |
| ---------------- | ------------------ |
| Promise\<string> | 公共事件的结果数据 |
X
xuchenghua09 已提交
614

Z
zengyawen 已提交
615
**示例:**
X
xuchenghua09 已提交
616

Z
zengyawen 已提交
617 618 619 620 621 622 623
```js
var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.getData().then((data) => {
	console.info("==========================>getDataPromise=======================>");
    console.info("==========================>data:=======================>", data);
});
```
X
xuchenghua09 已提交
624

Z
zengyawen 已提交
625
### setData
X
xuchenghua09 已提交
626

Z
zengyawen 已提交
627
setData(data: string, callback: AsyncCallback\<void>): void
X
xuchenghua09 已提交
628

Z
zengyawen 已提交
629
设置公共事件的结果数据(callback形式)。
X
xuchenghua09 已提交
630

Z
zengyawen 已提交
631
**参数:**
X
xuchenghua09 已提交
632

Z
zengyawen 已提交
633 634 635 636
| 参数名   | 类型                 | 必填 | 描述                 |
| -------- | -------------------- | ---- | -------------------- |
| data     | string               | 是   | 公共事件的结果数据   |
| callback | AsyncCallback\<void> | 是   | 表示被指定的回调方法 |
X
xuchenghua09 已提交
637

Z
zengyawen 已提交
638
**示例:**
X
xuchenghua09 已提交
639

Z
zengyawen 已提交
640 641 642 643 644 645 646 647 648
```js
var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function setDataCallback(err) {
    console.info("==========================>setDataCallback=======================>");
    console.info("==========================>err:=======================>", err.code);
}
subscriber.setData("publish_data_changed", setDataCallback);
```
X
xuchenghua09 已提交
649

Z
zengyawen 已提交
650
### setData
X
xuchenghua09 已提交
651

Z
zengyawen 已提交
652
setData(data: string): Promise\<void>
X
xuchenghua09 已提交
653

Z
zengyawen 已提交
654
设置公共事件的结果数据(Promise形式)。
X
xuchenghua09 已提交
655

Z
zengyawen 已提交
656
**参数:**
X
xuchenghua09 已提交
657

Z
zengyawen 已提交
658 659 660
| 参数名 | 类型   | 必填 | 描述                 |
| ------ | ------ | ---- | -------------------- |
| data   | string | 是   | 公共事件的结果数据。 |
X
xuchenghua09 已提交
661

Z
zengyawen 已提交
662
**示例:**
X
xuchenghua09 已提交
663

Z
zengyawen 已提交
664 665 666 667 668 669
```js
var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.setData("publish_data_changed").then(() => {
	console.info("==========================>setDataPromise=======================>");
});
```
X
xuchenghua09 已提交
670

Z
zengyawen 已提交
671
### setCodeAndData
X
xuchenghua09 已提交
672

Z
zengyawen 已提交
673
setCodeAndData(code: number, data: string, callback:AsyncCallback\<void>): void
X
xuchenghua09 已提交
674

Z
zengyawen 已提交
675
设置公共事件的结果代码和结果数据(callback形式)。
X
xuchenghua09 已提交
676

Z
zengyawen 已提交
677
**参数:**
X
xuchenghua09 已提交
678

Z
zengyawen 已提交
679 680 681 682 683
| 参数名   | 类型                 | 必填 | 描述                   |
| -------- | -------------------- | ---- | ---------------------- |
| code     | number               | 是   | 公共事件的结果代码。   |
| data     | string               | 是   | 公共事件的结果数据。   |
| callback | AsyncCallback\<void> | 是   | 表示被指定的回调方法。 |
X
xuchenghua09 已提交
684

Z
zengyawen 已提交
685
**示例:**
X
xuchenghua09 已提交
686

Z
zengyawen 已提交
687 688 689 690 691 692 693 694 695
```js
var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function setCodeDataCallback(err) {
    console.info("==========================>setCodeDataCallback=======================>");
    console.info("==========================>err:=======================>", err.code);
}
subscriber.setCodeAndData(1, "publish_data_changed", setCodeDataCallback);
```
X
xuchenghua09 已提交
696

Z
zengyawen 已提交
697
### setCodeAndData
X
xuchenghua09 已提交
698

Z
zengyawen 已提交
699
setCodeAndData(code: number, data: string): Promise\<void>
X
xuchenghua09 已提交
700

Z
zengyawen 已提交
701
设置公共事件的结果代码和结果数据(Promise形式)。
X
xuchenghua09 已提交
702

Z
zengyawen 已提交
703
**参数:**
X
xuchenghua09 已提交
704

Z
zengyawen 已提交
705 706 707 708
| 参数名 | 类型   | 必填 | 描述                 |
| ------ | ------ | ---- | -------------------- |
| code   | number | 是   | 公共事件的结果代码。 |
| data   | string | 是   | 公共事件的结果数据。 |
X
xuchenghua09 已提交
709

Z
zengyawen 已提交
710
**示例:**
X
xuchenghua09 已提交
711

Z
zengyawen 已提交
712 713 714 715 716 717
```js
var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.setCodeAndData(1, "publish_data_changed").then(() => {
	console.info("==========================>setCodeAndData=======================>");
});
```
X
xuchenghua09 已提交
718

Z
zengyawen 已提交
719
### isOrderedCommonEvent
X
xuchenghua09 已提交
720

Z
zengyawen 已提交
721
isOrderedCommonEvent(callback: AsyncCallback\<boolean>): void
X
xuchenghua09 已提交
722

Z
zengyawen 已提交
723
查询当前公共事件的是否为有序公共事件(callback形式)。
X
xuchenghua09 已提交
724

Z
zengyawen 已提交
725
返回true代表是有序公共事件,false代表不是有序公共事件。
X
xuchenghua09 已提交
726

Z
zengyawen 已提交
727
**参数:**
X
xuchenghua09 已提交
728

Z
zengyawen 已提交
729 730 731
| 参数名   | 类型                    | 必填 | 描述                               |
| -------- | ----------------------- | ---- | ---------------------------------- |
| callback | AsyncCallback\<boolean> | 是   | 当前公共事件的是否为有序公共事件。 |
X
xuchenghua09 已提交
732

Z
zengyawen 已提交
733
**示例:**
X
xuchenghua09 已提交
734

Z
zengyawen 已提交
735 736 737 738 739 740 741 742 743 744
```js
var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function isOrderedCallback(err, data) {
    console.info("==========================>isOrderedCallback=======================>");
    console.info("==========================>err:=======================>", err.code);
    console.info("==========================>isOrdered:=======================>", data);
}
subscriber.isOrderedCommonEvent(isOrderedCallback);
```
X
xuchenghua09 已提交
745

Z
zengyawen 已提交
746
### isOrderedCommonEvent
X
xuchenghua09 已提交
747

Z
zengyawen 已提交
748
isOrderedCommonEvent(): Promise\<boolean>
X
xuchenghua09 已提交
749

Z
zengyawen 已提交
750
查询当前公共事件的是否为有序公共事件(Promise形式)。
X
xuchenghua09 已提交
751

Z
zengyawen 已提交
752
返回true代表是有序公共事件,false代表不是有序公共事件。
X
xuchenghua09 已提交
753

Z
zengyawen 已提交
754
**返回值:**
X
xuchenghua09 已提交
755

Z
zengyawen 已提交
756 757 758
| 类型              | 说明                             |
| ----------------- | -------------------------------- |
| Promise\<boolean> | 当前公共事件的是否为有序公共事件 |
X
xuchenghua09 已提交
759

Z
zengyawen 已提交
760
**示例:**
X
xuchenghua09 已提交
761

Z
zengyawen 已提交
762 763 764 765 766 767
```js
var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.isOrderedCommonEvent().then((data) => {
	console.info("==========================>isOrdered:=======================>", data);
});
```
X
xuchenghua09 已提交
768

Z
zengyawen 已提交
769
### abortCommonEvent
X
xuchenghua09 已提交
770

Z
zengyawen 已提交
771
abortCommonEvent(callback: AsyncCallback\<void>): void
X
xuchenghua09 已提交
772

Z
zengyawen 已提交
773
取消当前的公共事件,仅对有序公共事件有效,取消后,公共事件不再向下一个订阅者传递(callback形式)。
X
xuchenghua09 已提交
774

Z
zengyawen 已提交
775
**参数:**
X
xuchenghua09 已提交
776

Z
zengyawen 已提交
777 778 779
| 参数名   | 类型                 | 必填 | 描述                 |
| -------- | -------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void> | 是   | 取消当前的公共事件。 |
X
xuchenghua09 已提交
780

Z
zengyawen 已提交
781
**示例:**
X
xuchenghua09 已提交
782

Z
zengyawen 已提交
783 784 785 786 787 788 789 790 791
```js
var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function abortCallback(err) {
    console.info("==========================>abortCallback=======================>");
 	console.info("==========================>err:=======================>", err.code);
}
subscriber.abortCommonEvent(abortCallback);
```
X
xuchenghua09 已提交
792

Z
zengyawen 已提交
793
### abortCommonEvent
X
xuchenghua09 已提交
794

Z
zengyawen 已提交
795
abortCommonEvent(): Promise\<void>
X
xuchenghua09 已提交
796

Z
zengyawen 已提交
797
取消当前的公共事件,仅对有序公共事件有效,取消后,公共事件不再向下一个订阅者传递(Promise形式)。
X
xuchenghua09 已提交
798

Z
zengyawen 已提交
799
**示例:**
X
xuchenghua09 已提交
800

Z
zengyawen 已提交
801 802 803 804 805 806
```js
var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.abortCommonEvent().then(() => {
	console.info("==========================>abortCommonEvent:=======================>");
});
```
X
xuchenghua09 已提交
807

Z
zengyawen 已提交
808
### clearAbortCommonEvent
X
xuchenghua09 已提交
809

Z
zengyawen 已提交
810
clearAbortCommonEvent(callback: AsyncCallback\<void>): void
X
xuchenghua09 已提交
811

Z
zengyawen 已提交
812
清除当前公共事件的取消状态,仅对有序公共事件有效(callback形式)。
X
xuchenghua09 已提交
813

Z
zengyawen 已提交
814
**参数:**
X
xuchenghua09 已提交
815

Z
zengyawen 已提交
816 817 818
| 参数名   | 类型                 | 必填 | 描述                 |
| -------- | -------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void> | 是   | 表示被指定的回调方法 |
X
xuchenghua09 已提交
819

Z
zengyawen 已提交
820
**示例:**
X
xuchenghua09 已提交
821

Z
zengyawen 已提交
822 823 824 825 826 827 828 829 830 831 832 833 834
```js
var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function clearAbortCallback(err) {
    console.info("==========================>clearAbortCallback=======================>");
 	console.info("==========================>err:=======================>", err.code);
}
subscriber.clearAbortCommonEvent(clearAbortCallback);
```

### clearAbortCommonEvent

clearAbortCommonEvent(): Promise\<void>
X
xuchenghua09 已提交
835

Z
zengyawen 已提交
836
清除当前公共事件的取消状态,仅对有序公共事件有效(Promise形式)。
X
xuchenghua09 已提交
837

Z
zengyawen 已提交
838
**示例:**
X
xuchenghua09 已提交
839

Z
zengyawen 已提交
840 841 842 843 844 845
```js
var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.clearAbortCommonEvent().then(() => {
	console.info("==========================>clearAbortCommonEvent:=======================>");
});
```
X
xuchenghua09 已提交
846

Z
zengyawen 已提交
847
### getAbortCommonEvent
X
xuchenghua09 已提交
848

Z
zengyawen 已提交
849
getAbortCommonEvent(callback: AsyncCallback\<boolean>): void
X
xuchenghua09 已提交
850

Z
zengyawen 已提交
851
获取当前有序公共事件是否取消的状态(callback形式)。
X
xuchenghua09 已提交
852

Z
zengyawen 已提交
853
**参数:**
X
xuchenghua09 已提交
854

Z
zengyawen 已提交
855 856 857
| 参数名   | 类型                    | 必填 | 描述                               |
| -------- | ----------------------- | ---- | ---------------------------------- |
| callback | AsyncCallback\<boolean> | 是   | 表示当前有序公共事件是否取消的状态 |
X
xuchenghua09 已提交
858

Z
zengyawen 已提交
859
**示例:**
X
xuchenghua09 已提交
860

Z
zengyawen 已提交
861 862 863 864 865 866 867 868 869 870
```js
var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function getAbortCallback(err, data) {
    console.info("==========================>getAbortCallback=======================>");
 	console.info("==========================>err:=======================>", err.code);
    console.info("==========================>abort:=======================>", data);
}
subscriber.getAbortCommonEvent(getAbortCallback);
```
X
xuchenghua09 已提交
871

Z
zengyawen 已提交
872
### getAbortCommonEvent
X
xuchenghua09 已提交
873

Z
zengyawen 已提交
874
getAbortCommonEvent(): Promise\<void>
X
xuchenghua09 已提交
875

Z
zengyawen 已提交
876
获取当前有序公共事件是否取消的状态(Promise形式)。
X
xuchenghua09 已提交
877

Z
zengyawen 已提交
878
**返回值:**
X
xuchenghua09 已提交
879

Z
zengyawen 已提交
880 881 882
| 类型              | 说明                               |
| ----------------- | ---------------------------------- |
| Promise\<boolean> | 表示当前有序公共事件是否取消的状态 |
X
xuchenghua09 已提交
883

Z
zengyawen 已提交
884
**示例:**
X
xuchenghua09 已提交
885

Z
zengyawen 已提交
886 887 888 889 890 891 892
```js
var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.getAbortCommonEvent().then((data) => {
	console.info("==========================>getAbortCommonEvent:=======================>");
    console.info("==========================>abort:=======================>", data);
});
```
X
xuchenghua09 已提交
893

Z
zengyawen 已提交
894
### getSubscribeInfo
X
xuchenghua09 已提交
895

Z
zengyawen 已提交
896
getSubscribeInfo(callback: AsyncCallback\<CommonEventSubscribeInfo>): void
X
xuchenghua09 已提交
897

Z
zengyawen 已提交
898
获取订阅者的订阅信息(callback形式)。
X
xuchenghua09 已提交
899

Z
zengyawen 已提交
900
**参数:**
X
xuchenghua09 已提交
901

Z
zengyawen 已提交
902 903 904
| 参数名   | 类型                                                         | 必填 | 描述                   |
| -------- | ------------------------------------------------------------ | ---- | ---------------------- |
| callback | AsyncCallback\<[CommonEventSubscribeInfo](#commoneventsubscribeinfo)> | 是   | 表示订阅者的订阅信息。 |
X
xuchenghua09 已提交
905

Z
zengyawen 已提交
906
**示例:**
X
xuchenghua09 已提交
907

Z
zengyawen 已提交
908 909 910 911 912 913 914 915 916 917
```js
var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function getSubscribeInfoCallback(err, data) {
    console.info("==========================>getSubscribeInfoCallback=======================>");
 	console.info("==========================>err:=======================>", err.code);
    console.info("==========================>priority:=======================>", data.priority);
}
subscriber.getSubscribeInfo(getSubscribeInfoCallback);
```
X
xuchenghua09 已提交
918

Z
zengyawen 已提交
919
### getSubscribeInfo
X
xuchenghua09 已提交
920

Z
zengyawen 已提交
921
getSubscribeInfo(): Promise\<CommonEventSubscribeInfo>
X
xuchenghua09 已提交
922

Z
zengyawen 已提交
923
获取订阅者的订阅信息(Promise形式)。
X
xuchenghua09 已提交
924

Z
zengyawen 已提交
925
**返回值:**
X
xuchenghua09 已提交
926

Z
zengyawen 已提交
927 928 929
| 类型                                                         | 说明                   |
| ------------------------------------------------------------ | ---------------------- |
| Promise\<[CommonEventSubscribeInfo](#commoneventsubscribeinfo)> | 表示订阅者的订阅信息。 |
X
xuchenghua09 已提交
930

Z
zengyawen 已提交
931
**示例:**
X
xuchenghua09 已提交
932

Z
zengyawen 已提交
933 934 935 936 937 938 939
```js
var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
subscriber.getSubscribeInfo().then((data) => {
	console.info("==========================>getSubscribeInfo:=======================>");
    console.info("==========================>priority:=======================>", data.priority);
});
```