1# 公共事件模块 2 3>  **说明：** 4> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 5> 6> API 9当前为Canary版本，仅供使用，不保证接口可稳定调用。 7 8## 公共事件列表 9 10| 系统公共事件宏 | 系统公共事件名称 | 订阅者所需权限 | 11| ------------ | ------------------ | ---------------------- | 12| COMMON_EVENT_BOOT_COMPLETED | usual.event.BOOT_COMPLETED | ohos.permission.RECEIVER_STARTUP_COMPLETED | 13| COMMON_EVENT_LOCKED_BOOT_COMPLETED | usual.event.LOCKED_BOOT_COMPLETED | ohos.permission.RECEIVER_STARTUP_COMPLETED | 14| COMMON_EVENT_SHUTDOWN | usual.event.SHUTDOWN | 无 | 15| COMMON_EVENT_BATTERY_CHANGED | usual.event.BATTERY_CHANGED | 无 | 16| COMMON_EVENT_BATTERY_LOW | usual.event.BATTERY_LOW | 无 | 17| COMMON_EVENT_BATTERY_OKAY | usual.event.BATTERY_OKAY | 无 | 18| COMMON_EVENT_POWER_CONNECTED | usual.event.POWER_CONNECTED | 无 | 19| COMMON_EVENT_POWER_DISCONNECTED | usual.event.POWER_DISCONNECTED | 无 | 20| COMMON_EVENT_SCREEN_OFF | usual.event.SCREEN_OFF | 无 | 21| COMMON_EVENT_SCREEN_ON | usual.event.SCREEN_ON | 无 | 22| COMMON_EVENT_THERMAL_LEVEL_CHANGED | usual.event.THERMAL_LEVEL_CHANGED | 无 | 23| COMMON_EVENT_USER_PRESENT | usual.event.USER_PRESENT | 无 | 24| COMMON_EVENT_TIME_TICK | usual.event.TIME_TICK | 无 | 25| COMMON_EVENT_TIME_CHANGED | usual.event.TIME_CHANGED | 无 | 26| COMMON_EVENT_DATE_CHANGED | usual.event.DATE_CHANGED | 无 | 27| COMMON_EVENT_TIMEZONE_CHANGED | usual.event.TIMEZONE_CHANGED | 无 | 28| COMMON_EVENT_CLOSE_SYSTEM_DIALOGS | usual.event.CLOSE_SYSTEM_DIALOGS | 无 | 29| COMMON_EVENT_PACKAGE_ADDED | usual.event.PACKAGE_ADDED | 无 | 30| COMMON_EVENT_PACKAGE_REPLACED | usual.event.PACKAGE_REPLACED | 无 | 31| COMMON_EVENT_MY_PACKAGE_REPLACED | usual.event.MY_PACKAGE_REPLACED | 无 | 32| COMMON_EVENT_PACKAGE_REMOVED | usual.event.PACKAGE_REMOVED | 无 | 33| COMMON_EVENT_BUNDLE_REMOVED | usual.event.BUNDLE_REMOVED | 无 | 34| COMMON_EVENT_PACKAGE_FULLY_REMOVED | usual.event.PACKAGE_FULLY_REMOVED | 无 | 35| COMMON_EVENT_PACKAGE_CHANGED | usual.event.PACKAGE_CHANGED | 无 | 36| COMMON_EVENT_PACKAGE_RESTARTED | usual.event.PACKAGE_RESTARTED | 无 | 37| COMMON_EVENT_PACKAGE_DATA_CLEARED | usual.event.PACKAGE_DATA_CLEARED | 无 | 38| COMMON_EVENT_PACKAGES_SUSPENDED | usual.event.PACKAGES_SUSPENDED | 无 | 39| COMMON_EVENT_PACKAGES_UNSUSPENDED | usual.event.PACKAGES_UNSUSPENDED | 无 | 40| COMMON_EVENT_MY_PACKAGE_SUSPENDED | usual.event.MY_PACKAGE_SUSPENDED | 无 | 41| COMMON_EVENT_MY_PACKAGE_UNSUSPENDED | usual.event.MY_PACKAGE_UNSUSPENDED | 无 | 42| COMMON_EVENT_UID_REMOVED | usual.event.UID_REMOVED | 无 | 43| COMMON_EVENT_PACKAGE_FIRST_LAUNCH | usual.event.PACKAGE_FIRST_LAUNCH | 无 | 44| COMMON_EVENT_PACKAGE_NEEDS_VERIFICATION | usual.event.PACKAGE_NEEDS_VERIFICATION | 无 | 45| COMMON_EVENT_PACKAGE_VERIFIED | usual.event.PACKAGE_VERIFIED | 无 | 46| COMMON_EVENT_EXTERNAL_APPLICATIONS_AVAILABLE | usual.event.EXTERNAL_APPLICATIONS_AVAILABLE | 无 | 47| COMMON_EVENT_EXTERNAL_APPLICATIONS_UNAVAILABLE | usual.event.EXTERNAL_APPLICATIONS_UNAVAILABLE | 无 | 48| COMMON_EVENT_CONFIGURATION_CHANGED | usual.event.CONFIGURATION_CHANGED | 无 | 49| COMMON_EVENT_LOCALE_CHANGED | usual.event.LOCALE_CHANGED | 无 | 50| COMMON_EVENT_MANAGE_PACKAGE_STORAGE | usual.event.MANAGE_PACKAGE_STORAGE | 无 | 51| COMMON_EVENT_DRIVE_MODE | common.event.DRIVE_MODE | 无 | 52| COMMON_EVENT_HOME_MODE | common.event.HOME_MODE | 无 | 53| COMMON_EVENT_OFFICE_MODE | common.event.OFFICE_MODE | 无 | 54| COMMON_EVENT_USER_STARTED | usual.event.USER_STARTED | 无 | 55| COMMON_EVENT_USER_BACKGROUND | usual.event.USER_BACKGROUND | 无 | 56| COMMON_EVENT_USER_FOREGROUND | usual.event.USER_FOREGROUND | 无 | 57| COMMON_EVENT_USER_SWITCHED | usual.event.USER_SWITCHED | ohos.permission.MANAGE_USERS | 58| COMMON_EVENT_USER_STARTING | usual.event.USER_STARTING | ohos.permission.INTERACT_ACROSS_USERS | 59| COMMON_EVENT_USER_UNLOCKED | usual.event.USER_UNLOCKED | 无 | 60| COMMON_EVENT_USER_STOPPING | usual.event.USER_STOPPING | ohos.permission.INTERACT_ACROSS_USERS | 61| COMMON_EVENT_USER_STOPPED | usual.event.USER_STOPPED | 无 | 62| COMMON_EVENT_HWID_LOGIN | common.event.HWID_LOGIN | 无 | 63| COMMON_EVENT_HWID_LOGOUT | common.event.HWID_LOGOUT | 无 | 64| COMMON_EVENT_HWID_TOKEN_INVALID | common.event.HWID_TOKEN_INVALID | 无 | 65| COMMON_EVENT_HWID_LOGOFF | common.event.HWID_LOGOFF | 无 | 66| COMMON_EVENT_WIFI_POWER_STATE | usual.event.wifi.POWER_STATE | 无 | 67| COMMON_EVENT_WIFI_SCAN_FINISHED | usual.event.wifi.SCAN_FINISHED | ohos.permission.LOCATION | 68| COMMON_EVENT_WIFI_RSSI_VALUE | usual.event.wifi.RSSI_VALUE | ohos.permission.GET_WIFI_INFO | 69| COMMON_EVENT_WIFI_CONN_STATE | usual.event.wifi.CONN_STATE | 无 | 70| COMMON_EVENT_WIFI_HOTSPOT_STATE | usual.event.wifi.HOTSPOT_STATE | 无 | 71| COMMON_EVENT_WIFI_AP_STA_JOIN | usual.event.wifi.WIFI_HS_STA_JOIN | ohos.permission.GET_WIFI_INFO | 72| COMMON_EVENT_WIFI_AP_STA_LEAVE | usual.event.wifi.WIFI_HS_STA_LEAVE | ohos.permission.GET_WIFI_INFO | 73| COMMON_EVENT_WIFI_MPLINK_STATE_CHANGE | usual.event.wifi.mplink.STATE_CHANGE | ohos.permission.MPLINK_CHANGE_STATE | 74| COMMON_EVENT_WIFI_P2P_CONN_STATE | usual.event.wifi.p2p.CONN_STATE_CHANGE | ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION | 75| COMMON_EVENT_WIFI_P2P_STATE_CHANGED | usual.event.wifi.p2p.STATE_CHANGE | ohos.permission.GET_WIFI_INFO | 76| COMMON_EVENT_WIFI_P2P_PEERS_STATE_CHANGED | usual.event.wifi.p2p.DEVICES_CHANGE | ohos.permission.GET_WIFI_INFO | 77| COMMON_EVENT_WIFI_P2P_PEERS_DISCOVERY_STATE_CHANGED | usual.event.wifi.p2p.PEER_DISCOVERY_STATE_CHANGE | ohos.permission.GET_WIFI_INFO | 78| COMMON_EVENT_WIFI_P2P_CURRENT_DEVICE_STATE_CHANGED | usual.event.wifi.p2p.CURRENT_DEVICE_CHANGE | ohos.permission.GET_WIFI_INFO | 79| COMMON_EVENT_WIFI_P2P_GROUP_STATE_CHANGED | usual.event.wifi.p2p.GROUP_STATE_CHANGED | ohos.permission.GET_WIFI_INFO | 80| COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_CONNECT_STATE_UPDATE | usual.event.bluetooth.handsfree.ag.CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | 81| COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_CURRENT_DEVICE_UPDATE | usual.event.bluetooth.handsfree.ag.CURRENT_DEVICE_UPDATE | ohos.permission.USE_BLUETOOTH | 82| COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_AUDIO_STATE_UPDATE | usual.event.bluetooth.handsfree.ag.AUDIO_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | 83| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CONNECT_STATE_UPDATE | usual.event.bluetooth.a2dpsource.CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | 84| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CURRENT_DEVICE_UPDATE | usual.event.bluetooth.a2dpsource.CURRENT_DEVICE_UPDATE | ohos.permission.USE_BLUETOOTH | 85| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_PLAYING_STATE_UPDATE | usual.event.bluetooth.a2dpsource.PLAYING_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | 86| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_AVRCP_CONNECT_STATE_UPDATE | usual.event.bluetooth.a2dpsource.AVRCP_CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | 87| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CODEC_VALUE_UPDATE | usual.event.bluetooth.a2dpsource.CODEC_VALUE_UPDATE | ohos.permission.USE_BLUETOOTH | 88| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_DISCOVERED | usual.event.bluetooth.remotedevice.DISCOVERED | ohos.permission.LOCATION and ohos.permission.USE_BLUETOOTH | 89| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CLASS_VALUE_UPDATE | usual.event.bluetooth.remotedevice.CLASS_VALUE_UPDATE | ohos.permission.USE_BLUETOOTH | 90| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_CONNECTED | usual.event.bluetooth.remotedevice.ACL_CONNECTED | ohos.permission.USE_BLUETOOTH | 91| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_DISCONNECTED | usual.event.bluetooth.remotedevice.ACL_DISCONNECTED | ohos.permission.USE_BLUETOOTH | 92| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_NAME_UPDATE | usual.event.bluetooth.remotedevice.NAME_UPDATE | ohos.permission.USE_BLUETOOTH | 93| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIR_STATE | usual.event.bluetooth.remotedevice.PAIR_STATE | ohos.permission.USE_BLUETOOTH | 94| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_BATTERY_VALUE_UPDATE | usual.event.bluetooth.remotedevice.BATTERY_VALUE_UPDATE | ohos.permission.USE_BLUETOOTH | 95| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_SDP_RESULT | usual.event.bluetooth.remotedevice.SDP_RESULT | 无 | 96| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_UUID_VALUE | usual.event.bluetooth.remotedevice.UUID_VALUE | ohos.permission.DISCOVER_BLUETOOTH | 97| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIRING_REQ | usual.event.bluetooth.remotedevice.PAIRING_REQ | ohos.permission.DISCOVER_BLUETOOTH | 98| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIRING_CANCEL | usual.event.bluetooth.remotedevice.PAIRING_CANCEL | 无 | 99| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_REQ | usual.event.bluetooth.remotedevice.CONNECT_REQ | 无 | 100| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_REPLY | usual.event.bluetooth.remotedevice.CONNECT_REPLY | 无 | 101| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_CANCEL | usual.event.bluetooth.remotedevice.CONNECT_CANCEL | 无 | 102| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_CONNECT_STATE_UPDATE | usual.event.bluetooth.handsfreeunit.CONNECT_STATE_UPDATE | 无 | 103| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AUDIO_STATE_UPDATE | usual.event.bluetooth.handsfreeunit.AUDIO_STATE_UPDATE | 无 | 104| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AG_COMMON_EVENT | usual.event.bluetooth.handsfreeunit.AG_COMMON_EVENT | 无 | 105| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AG_CALL_STATE_UPDATE | usual.event.bluetooth.handsfreeunit.AG_CALL_STATE_UPDATE | 无 | 106| COMMON_EVENT_BLUETOOTH_HOST_STATE_UPDATE | usual.event.bluetooth.host.STATE_UPDATE | ohos.permission.USE_BLUETOOTH | 107| COMMON_EVENT_BLUETOOTH_HOST_REQ_DISCOVERABLE | usual.event.bluetooth.host.REQ_DISCOVERABLE | 无 | 108| COMMON_EVENT_BLUETOOTH_HOST_REQ_ENABLE | usual.event.bluetooth.host.REQ_ENABLE | ohos.permission.USE_BLUETOOTH | 109| COMMON_EVENT_BLUETOOTH_HOST_REQ_DISABLE | usual.event.bluetooth.host.REQ_DISABLE | ohos.permission.USE_BLUETOOTH | 110| COMMON_EVENT_BLUETOOTH_HOST_SCAN_MODE_UPDATE | usual.event.bluetooth.host.SCAN_MODE_UPDATE | ohos.permission.USE_BLUETOOTH | 111| COMMON_EVENT_BLUETOOTH_HOST_DISCOVERY_STARTED | usual.event.bluetooth.host.DISCOVERY_STARTED | ohos.permission.USE_BLUETOOTH | 112| COMMON_EVENT_BLUETOOTH_HOST_DISCOVERY_FINISHED | usual.event.bluetooth.host.DISCOVERY_FINISHED | ohos.permission.USE_BLUETOOTH | 113| COMMON_EVENT_BLUETOOTH_HOST_NAME_UPDATE | usual.event.bluetooth.host.NAME_UPDATE | ohos.permission.USE_BLUETOOTH | 114| COMMON_EVENT_BLUETOOTH_A2DPSINK_CONNECT_STATE_UPDATE | usual.event.bluetooth.a2dpsink.CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | 115| COMMON_EVENT_BLUETOOTH_A2DPSINK_PLAYING_STATE_UPDATE | usual.event.bluetooth.a2dpsink.PLAYING_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | 116| COMMON_EVENT_BLUETOOTH_A2DPSINK_AUDIO_STATE_UPDATE | usual.event.bluetooth.a2dpsink.AUDIO_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | 117| COMMON_EVENT_NFC_ACTION_ADAPTER_STATE_CHANGED | usual.event.nfc.action.ADAPTER_STATE_CHANGED | 无 | 118| COMMON_EVENT_NFC_ACTION_RF_FIELD_ON_DETECTED | usual.event.nfc.action.RF_FIELD_ON_DETECTED | ohos.permission.MANAGE_SECURE_SETTINGS | 119| COMMON_EVENT_NFC_ACTION_RF_FIELD_OFF_DETECTED | usual.event.nfc.action.RF_FIELD_OFF_DETECTED | ohos.permission.MANAGE_SECURE_SETTINGS | 120| COMMON_EVENT_DISCHARGING | usual.event.DISCHARGING | 无 | 121| COMMON_EVENT_CHARGING | usual.event.CHARGING | 无 | 122| COMMON_EVENT_DEVICE_IDLE_MODE_CHANGED | usual.event.DEVICE_IDLE_MODE_CHANGED | 无 | 123| COMMON_EVENT_POWER_SAVE_MODE_CHANGED | usual.event.POWER_SAVE_MODE_CHANGED | 无 | 124| COMMON_EVENT_USER_ADDED | usual.event.USER_ADDED | ohos.permission.MANAGE_USERS | 125| COMMON_EVENT_USER_REMOVED | usual.event.USER_REMOVED | ohos.permission.MANAGE_USERS | 126| COMMON_EVENT_ABILITY_ADDED | usual.event.ABILITY_ADDED | ohos.permission.LISTEN_BUNDLE_CHANGE | 127| COMMON_EVENT_ABILITY_REMOVED | usual.event.ABILITY_REMOVED | ohos.permission.LISTEN_BUNDLE_CHANGE | 128| COMMON_EVENT_ABILITY_UPDATED | usual.event.ABILITY_UPDATED | ohos.permission.LISTEN_BUNDLE_CHANGE | 129| COMMON_EVENT_LOCATION_MODE_STATE_CHANGED | usual.event.location.MODE_STATE_CHANGED | 无 | 130| COMMON_EVENT_IVI_SLEEP | common.event.IVI_SLEEP | 无 | 131| COMMON_EVENT_IVI_PAUSE | common.event.IVI_PAUSE | 无 | 132| COMMON_EVENT_IVI_STANDBY | common.event.IVI_STANDBY | 无 | 133| COMMON_EVENT_IVI_LASTMODE_SAVE | common.event.IVI_LASTMODE_SAVE | 无 | 134| COMMON_EVENT_IVI_VOLTAGE_ABNORMAL | common.event.IVI_VOLTAGE_ABNORMAL | 无 | 135| COMMON_EVENT_IVI_HIGH_TEMPERATURE | common.event.IVI_HIGH_TEMPERATURE | 无 | 136| COMMON_EVENT_IVI_EXTREME_TEMPERATURE | common.event.IVI_EXTREME_TEMPERATURE | 无 | 137| COMMON_EVENT_IVI_TEMPERATURE_ABNORMAL | common.event.IVI_TEMPERATURE_ABNORMAL | 无 | 138| COMMON_EVENT_IVI_VOLTAGE_RECOVERY | common.event.IVI_VOLTAGE_RECOVERY | 无 | 139| COMMON_EVENT_IVI_TEMPERATURE_RECOVERY | common.event.IVI_TEMPERATURE_RECOVERY | 无 | 140| COMMON_EVENT_IVI_ACTIVE | common.event.IVI_ACTIVE | 无 | 141| COMMON_EVENT_USB_DEVICE_ATTACHED | usual.event.hardware.usb.action.USB_DEVICE_ATTACHED | 无 | 142| COMMON_EVENT_USB_DEVICE_DETACHED | usual.event.hardware.usb.action.USB_DEVICE_DETACHED | 无 | 143| COMMON_EVENT_USB_ACCESSORY_ATTACHED | usual.event.hardware.usb.action.USB_ACCESSORY_ATTACHED | 无 | 144| COMMON_EVENT_USB_ACCESSORY_DETACHED | usual.event.hardware.usb.action.USB_ACCESSORY_DETACHED | 无 | 145| COMMON_EVENT_DISK_REMOVED | usual.event.data.DISK_REMOVED | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 146| COMMON_EVENT_DISK_UNMOUNTED | usual.event.data.DISK_UNMOUNTED | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 147| COMMON_EVENT_DISK_MOUNTED | usual.event.data.DISK_MOUNTED | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 148| COMMON_EVENT_DISK_BAD_REMOVAL | usual.event.data.DISK_BAD_REMOVAL | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 149| COMMON_EVENT_DISK_UNMOUNTABLE | usual.event.data.DISK_UNMOUNTABLE | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 150| COMMON_EVENT_DISK_EJECT | usual.event.data.DISK_EJECT | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 151| COMMON_EVENT_VOLUME_REMOVED | usual.event.data.VOLUME_REMOVED | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 152| COMMON_EVENT_VOLUME_REMOVED<sup>9+</sup> | usual.event.data.VOLUME_REMOVED | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 153| COMMON_EVENT_VOLUME_UNMOUNTED<sup>9+</sup> | usual.event.data.VOLUME_UNMOUNTED | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 154| COMMON_EVENT_VOLUME_MOUNTED<sup>9+</sup> | usual.event.data.VOLUME_MOUNTED | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 155| COMMON_EVENT_VOLUME_BAD_REMOVAL<sup>9+</sup> | usual.event.data.VOLUME_BAD_REMOVAL | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 156| COMMON_EVENT_VOLUME_EJECT<sup>9+</sup> | usual.event.data.VOLUME_EJECT | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 157| COMMON_EVENT_VOLUME_UNMOUNTED | usual.event.data.VOLUME_UNMOUNTED | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 158| COMMON_EVENT_VOLUME_MOUNTED | usual.event.data.VOLUME_MOUNTED | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 159| COMMON_EVENT_VOLUME_BAD_REMOVAL | usual.event.data.VOLUME_BAD_REMOVAL | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 160| COMMON_EVENT_VOLUME_EJECT | usual.event.data.VOLUME_EJECT | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 161| COMMON_EVENT_VISIBLE_ACCOUNTS_UPDATED | usual.event.data.VISIBLE_ACCOUNTS_UPDATED | ohos.permission.GET_APP_ACCOUNTS | 162| COMMON_EVENT_ACCOUNT_DELETED | usual.event.data.ACCOUNT_DELETED | ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS | 163| COMMON_EVENT_FOUNDATION_READY | usual.event.data.FOUNDATION_READY | ohos.permission.RECEIVER_STARTUP_COMPLETED | 164| COMMON_EVENT_AIRPLANE_MODE_CHANGED | usual.event.AIRPLANE_MODE | 无 | 165| COMMON_EVENT_SPLIT_SCREEN | usual.event.SPLIT_SCREEN | ohos.permission.RECEIVER_SPLIT_SCREEN | 166 167## 导入模块 168 169```js 170import CommonEvent from '@ohos.commonEvent'; 171``` 172 173## CommonEvent.publish 174 175publish(event: string, callback: AsyncCallback\<void>): void 176 177发布公共事件（callback形式）。 178 179**系统能力：** SystemCapability.Notification.CommonEvent 180 181**参数：** 182 183| 名称 | 读写属性 | 类型 | 必填 | 描述 | 184| -------- | -------- | -------------------- | ---- | ---------------------- | 185| event | 只读 | string | 是 | 表示要发送的公共事件。 | 186| callback | 只读 | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 | 187 188**示例：** 189 190```js 191//发布公共事件回调 192function PublishCallBack(err) { 193 if (err.code) { 194 console.error("publish failed " + JSON.stringify(err)); 195 } else { 196 console.info("publish"); 197 } 198} 199 200//发布公共事件 201CommonEvent.publish("event", PublishCallBack); 202``` 203 204 205 206## CommonEvent.publish 207 208publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\<void>): void 209 210发布公共事件指定发布信息（callback形式）。 211 212**系统能力：** SystemCapability.Notification.CommonEvent 213 214**参数：** 215 216| 名称 | 读写属性 | 类型 | 必填 | 描述 | 217| -------- | -------- | ---------------------- | ---- | ---------------------- | 218| event | 只读 | string | 是 | 表示要发布的公共事件。 | 219| options | 只读 | [CommonEventPublishData](#commoneventpublishdata) | 是 | 表示发布公共事件的属性。 | 220| callback | 只读 | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 | 221 222**示例：** 223 224 225```js 226//公共事件相关信息 227var options = { 228 code: 0, //公共事件的初始代码 229 data: "initial data",//公共事件的初始数据 230 isOrdered: true //有序公共事件 231} 232 233//发布公共事件回调 234function PublishCallBack(err) { 235 if (err.code) { 236 console.error("publish failed " + JSON.stringify(err)); 237 } else { 238 console.info("publish"); 239 } 240} 241 242//发布公共事件 243CommonEvent.publish("event", options, PublishCallBack); 244``` 245 246 247 248## CommonEvent.publishAsUser<sup>8+</sup> 249 250publishAsUser(event: string, userId: number, callback: AsyncCallback\<void>): void 251 252向指定用户发布公共事件（callback形式）。 253 254**系统能力：** SystemCapability.Notification.CommonEvent 255 256**参数：** 257 258| 名称 | 读写属性 | 类型 | 必填 | 描述 | 259| -------- | -------- | -------------------- | ---- | ---------------------------------- | 260| event | 只读 | string | 是 | 表示要发送的公共事件。 | 261| userId | 只读 | number | 是 | 表示指定向该用户ID发送此公共事件。 | 262| callback | 只读 | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 | 263 264**示例：** 265 266```js 267//发布公共事件回调 268function PublishAsUserCallBack(err) { 269 if (err.code) { 270 console.error("publishAsUser failed " + JSON.stringify(err)); 271 } else { 272 console.info("publishAsUser"); 273 } 274} 275 276//指定发送的用户 277var userId = 100; 278 279//发布公共事件 280CommonEvent.publishAsUser("event", userId, PublishAsUserCallBack); 281``` 282 283 284 285## CommonEvent.publishAsUser<sup>8+</sup> 286 287publishAsUser(event: string, userId: number, options: CommonEventPublishData, callback: AsyncCallback\<void>): void 288 289向指定用户发布公共事件并指定发布信息（callback形式）。 290 291**系统能力：** SystemCapability.Notification.CommonEvent 292 293**参数：** 294 295| 名称 | 读写属性 | 类型 | 必填 | 描述 | 296| -------- | -------- | ---------------------- | ---- | ---------------------- | 297| event | 只读 | string | 是 | 表示要发布的公共事件。 | 298| userId | 只读 | number | 是 | 表示指定向该用户ID发送此公共事件。 | 299| options | 只读 | [CommonEventPublishData](#commoneventpublishdata) | 是 | 表示发布公共事件的属性。 | 300| callback | 只读 | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 | 301 302**示例：** 303 304 305```js 306//公共事件相关信息 307var options = { 308 code: 0, //公共事件的初始代码 309 data: "initial data",//公共事件的初始数据 310} 311 312//发布公共事件回调 313function PublishAsUserCallBack(err) { 314 if (err.code) { 315 console.error("publishAsUser failed " + JSON.stringify(err)); 316 } else { 317 console.info("publishAsUser"); 318 } 319} 320 321//指定发送的用户 322var userId = 100; 323 324//发布公共事件 325CommonEvent.publishAsUser("event", userId, options, PublishAsUserCallBack); 326``` 327 328 329 330## CommonEvent.createSubscriber 331 332createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback\<CommonEventSubscriber>): void 333 334创建订阅者（callback形式）。 335 336**系统能力：** SystemCapability.Notification.CommonEvent 337 338**参数：** 339 340| 名称 | 读写属性 | 类型 | 必填 | 描述 | 341| ------------- | -------- | ------------------------------------------------------------ | ---- | -------------------------- | 342| subscribeInfo | 只读 | [CommonEventSubscribeInfo](#commoneventsubscribeinfo) | 是 | 表示订阅信息。 | 343| callback | 只读 | AsyncCallback\<[CommonEventSubscriber](#commoneventsubscriber)> | 是 | 表示创建订阅者的回调方法。 | 344 345**示例：** 346 347 348```js 349var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 350 351//订阅者信息 352var subscribeInfo = { 353 events: ["event"] 354}; 355 356//创建订阅者回调 357function CreateSubscriberCallBack(err, commonEventSubscriber) { 358 if (err.code) { 359 console.error("createSubscriber failed " + JSON.stringify(err)); 360 } else { 361 console.info("createSubscriber"); 362 subscriber = commonEventSubscriber; 363 } 364} 365 366//创建订阅者 367CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack); 368``` 369 370 371 372## CommonEvent.createSubscriber 373 374createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise\<CommonEventSubscriber> 375 376创建订阅者（Promise形式）。 377 378**系统能力：** SystemCapability.Notification.CommonEvent 379 380**参数：** 381 382| 名称 | 读写属性 | 类型 | 必填 | 描述 | 383| ------------- | -------- | ----------------------------------------------------- | ---- | -------------- | 384| subscribeInfo | 只读 | [CommonEventSubscribeInfo](#commoneventsubscribeinfo) | 是 | 表示订阅信息。 | 385 386**返回值：** 387| 类型 | 说明 | 388| --------------------------------------------------------- | ---------------- | 389| Promise\<[CommonEventSubscriber](#commoneventsubscriber)> | 返回订阅者对象。 | 390 391**示例：** 392 393```js 394var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 395 396//订阅者信息 397var subscribeInfo = { 398 events: ["event"] 399}; 400 401//创建订阅者 402CommonEvent.createSubscriber(subscribeInfo).then((commonEventSubscriber) => { 403 console.info("createSubscriber"); 404 subscriber = commonEventSubscriber; 405}).catch((err) => { 406 console.error("createSubscriber failed " + JSON.stringify(err)); 407}); 408``` 409 410 411 412## CommonEvent.subscribe 413 414subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\<CommonEventData>): void 415 416订阅公共事件（callback形式）。 417 418**系统能力：** SystemCapability.Notification.CommonEvent 419 420**参数：** 421 422| 名称 | 读写属性 | 类型 | 必填 | 描述 | 423| ---------- | -------- | --------------------------------------------------- | ---- | -------------------------------- | 424| subscriber | 只读 | [CommonEventSubscriber](#commoneventsubscriber) | 是 | 表示订阅者对象。 | 425| callback | 只读 | AsyncCallback\<[CommonEventData](#commoneventdata)> | 是 | 表示接收公共事件数据的回调函数。 | 426 427**示例：** 428 429```js 430var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 431 432//订阅者信息 433var subscribeInfo = { 434 events: ["event"] 435}; 436 437//订阅公共事件回调 438function SubscribeCallBack(err, data) { 439 if (err.code) { 440 console.error("subscribe failed " + JSON.stringify(err)); 441 } else { 442 console.info("subscribe " + JSON.stringify(data)); 443 } 444} 445 446//创建订阅者回调 447function CreateSubscriberCallBack(err, commonEventSubscriber) { 448 if (err.code) { 449 console.error("createSubscriber failed " + JSON.stringify(err)); 450 } else { 451 console.info("createSubscriber"); 452 subscriber = commonEventSubscriber; 453 //订阅公共事件 454 CommonEvent.subscribe(subscriber, SubscribeCallBack); 455 } 456} 457 458//创建订阅者 459CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack); 460``` 461 462 463 464## CommonEvent.unsubscribe 465 466unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback\<void>): void 467 468取消订阅公共事件（callback形式）。 469 470**系统能力：** SystemCapability.Notification.CommonEvent 471 472**参数：** 473 474| 名称 | 读写属性 | 类型 | 必填 | 描述 | 475| ---------- | -------- | ----------------------------------------------- | ---- | ------------------------ | 476| subscriber | 只读 | [CommonEventSubscriber](#commoneventsubscriber) | 是 | 表示订阅者对象。 | 477| callback | 只读 | AsyncCallback\<void> | 否 | 表示取消订阅的回调方法。 | 478 479**示例：** 480 481```js 482var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 483 484//订阅者信息 485var subscribeInfo = { 486 events: ["event"] 487}; 488 489//订阅公共事件回调 490function SubscribeCallBack(err, data) { 491 if (err.code) { 492 console.info("subscribe failed " + JSON.stringify(err)); 493 } else { 494 console.info("subscribe " + JSON.stringify(data)); 495 } 496} 497 498//创建订阅者回调 499function CreateSubscriberCallBack(err, commonEventSubscriber) { 500 if (err.code) { 501 console.info("createSubscriber failed " + JSON.stringify(err)); 502 } else { 503 console.info("createSubscriber"); 504 subscriber = commonEventSubscriber; 505 //订阅公共事件 506 CommonEvent.subscribe(subscriber, SubscribeCallBack); 507 } 508} 509 510//取消订阅公共事件回调 511function UnsubscribeCallBack(err) { 512 if (err.code) { 513 console.info("unsubscribe failed " + JSON.stringify(err)); 514 } else { 515 console.info("unsubscribe"); 516 } 517} 518 519//创建订阅者 520CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack); 521 522//取消订阅公共事件 523CommonEvent.unsubscribe(subscriber, UnsubscribeCallBack); 524``` 525 526## CommonEventSubscriber 527 528### getCode 529 530getCode(callback: AsyncCallback\<number>): void 531 532获取公共事件的结果代码（callback形式）。 533 534**系统能力**：SystemCapability.Notification.CommonEvent 535 536**参数：** 537 538| 参数名 | 类型 | 必填 | 描述 | 539| -------- | ---------------------- | ---- | ------------------ | 540| callback | AsyncCallback\<number> | 是 | 公共事件的结果代码。 | 541 542**示例：** 543 544```js 545var subscriber; //创建成功的订阅者对象 546 547//获取有序公共事件的结果代码回调 548function getCodeCallback(err, Code) { 549 if (err.code) { 550 console.error("getCode failed " + JSON.stringify(err)); 551 } else { 552 console.info("getCode " + JSON.stringify(Code)); 553 } 554} 555subscriber.getCode(getCodeCallback); 556``` 557 558### getCode 559 560getCode(): Promise\<number> 561 562获取公共事件的结果代码（Promise形式）。 563 564**系统能力**：SystemCapability.Notification.CommonEvent 565 566**返回值：** 567 568| 类型 | 说明 | 569| ---------------- | -------------------- | 570| Promise\<number> | 公共事件的结果代码。 | 571 572**示例：** 573 574```js 575var subscriber; //创建成功的订阅者对象 576 577subscriber.getCode().then((Code) => { 578 console.info("getCode " + JSON.stringify(Code)); 579}).catch((err) => { 580 console.error("getCode failed " + JSON.stringify(err)); 581}); 582``` 583 584### setCode 585 586setCode(code: number, callback: AsyncCallback\<void>): void 587 588设置公共事件的结果代码（callback形式）。 589 590**系统能力**：SystemCapability.Notification.CommonEvent 591 592**参数：** 593 594| 参数名 | 类型 | 必填 | 描述 | 595| -------- | -------------------- | ---- | ---------------------- | 596| code | number | 是 | 公共事件的结果代码。 | 597| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 | 598 599**示例：** 600 601```js 602var subscriber; //创建成功的订阅者对象 603 604//设置有序公共事件的结果代码回调 605function setCodeCallback(err) { 606 if (err.code) { 607 console.error("setCode failed " + JSON.stringify(err)); 608 } else { 609 console.info("setCode"); 610 } 611} 612subscriber.setCode(1, setCodeCallback); 613``` 614 615### setCode 616 617setCode(code: number): Promise\<void> 618 619设置公共事件的结果代码（Promise形式）。 620 621**系统能力**：SystemCapability.Notification.CommonEvent 622 623**参数：** 624 625| 参数名 | 类型 | 必填 | 描述 | 626| ------ | ------ | ---- | ------------------ | 627| code | number | 是 | 公共事件的结果代码。 | 628 629**返回值：** 630 631| 类型 | 说明 | 632| ---------------- | -------------------- | 633| Promise\<void> | 返回一个Promise的结果。 | 634 635**示例：** 636 637```js 638var subscriber; //创建成功的订阅者对象 639 640subscriber.setCode(1).then(() => { 641 console.info("setCode"); 642}).catch((err) => { 643 console.error("setCode failed " + JSON.stringify(err)); 644}); 645``` 646 647### getData 648 649getData(callback: AsyncCallback\<string>): void 650 651获取公共事件的结果数据（callback形式）。 652 653**系统能力**：SystemCapability.Notification.CommonEvent 654 655**参数：** 656 657| 参数名 | 类型 | 必填 | 描述 | 658| -------- | ---------------------- | ---- | -------------------- | 659| callback | AsyncCallback\<string> | 是 | 公共事件的结果数据。 | 660 661**示例：** 662 663```js 664var subscriber; //创建成功的订阅者对象 665 666//获取有序公共事件的结果数据回调 667function getDataCallback(err, Data) { 668 if (err.code) { 669 console.error("getData failed " + JSON.stringify(err)); 670 } else { 671 console.info("getData " + JSON.stringify(Data)); 672 } 673} 674subscriber.getData(getDataCallback); 675``` 676 677### getData 678 679getData(): Promise\<string> 680 681获取公共事件的结果数据（Promise形式）。 682 683**系统能力**：SystemCapability.Notification.CommonEvent 684 685**返回值：** 686 687| 类型 | 说明 | 688| ---------------- | ------------------ | 689| Promise\<string> | 公共事件的结果数据。 | 690 691**示例：** 692 693```js 694var subscriber; //创建成功的订阅者对象 695 696subscriber.getData().then((Data) => { 697 console.info("getData " + JSON.stringify(Data)); 698}).catch((err) => { 699 console.error("getData failed " + JSON.stringify(err)); 700}); 701``` 702 703### setData 704 705setData(data: string, callback: AsyncCallback\<void>): void 706 707设置公共事件的结果数据（callback形式）。 708 709**系统能力**：SystemCapability.Notification.CommonEvent 710 711**参数：** 712 713| 参数名 | 类型 | 必填 | 描述 | 714| -------- | -------------------- | ---- | -------------------- | 715| data | string | 是 | 公共事件的结果数据。 | 716| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 | 717 718**示例：** 719 720```js 721var subscriber; //创建成功的订阅者对象 722 723//设置有序公共事件的结果数据回调 724function setDataCallback(err) { 725 if (err.code) { 726 console.error("setData failed " + JSON.stringify(err)); 727 } else { 728 console.info("setData"); 729 } 730} 731subscriber.setData("publish_data_changed", setDataCallback); 732``` 733 734### setData 735 736setData(data: string): Promise\<void> 737 738设置公共事件的结果数据（Promise形式）。 739 740**系统能力**：SystemCapability.Notification.CommonEvent 741 742**参数：** 743 744| 参数名 | 类型 | 必填 | 描述 | 745| ------ | ------ | ---- | -------------------- | 746| data | string | 是 | 公共事件的结果数据。 | 747 748**返回值：** 749 750| 类型 | 说明 | 751| ---------------- | -------------------- | 752| Promise\<void> | 返回一个Promise的结果。 | 753 754**示例：** 755 756```js 757var subscriber; //创建成功的订阅者对象 758 759subscriber.setData("publish_data_changed").then(() => { 760 console.info("setData"); 761}).catch((err) => { 762 console.error("setData failed " + JSON.stringify(err)); 763}); 764``` 765 766### setCodeAndData 767 768setCodeAndData(code: number, data: string, callback:AsyncCallback\<void>): void 769 770设置公共事件的结果代码和结果数据（callback形式）。 771 772**系统能力**：SystemCapability.Notification.CommonEvent 773 774**参数：** 775 776| 参数名 | 类型 | 必填 | 描述 | 777| -------- | -------------------- | ---- | ---------------------- | 778| code | number | 是 | 公共事件的结果代码。 | 779| data | string | 是 | 公共事件的结果数据。 | 780| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 | 781 782**示例：** 783 784```js 785var subscriber; //创建成功的订阅者对象 786 787//设置有序公共事件的结果代码和结果数据回调 788function setCodeDataCallback(err) { 789 if (err.code) { 790 console.error("setCodeAndData failed " + JSON.stringify(err)); 791 } else { 792 console.info("setCodeDataCallback"); 793 } 794} 795subscriber.setCodeAndData(1, "publish_data_changed", setCodeDataCallback); 796``` 797 798### setCodeAndData 799 800setCodeAndData(code: number, data: string): Promise\<void> 801 802设置公共事件的结果代码和结果数据（Promise形式）。 803 804**系统能力**：SystemCapability.Notification.CommonEvent 805 806**参数：** 807 808| 参数名 | 类型 | 必填 | 描述 | 809| ------ | ------ | ---- | -------------------- | 810| code | number | 是 | 公共事件的结果代码。 | 811| data | string | 是 | 公共事件的结果数据。 | 812 813**返回值：** 814 815| 类型 | 说明 | 816| ---------------- | -------------------- | 817| Promise\<void> | 返回一个Promise的结果。 | 818 819**示例：** 820 821```js 822var subscriber; //创建成功的订阅者对象 823 824subscriber.setCodeAndData(1, "publish_data_changed").then(() => { 825 console.info("setCodeAndData"); 826}).catch((err) => { 827 console.info("setCodeAndData failed " + JSON.stringify(err)); 828}); 829``` 830 831### isOrderedCommonEvent 832 833isOrderedCommonEvent(callback: AsyncCallback\<boolean>): void 834 835查询当前公共事件的是否为有序公共事件（callback形式）。 836 837返回true代表是有序公共事件，false代表不是有序公共事件。 838 839**系统能力**：SystemCapability.Notification.CommonEvent 840 841**参数：** 842 843| 参数名 | 类型 | 必填 | 描述 | 844| -------- | ----------------------- | ---- | ---------------------------------- | 845| callback | AsyncCallback\<boolean> | 是 | 当前公共事件的是否为有序公共事件。 | 846 847**示例：** 848 849```js 850var subscriber; //创建成功的订阅者对象 851 852//获取当前公共事件是否为有序事件的回调 853function isOrderedCallback(err, isOrdered) { 854 if (err.code) { 855 console.error("isOrderedCommonEvent failed " + JSON.stringify(err)); 856 } else { 857 console.info("isOrdered " + JSON.stringify(isOrdered)); 858 } 859} 860subscriber.isOrderedCommonEvent(isOrderedCallback); 861``` 862 863### isOrderedCommonEvent 864 865isOrderedCommonEvent(): Promise\<boolean> 866 867查询当前公共事件的是否为有序公共事件（Promise形式）。 868 869返回true代表是有序公共事件，false代表不是有序公共事件。 870 871**系统能力**：SystemCapability.Notification.CommonEvent 872 873**返回值：** 874 875| 类型 | 说明 | 876| ----------------- | -------------------------------- | 877| Promise\<boolean> | 当前公共事件的是否为有序公共事件。 | 878 879**示例：** 880 881```js 882var subscriber; //创建成功的订阅者对象 883 884subscriber.isOrderedCommonEvent().then((isOrdered) => { 885 console.info("isOrdered " + JSON.stringify(isOrdered)); 886}).catch((err) => { 887 console.error("isOrdered failed " + JSON.stringify(err)); 888}); 889``` 890 891### isStickyCommonEvent 892 893isStickyCommonEvent(callback: AsyncCallback\<boolean>): void 894 895检查当前公共事件是否为一个粘性事件（callback形式）。 896 897返回true代表是粘性公共事件，false代表不是粘性公共事件。 898 899**系统能力**：SystemCapability.Notification.CommonEvent 900 901**参数：** 902 903| 参数名 | 类型 | 必填 | 描述 | 904| -------- | ----------------------- | ---- | ---------------------------------- | 905| callback | AsyncCallback\<boolean> | 是 | 当前公共事件的是否为粘性公共事件。 | 906 907**示例：** 908 909```js 910var subscriber; //创建成功的订阅者对象 911 912//获取当前公共事件是否为粘性事件的回调 913function isStickyCallback(err, isSticky) { 914 if (err.code) { 915 console.error("isStickyCommonEvent failed " + JSON.stringify(err)); 916 } else { 917 console.info("isSticky " + JSON.stringify(isSticky)); 918 } 919} 920subscriber.isStickyCommonEvent(isStickyCallback); 921``` 922 923### isStickyCommonEvent 924 925isStickyCommonEvent(): Promise\<boolean> 926 927检查当前公共事件是否为一个粘性事件（Promise形式）。 928 929返回true代表是粘性公共事件，false代表不是粘性公共事件。 930 931**系统能力**：SystemCapability.Notification.CommonEvent 932 933**返回值：** 934 935| 类型 | 说明 | 936| ----------------- | -------------------------------- | 937| Promise\<boolean> | 当前公共事件的是否为粘性公共事件。 | 938 939**示例：** 940 941```js 942var subscriber; //创建成功的订阅者对象 943 944subscriber.isStickyCommonEvent().then((isSticky) => { 945 console.info("isSticky " + JSON.stringify(isSticky)); 946}).catch((err) => { 947 console.error("isSticky failed " + JSON.stringify(err)); 948}); 949``` 950 951### abortCommonEvent 952 953abortCommonEvent(callback: AsyncCallback\<void>): void 954 955取消当前的公共事件，仅对有序公共事件有效，取消后，公共事件不再向下一个订阅者传递（callback形式）。 956 957**系统能力**：SystemCapability.Notification.CommonEvent 958 959**参数：** 960 961| 参数名 | 类型 | 必填 | 描述 | 962| -------- | -------------------- | ---- | -------------------- | 963| callback | AsyncCallback\<void> | 是 | 取消当前的公共事件。 | 964 965**示例：** 966 967```js 968var subscriber; //创建成功的订阅者对象 969 970//取消当前有序公共事件的回调 971function abortCallback(err) { 972 if (err.code) { 973 console.error("abortCommonEvent failed " + JSON.stringify(err)); 974 } else { 975 console.info("abortCommonEvent"); 976 } 977} 978subscriber.abortCommonEvent(abortCallback); 979``` 980 981### abortCommonEvent 982 983abortCommonEvent(): Promise\<void> 984 985取消当前的公共事件，仅对有序公共事件有效，取消后，公共事件不再向下一个订阅者传递（Promise形式）。 986 987**系统能力**：SystemCapability.Notification.CommonEvent 988 989**返回值：** 990 991| 类型 | 说明 | 992| ---------------- | -------------------- | 993| Promise\<void> | 返回一个Promise的结果。 | 994 995**示例：** 996 997```js 998var subscriber; //创建成功的订阅者对象 999 1000subscriber.abortCommonEvent().then(() => { 1001 console.info("abortCommonEvent"); 1002}).catch((err) => { 1003 console.error("abortCommonEvent failed " + JSON.stringify(err)); 1004}); 1005``` 1006 1007### clearAbortCommonEvent 1008 1009clearAbortCommonEvent(callback: AsyncCallback\<void>): void 1010 1011清除当前公共事件的取消状态，仅对有序公共事件有效（callback形式）。 1012 1013**系统能力**：SystemCapability.Notification.CommonEvent 1014 1015**参数：** 1016 1017| 参数名 | 类型 | 必填 | 描述 | 1018| -------- | -------------------- | ---- | -------------------- | 1019| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 | 1020 1021**示例：** 1022 1023```js 1024var subscriber; //创建成功的订阅者对象 1025 1026//清除当前公共事件取消状态的回调 1027function clearAbortCallback(err) { 1028 if (err.code) { 1029 console.error("clearAbortCommonEvent failed " + JSON.stringify(err)); 1030 } else { 1031 console.info("clearAbortCommonEvent"); 1032 } 1033} 1034subscriber.clearAbortCommonEvent(clearAbortCallback); 1035``` 1036 1037### clearAbortCommonEvent 1038 1039clearAbortCommonEvent(): Promise\<void> 1040 1041清除当前公共事件的取消状态，仅对有序公共事件有效（Promise形式）。 1042 1043**系统能力**：SystemCapability.Notification.CommonEvent 1044 1045**返回值：** 1046 1047| 类型 | 说明 | 1048| ---------------- | -------------------- | 1049| Promise\<void> | 返回一个Promise的结果。 | 1050 1051**示例：** 1052 1053```js 1054var subscriber; //创建成功的订阅者对象 1055 1056subscriber.clearAbortCommonEvent().then(() => { 1057 console.info("clearAbortCommonEvent"); 1058}).catch((err) => { 1059 console.error("clearAbortCommonEvent failed " + JSON.stringify(err)); 1060}); 1061``` 1062 1063### getAbortCommonEvent 1064 1065getAbortCommonEvent(callback: AsyncCallback\<boolean>): void 1066 1067获取当前有序公共事件是否取消的状态（callback形式）。 1068 1069**系统能力**：SystemCapability.Notification.CommonEvent 1070 1071**参数：** 1072 1073| 参数名 | 类型 | 必填 | 描述 | 1074| -------- | ----------------------- | ---- | ---------------------------------- | 1075| callback | AsyncCallback\<boolean> | 是 | 表示当前有序公共事件是否取消的状态。 | 1076 1077**示例：** 1078 1079```js 1080var subscriber; //创建成功的订阅者对象 1081 1082//获取当前有序公共事件是否取消的回调 1083function getAbortCallback(err, AbortCommonEvent) { 1084 if (err.code) { 1085 console.error("getAbortCommonEvent failed " + JSON.stringify(err)); 1086 } else { 1087 console.info("AbortCommonEvent " + AbortCommonEvent) 1088 } 1089} 1090subscriber.getAbortCommonEvent(getAbortCallback); 1091``` 1092 1093### getAbortCommonEvent 1094 1095getAbortCommonEvent(): Promise\<boolean> 1096 1097获取当前有序公共事件是否取消的状态（Promise形式）。 1098 1099**系统能力**：SystemCapability.Notification.CommonEvent 1100 1101**返回值：** 1102 1103| 类型 | 说明 | 1104| ----------------- | ---------------------------------- | 1105| Promise\<boolean> | 表示当前有序公共事件是否取消的状态。 | 1106 1107**示例：** 1108 1109```js 1110var subscriber; //创建成功的订阅者对象 1111 1112subscriber.getAbortCommonEvent().then((AbortCommonEvent) => { 1113 console.info("AbortCommonEvent " + JSON.stringify(AbortCommonEvent)); 1114}).catch((err) => { 1115 console.error("getAbortCommonEvent failed " + JSON.stringify(err)); 1116}); 1117``` 1118 1119### getSubscribeInfo 1120 1121getSubscribeInfo(callback: AsyncCallback\<CommonEventSubscribeInfo>): void 1122 1123获取订阅者的订阅信息（callback形式）。 1124 1125**系统能力**：SystemCapability.Notification.CommonEvent 1126 1127**参数：** 1128 1129| 参数名 | 类型 | 必填 | 描述 | 1130| -------- | ------------------------------------------------------------ | ---- | ---------------------- | 1131| callback | AsyncCallback\<[CommonEventSubscribeInfo](#commoneventsubscribeinfo)> | 是 | 表示订阅者的订阅信息。 | 1132 1133**示例：** 1134 1135```js 1136var subscriber; //创建成功的订阅者对象 1137 1138//获取订阅者信息回调 1139function getSubscribeInfoCallback(err, SubscribeInfo) { 1140 if (err.code) { 1141 console.error("getSubscribeInfo failed " + JSON.stringify(err)); 1142 } else { 1143 console.info("SubscribeInfo " + JSON.stringify(SubscribeInfo)); 1144 } 1145} 1146subscriber.getSubscribeInfo(getSubscribeInfoCallback); 1147``` 1148 1149### getSubscribeInfo 1150 1151getSubscribeInfo(): Promise\<CommonEventSubscribeInfo> 1152 1153获取订阅者的订阅信息（Promise形式）。 1154 1155**系统能力**：SystemCapability.Notification.CommonEvent 1156 1157**返回值：** 1158 1159| 类型 | 说明 | 1160| ------------------------------------------------------------ | ---------------------- | 1161| Promise\<[CommonEventSubscribeInfo](#commoneventsubscribeinfo)> | 表示订阅者的订阅信息。 | 1162 1163**示例：** 1164 1165```js 1166var subscriber; //创建成功的订阅者对象 1167 1168subscriber.getSubscribeInfo().then((SubscribeInfo) => { 1169 console.info("SubscribeInfo " + JSON.stringify(SubscribeInfo)); 1170}).catch((err) => { 1171 console.error("getSubscribeInfo failed " + JSON.stringify(err)); 1172}); 1173``` 1174 1175### finishCommonEvent<sup>9+</sup> 1176 1177finishCommonEvent(callback: AsyncCallback\<void>): void 1178 1179结束当前有序事件（callback形式）。 1180 1181**系统能力**：SystemCapability.Notification.CommonEvent 1182 1183**参数：** 1184 1185| 参数名 | 类型 | 必填 | 描述 | 1186| -------- | -------------------- | ---- | ---------------------- | 1187| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 | 1188 1189**示例：** 1190 1191```js 1192var subscriber; //创建成功的订阅者对象 1193 1194function finishCommonEventCallback() { 1195 console.log('finishCommonEvent'); 1196} 1197 1198subscriber.finishCommonEvent(finishCommonEventCallback); 1199``` 1200 1201### finishCommonEvent<sup>9+</sup> 1202 1203finishCommonEvent(): Promise\<void> 1204 1205结束当前有序事件（Promise形式）。 1206 1207**系统能力**：SystemCapability.Notification.CommonEvent 1208 1209**返回值：** 1210 1211| 类型 | 说明 | 1212| ---------------- | -------------------- | 1213| Promise\<void> | 返回一个Promise的结果。 | 1214 1215**示例：** 1216 1217```js 1218var subscriber; //创建成功的订阅者对象 1219 1220subscriber.finishCommonEvent().then(() => { 1221 console.log('finishCommonEvent'); 1222}).catch(() => { 1223 console.log('finishCommonEvent failed'); 1224}) 1225``` 1226 1227## CommonEventData 1228 1229**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent 1230 1231| 名称 | 读写属性 | 类型 | 必填 | 描述 | 1232| ---------- | -------- | -------------------- | ---- | ------------------------------------------------------- | 1233| event | 只读 | string | 是 | 表示当前接收的公共事件名称。 | 1234| bundleName | 只读 | string | 否 | 表示包名称。 | 1235| code | 只读 | number | 否 | 表示公共事件的结果代码，用于传递int类型的数据。 | 1236| data | 只读 | string | 否 | 表示公共事件的自定义结果数据，用于传递string类型的数据。 | 1237| parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息。 | 1238 1239 1240## CommonEventPublishData 1241 1242**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent 1243 1244| 名称 | 读写属性 | 类型 | 必填 | 描述 | 1245| --------------------- | -------- | -------------------- | ---- | ---------------------------- | 1246| bundleName | 只读 | string | 否 | 表示包名称。 | 1247| code | 只读 | number | 否 | 表示公共事件的结果代码。 | 1248| data | 只读 | string | 否 | 表示公共事件的自定义结果数据。 | 1249| subscriberPermissions | 只读 | Array\<string> | 否 | 表示订阅者的权限。 | 1250| isOrdered | 只读 | boolean | 否 | 表示是否是有序事件。 | 1251| isSticky | 只读 | boolean | 否 | 表示是否是粘性事件。 | 1252| parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息。 | 1253 1254## CommonEventSubscribeInfo 1255 1256**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent 1257 1258| 名称 | 读写属性 | 类型 | 必填 | 描述 | 1259| ------------------- | -------- | -------------- | ---- | ------------------------------------------------------------ | 1260| events | 只读 | Array\<string> | 是 | 表示要发送的公共事件。 | 1261| publisherPermission | 只读 | string | 否 | 表示发布者的权限。 | 1262| publisherDeviceId | 只读 | string | 否 | 表示设备ID，该值必须是同一ohos网络上的现有设备ID。 | 1263| userId | 只读 | number | 否 | 表示用户ID。此参数是可选的，默认值当前用户的ID。如果指定了此参数，则该值必须是系统中现有的用户ID。 | 1264| priority | 只读 | number | 否 | 表示订阅者的优先级。值的范围是-100到1000。 |
