1# CommonEvent模块(JS端SDK接口) 2 3#### 支持设备 4 5| API | 手机 | 平板 | 智慧屏 | 智能穿戴 | 轻量级智能穿戴 | 6| ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- | 7| CommonEvent.publish(event: string, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 8| CommonEvent.publish(event: string, options: CommonEventPublishData, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 9| CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback<CommonEventSubscriber>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 10| CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo) | 支持 | 支持 | 支持 | 支持 | 不支持 | 11| CommonEvent.subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback<CommonEventData>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 12| CommonEvent.unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 13 14#### 权限列表 15 16| 系统公共事件宏 | 系统公共事件名称 | 订阅者所需权限 | 17| ------------------------------------------------------------ | ----------------------------------------------------------- | ------------------------------------------------------------ | 18| COMMON_EVENT_BOOT_COMPLETED | usual.event.BOOT_COMPLETED | ohos.permission.RECEIVER_STARTUP_COMPLETED | 19| COMMON_EVENT_LOCKED_BOOT_COMPLETED | usual.event.LOCKED_BOOT_COMPLETED | ohos.permission.RECEIVER_STARTUP_COMPLETED | 20| COMMON_EVENT_SHUTDOWN | usual.event.SHUTDOWN | 无 | 21| COMMON_EVENT_BATTERY_CHANGED | usual.event.BATTERY_CHANGED | 无 | 22| COMMON_EVENT_BATTERY_LOW | usual.event.BATTERY_LOW | 无 | 23| COMMON_EVENT_BATTERY_OKAY | usual.event.BATTERY_OKAY | 无 | 24| COMMON_EVENT_POWER_CONNECTED | usual.event.POWER_CONNECTED | 无 | 25| COMMON_EVENT_POWER_DISCONNECTED | usual.event.POWER_DISCONNECTED | 无 | 26| COMMON_EVENT_SCREEN_OFF | usual.event.SCREEN_OFF | 无 | 27| COMMON_EVENT_SCREEN_ON | usual.event.SCREEN_ON | 无 | 28| COMMON_EVENT_USER_PRESENT | usual.event.USER_PRESENT | 无 | 29| COMMON_EVENT_TIME_TICK | usual.event.TIME_TICK | 无 | 30| COMMON_EVENT_TIME_CHANGED | usual.event.TIME_CHANGED | 无 | 31| COMMON_EVENT_DATE_CHANGED | usual.event.DATE_CHANGED | 无 | 32| COMMON_EVENT_TIMEZONE_CHANGED | usual.event.TIMEZONE_CHANGED | 无 | 33| COMMON_EVENT_CLOSE_SYSTEM_DIALOGS | usual.event.CLOSE_SYSTEM_DIALOGS | 无 | 34| COMMON_EVENT_PACKAGE_ADDED | usual.event.PACKAGE_ADDED | 无 | 35| COMMON_EVENT_PACKAGE_REPLACED | usual.event.PACKAGE_REPLACED | 无 | 36| COMMON_EVENT_MY_PACKAGE_REPLACED | usual.event.MY_PACKAGE_REPLACED | 无 | 37| COMMON_EVENT_PACKAGE_REMOVED | usual.event.PACKAGE_REMOVED | 无 | 38| COMMON_EVENT_PACKAGE_FULLY_REMOVED | usual.event.PACKAGE_FULLY_REMOVED | 无 | 39| COMMON_EVENT_PACKAGE_CHANGED | usual.event.PACKAGE_CHANGED | 无 | 40| COMMON_EVENT_PACKAGE_RESTARTED | usual.event.PACKAGE_RESTARTED | 无 | 41| COMMON_EVENT_PACKAGE_DATA_CLEARED | usual.event.PACKAGE_DATA_CLEARED | 无 | 42| COMMON_EVENT_PACKAGES_SUSPENDED | usual.event.PACKAGES_SUSPENDED | 无 | 43| COMMON_EVENT_PACKAGES_UNSUSPENDED | usual.event.PACKAGES_UNSUSPENDED | 无 | 44| COMMON_EVENT_MY_PACKAGE_SUSPENDED | usual.event.MY_PACKAGE_SUSPENDED | 无 | 45| COMMON_EVENT_MY_PACKAGE_UNSUSPENDED | usual.event.MY_PACKAGE_UNSUSPENDED | 无 | 46| COMMON_EVENT_UID_REMOVED | usual.event.UID_REMOVED | 无 | 47| COMMON_EVENT_PACKAGE_FIRST_LAUNCH | usual.event.PACKAGE_FIRST_LAUNCH | 无 | 48| COMMON_EVENT_PACKAGE_NEEDS_VERIFICATION | usual.event.PACKAGE_NEEDS_VERIFICATION | 无 | 49| COMMON_EVENT_PACKAGE_VERIFIED | usual.event.PACKAGE_VERIFIED | 无 | 50| COMMON_EVENT_EXTERNAL_APPLICATIONS_AVAILABLE | usual.event.EXTERNAL_APPLICATIONS_AVAILABLE | 无 | 51| COMMON_EVENT_EXTERNAL_APPLICATIONS_UNAVAILABLE | usual.event.EXTERNAL_APPLICATIONS_UNAVAILABLE | 无 | 52| COMMON_EVENT_CONFIGURATION_CHANGED | usual.event.CONFIGURATION_CHANGED | 无 | 53| COMMON_EVENT_LOCALE_CHANGED | usual.event.LOCALE_CHANGED | 无 | 54| COMMON_EVENT_MANAGE_PACKAGE_STORAGE | usual.event.MANAGE_PACKAGE_STORAGE | 无 | 55| COMMON_EVENT_DRIVE_MODE | common.event.DRIVE_MODE | 无 | 56| COMMON_EVENT_HOME_MODE | common.event.HOME_MODE | 无 | 57| COMMON_EVENT_OFFICE_MODE | common.event.OFFICE_MODE | 无 | 58| COMMON_EVENT_USER_STARTED | usual.event.USER_STARTED | 无 | 59| COMMON_EVENT_USER_BACKGROUND | usual.event.USER_BACKGROUND | 无 | 60| COMMON_EVENT_USER_FOREGROUND | usual.event.USER_FOREGROUND | 无 | 61| COMMON_EVENT_USER_SWITCHED | usual.event.USER_SWITCHED | ohos.permission.MANAGE_USERS | 62| COMMON_EVENT_USER_STARTING | usual.event.USER_STARTING | ohos.permission.INTERACT_ACROSS_USERS | 63| COMMON_EVENT_USER_UNLOCKED | usual.event.USER_UNLOCKED | 无 | 64| COMMON_EVENT_USER_STOPPING | usual.event.USER_STOPPING | ohos.permission.INTERACT_ACROSS_USERS | 65| COMMON_EVENT_USER_STOPPED | usual.event.USER_STOPPED | 无 | 66| COMMON_EVENT_HWID_LOGIN | common.event.HWID_LOGIN | 无 | 67| COMMON_EVENT_HWID_LOGOUT | common.event.HWID_LOGOUT | 无 | 68| COMMON_EVENT_HWID_TOKEN_INVALID | common.event.HWID_TOKEN_INVALID | 无 | 69| COMMON_EVENT_HWID_LOGOFF | common.event.HWID_LOGOFF | 无 | 70| COMMON_EVENT_WIFI_POWER_STATE | usual.event.wifi.POWER_STATE | 无 | 71| COMMON_EVENT_WIFI_SCAN_FINISHED | usual.event.wifi.SCAN_FINISHED | ohos.permission.LOCATION | 72| COMMON_EVENT_WIFI_RSSI_VALUE | usual.event.wifi.RSSI_VALUE | ohos.permission.GET_WIFI_INFO | 73| COMMON_EVENT_WIFI_CONN_STATE | usual.event.wifi.CONN_STATE | 无 | 74| COMMON_EVENT_WIFI_HOTSPOT_STATE | usual.event.wifi.HOTSPOT_STATE | 无 | 75| COMMON_EVENT_WIFI_AP_STA_JOIN | usual.event.wifi.WIFI_HS_STA_JOIN | ohos.permission.GET_WIFI_INFO | 76| COMMON_EVENT_WIFI_AP_STA_LEAVE | usual.event.wifi.WIFI_HS_STA_LEAVE | ohos.permission.GET_WIFI_INFO | 77| COMMON_EVENT_WIFI_MPLINK_STATE_CHANGE | usual.event.wifi.mplink.STATE_CHANGE | ohos.permission.MPLINK_CHANGE_STATE | 78| COMMON_EVENT_WIFI_P2P_CONN_STATE | usual.event.wifi.p2p.CONN_STATE_CHANGE | ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION | 79| COMMON_EVENT_WIFI_P2P_STATE_CHANGED | usual.event.wifi.p2p.STATE_CHANGE | ohos.permission.GET_WIFI_INFO | 80| COMMON_EVENT_WIFI_P2P_PEERS_STATE_CHANGED | usual.event.wifi.p2p.DEVICES_CHANGE | ohos.permission.GET_WIFI_INFO | 81| COMMON_EVENT_WIFI_P2P_PEERS_DISCOVERY_STATE_CHANGED | usual.event.wifi.p2p.PEER_DISCOVERY_STATE_CHANGE | ohos.permission.GET_WIFI_INFO | 82| COMMON_EVENT_WIFI_P2P_CURRENT_DEVICE_STATE_CHANGED | usual.event.wifi.p2p.CURRENT_DEVICE_CHANGE | ohos.permission.GET_WIFI_INFO | 83| COMMON_EVENT_WIFI_P2P_GROUP_STATE_CHANGED | usual.event.wifi.p2p.GROUP_STATE_CHANGED | ohos.permission.GET_WIFI_INFO | 84| COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_CONNECT_STATE_UPDATE | usual.event.bluetooth.handsfree.ag.CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | 85| COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_CURRENT_DEVICE_UPDATE | usual.event.bluetooth.handsfree.ag.CURRENT_DEVICE_UPDATE | ohos.permission.USE_BLUETOOTH | 86| COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_AUDIO_STATE_UPDATE | usual.event.bluetooth.handsfree.ag.AUDIO_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | 87| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CONNECT_STATE_UPDATE | usual.event.bluetooth.a2dpsource.CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | 88| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CURRENT_DEVICE_UPDATE | usual.event.bluetooth.a2dpsource.CURRENT_DEVICE_UPDATE | ohos.permission.USE_BLUETOOTH | 89| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_PLAYING_STATE_UPDATE | usual.event.bluetooth.a2dpsource.PLAYING_STATE_UPDATE" | ohos.permission.USE_BLUETOOTH | 90| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_AVRCP_CONNECT_STATE_UPDATE | usual.event.bluetooth.a2dpsource.AVRCP_CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | 91| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CODEC_VALUE_UPDATE | usual.event.bluetooth.a2dpsource.CODEC_VALUE_UPDATE | ohos.permission.USE_BLUETOOTH | 92| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_DISCOVERED | usual.event.bluetooth.remotedevice.DISCOVERED | ohos.permission.USE_BLUETOOTH and ohos.permission.LOCATION | 93| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CLASS_VALUE_UPDATE | usual.event.bluetooth.remotedevice.CLASS_VALUE_UPDATE | ohos.permission.USE_BLUETOOTH | 94| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_CONNECTED | usual.event.bluetooth.remotedevice.ACL_CONNECTED | ohos.permission.USE_BLUETOOTH | 95| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_DISCONNECTED | usual.event.bluetooth.remotedevice.ACL_DISCONNECTED | ohos.permission.USE_BLUETOOTH | 96| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_NAME_UPDATE | usual.event.bluetooth.remotedevice.NAME_UPDATE | ohos.permission.USE_BLUETOOTH | 97| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIR_STATE | usual.event.bluetooth.remotedevice.PAIR_STATE | ohos.permission.USE_BLUETOOTH | 98| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_BATTERY_VALUE_UPDATE | usual.event.bluetooth.remotedevice.BATTERY_VALUE_UPDATE | ohos.permission.USE_BLUETOOTH | 99| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_SDP_RESULT | usual.event.bluetooth.remotedevice.SDP_RESULT | 无 | 100| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_UUID_VALUE | usual.event.bluetooth.remotedevice.UUID_VALUE | ohos.permission.DISCOVER_BLUETOOTH | 101| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIRING_REQ | usual.event.bluetooth.remotedevice.PAIRING_REQ | ohos.permission.DISCOVER_BLUETOOTH | 102| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIRING_CANCEL | usual.event.bluetooth.remotedevice.PAIRING_CANCEL | 无 | 103| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_REQ | usual.event.bluetooth.remotedevice.CONNECT_REQ | 无 | 104| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_REPLY | usual.event.bluetooth.remotedevice.CONNECT_REPLY | 无 | 105| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_CANCEL | usual.event.bluetooth.remotedevice.CONNECT_CANCEL | 无 | 106| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_CONNECT_STATE_UPDATE | usual.event.bluetooth.handsfreeunit.CONNECT_STATE_UPDATE | 无 | 107| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AUDIO_STATE_UPDATE | usual.event.bluetooth.handsfreeunit.AUDIO_STATE_UPDATE | 无 | 108| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AG_COMMON_EVENT | usual.event.bluetooth.handsfreeunit.AG_COMMON_EVENT | 无 | 109| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AG_CALL_STATE_UPDATE | usual.event.bluetooth.handsfreeunit.AG_CALL_STATE_UPDATE | 无 | 110| COMMON_EVENT_BLUETOOTH_HOST_STATE_UPDATE | usual.event.bluetooth.host.STATE_UPDATE | 无 | 111| COMMON_EVENT_BLUETOOTH_HOST_REQ_DISCOVERABLE | usual.event.bluetooth.host.REQ_DISCOVERABLE | 无 | 112| COMMON_EVENT_BLUETOOTH_HOST_REQ_ENABLE | usual.event.bluetooth.host.REQ_ENABLE | ohos.permission.USE_BLUETOOTH | 113| COMMON_EVENT_BLUETOOTH_HOST_REQ_DISABLE | usual.event.bluetooth.host.REQ_DISABLE | ohos.permission.USE_BLUETOOTH | 114| COMMON_EVENT_BLUETOOTH_HOST_SCAN_MODE_UPDATE | usual.event.bluetooth.host.SCAN_MODE_UPDATE | ohos.permission.USE_BLUETOOTH | 115| COMMON_EVENT_BLUETOOTH_HOST_DISCOVERY_STARTED | usual.event.bluetooth.host.DISCOVERY_STARTED | ohos.permission.USE_BLUETOOTH | 116| COMMON_EVENT_BLUETOOTH_HOST_DISCOVERY_FINISHED | usual.event.bluetooth.host.DISCOVERY_FINISHED | ohos.permission.USE_BLUETOOTH | 117| COMMON_EVENT_BLUETOOTH_HOST_NAME_UPDATE | usual.event.bluetooth.host.NAME_UPDATE | ohos.permission.USE_BLUETOOTH | 118| COMMON_EVENT_BLUETOOTH_A2DPSINK_CONNECT_STATE_UPDATE | usual.event.bluetooth.a2dpsink.CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | 119| COMMON_EVENT_BLUETOOTH_A2DPSINK_PLAYING_STATE_UPDATE | usual.event.bluetooth.a2dpsink.PLAYING_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | 120| COMMON_EVENT_BLUETOOTH_A2DPSINK_AUDIO_STATE_UPDATE | usual.event.bluetooth.a2dpsink.AUDIO_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | 121| COMMON_EVENT_NFC_ACTION_ADAPTER_STATE_CHANGED | usual.event.nfc.action.ADAPTER_STATE_CHANGED | 无 | 122| COMMON_EVENT_NFC_ACTION_RF_FIELD_ON_DETECTED | usual.event.nfc.action.RF_FIELD_ON_DETECTED | ohos.permission.MANAGE_SECURE_SETTINGS | 123| COMMON_EVENT_NFC_ACTION_RF_FIELD_OFF_DETECTED | usual.event.nfc.action.RF_FIELD_OFF_DETECTED | ohos.permission.MANAGE_SECURE_SETTINGS | 124| COMMON_EVENT_DISCHARGING | usual.event.DISCHARGING | 无 | 125| COMMON_EVENT_CHARGING | usual.event.CHARGING | 无 | 126| COMMON_EVENT_DEVICE_IDLE_MODE_CHANGED | usual.event.DEVICE_IDLE_MODE_CHANGED | 无 | 127| COMMON_EVENT_POWER_SAVE_MODE_CHANGED | usual.event.POWER_SAVE_MODE_CHANGED | 无 | 128| COMMON_EVENT_USER_ADDED | usual.event.USER_ADDED | ohos.permission.MANAGE_USERS | 129| COMMON_EVENT_USER_REMOVED | usual.event.USER_REMOVED | ohos.permission.MANAGE_USERS | 130| COMMON_EVENT_ABILITY_ADDED | common.event.ABILITY_ADDED | ohos.permission.LISTEN_BUNDLE_CHANGE | 131| COMMON_EVENT_ABILITY_REMOVED | common.event.ABILITY_REMOVED | ohos.permission.LISTEN_BUNDLE_CHANGE | 132| COMMON_EVENT_ABILITY_UPDATED | common.event.ABILITY_UPDATED | ohos.permission.LISTEN_BUNDLE_CHANGE | 133| COMMON_EVENT_LOCATION_MODE_STATE_CHANGED | usual.event.location.MODE_STATE_CHANGED | 无 | 134| COMMON_EVENT_IVI_SLEEP | common.event.IVI_SLEEP | 无 | 135| COMMON_EVENT_IVI_PAUSE | common.event.IVI_PAUSE | 无 | 136| COMMON_EVENT_IVI_STANDBY | common.event.IVI_STANDBY | 无 | 137| COMMON_EVENT_IVI_LASTMODE_SAVE | common.event.IVI_LASTMODE_SAVE | 无 | 138| COMMON_EVENT_IVI_VOLTAGE_ABNORMAL | common.event.IVI_VOLTAGE_ABNORMAL | 无 | 139| COMMON_EVENT_IVI_HIGH_TEMPERATURE | common.event.IVI_HIGH_TEMPERATURE | 无 | 140| COMMON_EVENT_IVI_EXTREME_TEMPERATURE | common.event.IVI_EXTREME_TEMPERATURE | 无 | 141| COMMON_EVENT_IVI_TEMPERATURE_ABNORMAL | common.event.IVI_TEMPERATURE_ABNORMAL | 无 | 142| COMMON_EVENT_IVI_VOLTAGE_RECOVERY | common.event.IVI_VOLTAGE_RECOVERY | 无 | 143| COMMON_EVENT_IVI_TEMPERATURE_RECOVERY | common.event.IVI_TEMPERATURE_RECOVERY | 无 | 144| COMMON_EVENT_IVI_ACTIVE | common.event.IVI_ACTIVE | 无 | 145| COMMON_EVENT_USB_DEVICE_ATTACHED | usual.event.hardware.usb.action.USB_DEVICE_ATTACHED | 无 | 146| COMMON_EVENT_USB_DEVICE_DETACHED | usual.event.hardware.usb.action.USB_DEVICE_DETACHED | 无 | 147| COMMON_EVENT_USB_ACCESSORY_ATTACHED | usual.event.hardware.usb.action.USB_ACCESSORY_ATTACHED | 无 | 148| COMMON_EVENT_USB_ACCESSORY_DETACHED | usual.event.hardware.usb.action.USB_ACCESSORY_DETACHED | 无 | 149| COMMON_EVENT_DISK_REMOVED | usual.event.data.DISK_REMOVED | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE | 150| COMMON_EVENT_DISK_UNMOUNTED | usual.event.data.DISK_UNMOUNTED | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE | 151| COMMON_EVENT_DISK_MOUNTED | usual.event.data.DISK_MOUNTED | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE | 152| COMMON_EVENT_DISK_BAD_REMOVAL | usual.event.data.DISK_BAD_REMOVAL | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE | 153| COMMON_EVENT_DISK_UNMOUNTABLE | usual.event.data.DISK_UNMOUNTABLE | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE | 154| COMMON_EVENT_DISK_EJECT | usual.event.data.DISK_EJECT | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE | 155| COMMON_EVENT_VISIBLE_ACCOUNTS_UPDATED | usual.event.data.VISIBLE_ACCOUNTS_UPDATED | ohos.permission.GET_APP_ACCOUNTS | 156| COMMON_EVENT_ACCOUNT_DELETED | usual.event.data.ACCOUNT_DELETED | ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS | 157| COMMON_EVENT_FOUNDATION_READY | common.event.FOUNDATION_READY | ohos.permission.RECEIVER_STARTUP_COMPLETED | 158| COMMON_EVENT_AIRPLANE_MODE_CHANGED | usual.event.AIRPLANE_MODE | 无 | 159 160#### 导入模块 161 162```js 163import CommonEvent from '@ohos.commonevent'; 164``` 165 166 167 168#### CommonEvent.publish(event: string, callback: AsyncCallback<void>) 169 170- 接口说明 171 172 发布公共事件（callback形式） 173 174* publish参数描述 175 176 | 名称 | 读写属性 | 类型 | 必填 | 描述 | 177 | -------- | -------- | ------------------- | ---- | -------------------- | 178 | event | 只读 | string | 是 | 表示要发送的公共事件 | 179 | callback | 只读 | AsyncCallback<void> | 是 | 表示被指定的回调方法 | 180 181* 返回值 182 183 void 184 185* 示例 186 187```js 188//发布公共事件回调 189function PublishCallBack(err) { 190 console.info("==========================>PublishCallBack=======================>"); 191 console.info("==========================>err:=======================>", err.code); 192} 193//发布公共事件 194CommonEvent.publish("publish_event", PublishCallBack); 195``` 196 197 198 199#### CommonEvent.publish(event: string, options: CommonEventPublishData, callback: AsyncCallback<void>) 200 201- 接口说明 202 203 发布公共事件指定发布信息（callback形式） 204 205- publish参数描述 206 207 | 名称 | 读写属性 | 类型 | 必填 | 描述 | 208 | -------- | -------- | ---------------------- | ---- | ---------------------- | 209 | event | 只读 | string | 是 | 表示要发布的公共事件 | 210 | options | 只读 | CommonEventPublishData | 是 | 表示发布公共事件的属性 | 211 | callback | 只读 | AsyncCallback<void> | 是 | 表示被指定的回调方法 | 212 213- CommonEventPublishData类型说明 214 215 | 名称 | 读写属性 | 类型 | 必填 | 描述 | 216 | --------------------- | -------- | -------------------- | ---- | ---------------------------- | 217 | bundleName | 只读 | string | 否 | 表示包名称 | 218 | code | 只读 | int | 否 | 表示公共事件的结果代码 | 219 | data | 只读 | string | 否 | 表示公共事件的自定义结果数据 | 220 | subscriberPermissions | 只读 | Array<string> | 否 | 表示订阅者的权限 | 221 | isOrdered | 只读 | bool | 否 | 表示是否是有序事件 | 222 | parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息 | 223 224- 返回值 225 226 void 227 228- 示例 229 230```js 231//公共事件相关信息 232var options = { 233 code: 0; //公共事件的初始代码 234 data: "initial data";//公共事件的初始数据 235 isOrdered: true; //有序公共事件 236} 237//发布公共事件回调 238function PublishCallBack(err) { 239 console.info("==========================>PublishCallBack=======================>"); 240} 241//发布公共事件 242CommonEvent.publish("publish_event", options, PublishCallBack); 243``` 244 245 246 247#### CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback<CommonEventSubscriber>) 248 249- 接口说明 250 251 创建订阅者（callback形式） 252 253- createSubscriber参数描述 254 255 | 名称 | 读写属性 | 类型 | 必填 | 描述 | 256 | ------------- | -------- | ------------------------------------ | ---- | ------------------------ | 257 | subscribeInfo | 只读 | CommonEventSubscribeInfo | 是 | 表示订阅信息 | 258 | callback | 只读 | AsyncCallback<CommonEventSubscriber> | 是 | 表示创建订阅者的回调方法 | 259 260- CommonEventSubscriber 类说明 261 262 | 名称 | 参数 | 返回值 | 描述 | 263 | --------------------- | --------------------------------------------------------- | --------------------------------- | ------------------------------------------------------------ | 264 | getCode | callback: AsyncCallback<number> | void | 获取公共事件的结果代码（callback形式） | 265 | getCode | void | Promise<number> | 获取公共事件的结果代码（Promise形式） | 266 | setCode | code: number, callback: AsyncCallback<void> | void | 设置公共事件的结果代码（callback形式） | 267 | setCode | code: number | Promise<void> | 设置公共事件的结果代码（Promise形式） | 268 | getData | callback: AsyncCallback<string> | void | 获取公共事件的结果数据（callback形式） | 269 | getData | void | Promise<string> | 获取公共事件的结果数据（Promise形式） | 270 | setData | data: string, callback: AsyncCallback<void> | void | 设置公共事件的结果数据（callback形式） | 271 | setData | data: string | Promise<void> | 设置公共事件的结果数据（Promise形式） | 272 | setCodeAndData | code: number, data: string, callback: AsyncCallback<void> | void | 设置公共事件的结果代码和结果数据（callback形式） | 273 | setCodeAndData | code: number, data: string | Promise<void> | 设置公共事件的结果代码和结果数据（Promise形式） | 274 | isOrderedCommonEvent | callback: AsyncCallback<boolean> | void | 查询当前公共事件的是否为有序公共事件，返回true代表是有序公共事件，false代表不是有序公共事件（callback形式） | 275 | isOrderedCommonEvent | void | Promise<bool> | 查询当前公共事件的是否为有序公共事件，返回true代表是有序公共事件，false代表不是有序公共事件（Promise形式） | 276 | abortCommonEvent | callback: AsyncCallback<void> | void | 取消当前的公共事件，仅对有序公共事件有效，取消后，公共事件不再向下一个订阅者传递（callback形式） | 277 | abortCommonEvent | void | Promise<void> | 取消当前的公共事件，仅对有序公共事件有效，取消后，公共事件不再向下一个订阅者传递（Promise形式） | 278 | clearAbortCommonEvent | callback: AsyncCallback<void> | void | 清除当前有序公共事件abort状态（callback形式） | 279 | clearAbortCommonEvent | void | Promise<void> | 清除当前有序公共事件abort状态（Promise形式） | 280 | getAbortCommonEvent | callback: AsyncCallback<boolean> | void | 获取当前有序公共事件是否取消的状态（callback形式） | 281 | getAbortCommonEvent | void | Promise<boolean> | 获取当前有序公共事件是否取消的状态Promise形式） | 282 | getSubscribeInfo | callback: AsyncCallback<CommonEventSubscribeInfo> | void | 获取订阅者的订阅信息（callback形式） | 283 | getSubscribeInfo | void | Promise<CommonEventSubscribeInfo> | 获取订阅者的订阅信息（Promise形式） | 284 285- CommonEventSubscribeInfo类型说明 286 287 | 名称 | 读写属性 | 类型 | 必填 | 描述 | 288 | ------------------- | -------- | ------------- | ---- | ------------------------------------------------------------ | 289 | events | 只读 | Array<string> | 是 | 表示要订阅的公共事件 | 290 | publisherPermission | 只读 | string | 否 | 表示发布者的权限 | 291 | publisherDeviceId | 只读 | int | 否 | 表示设备ID，该值必须是同一ohos网络上的现有设备ID | 292 | userId | 只读 | int | 否 | 表示用户ID。此参数是可选的，默认值当前用户的ID。如果指定了此参数，则该值必须是系统中现有的用户ID。 | 293 | priority | 只读 | int | 否 | 表示订阅者的优先级，范围为-100~1000。 | 294 295- 返回值 296 297 void 298 299- 示例 300 301```js 302var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 303//订阅者信息 304var subscribeInfo = { 305 events: ["event"] 306}; 307//创建订阅者回调 308function CreateSubscriberCallBack(err, data) { 309 console.info("==========================>CreateSubscriberCallBack=======================>"); 310 subscriber = data; 311} 312//创建订阅者 313CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack); 314``` 315 316 317 318#### CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo) 319 320- 接口说明 321 322 创建订阅者（Promise形式） 323 324- createSubscriber参数描述 325 326 | 名称 | 读写属性 | 类型 | 必填 | 描述 | 327 | ------------- | -------- | ------------------------ | ---- | ------------ | 328 | subscribeInfo | 只读 | CommonEventSubscribeInfo | 是 | 表示订阅信息 | 329 330- CommonEventSubscribeInfo类型说明 331 332 | 名称 | 读写属性 | 类型 | 必填 | 描述 | 333 | ------------------- | -------- | ------------- | ---- | ------------------------------------------------------------ | 334 | events | 只读 | Array<string> | 是 | 表示要发送的公共事件 | 335 | publisherPermission | 只读 | string | 否 | 表示发布者的权限 | 336 | publisherDeviceId | 只读 | int | 否 | 表示设备ID，该值必须是同一ohos网络上的现有设备ID | 337 | userId | 只读 | int | 否 | 表示用户ID。此参数是可选的，默认值当前用户的ID。如果指定了此参数，则该值必须是系统中现有的用户ID。 | 338 | priority | 只读 | int | 否 | 表示订阅者的优先级。值的范围是-100到1000 | 339 340- 返回值 341 342 Promise<CommonEventSubscriber> 343 344- 示例 345 346```js 347var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 348//订阅者信息 349var subscribeInfo = { 350 events: ["event"] 351}; 352//创建订阅者 353CommonEvent.createSubscriber(subscribeInfo).then((data) => { 354 console.info("==========================>createSubscriberPromise=======================>"); 355 subscriber = data; 356}); 357``` 358 359 360 361#### CommonEvent.subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback<CommonEventData>) 362 363- 接口说明 364 365 订阅公共事件（callback形式） 366 367- subscribe参数描述 368 369 | 名称 | 读写属性 | 类型 | 必填 | 描述 | 370 | ---------- | -------- | ------------------------------ | ---- | ------------------------------ | 371 | subscriber | 只读 | CommonEventSubscriber | 是 | 表示订阅者对象 | 372 | callback | 只读 | AsyncCallback<CommonEventData> | 是 | 表示接收公共事件数据的回调函数 | 373 374- CommonEventData类型说明 375 376 | 名称 | 读写属性 | 类型 | 必填 | 描述 | 377 | ---------- | -------- | -------------------- | ---- | ------------------------------------------------------- | 378 | event | 只读 | string | 是 | 表示当前接收的公共事件名称 | 379 | bundleName | 只读 | string | 否 | 表示包名称 | 380 | code | 只读 | int | 否 | 表示公共事件的结果代码，用于传递int类型的数据 | 381 | data | 只读 | string | 否 | 表示公共事件的自定义结果数据，用于传递string 类型的数据 | 382 | parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息 | 383 384- 返回值 385 386 void 387 388- 示例 389 390 * 无序事件： 391 392 ```js 393 var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 394 //订阅者信息 395 var subscribeInfo = { 396 events: ["event"] 397 }; 398 //订阅公共事件回调 399 function SubscribeCallBack(err, data) { 400 console.info("==========================>SubscribeCallBack=======================>"); 401 } 402 //创建订阅者回调 403 function CreateSubscriberCallBack(err, data) { 404 console.info("==========================>CreateSubscriberCallBack=======================>"); 405 subscriber = data; 406 //订阅公共事件 407 CommonEvent.subscribe(subscriber, SubscribeCallBack); 408 } 409 //创建订阅者 410 CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack); 411 ``` 412 413 * 有序事件 414 415 ```js 416 var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 417 //订阅者信息 418 var subscribeInfo = { 419 events: ["event"] 420 }; 421 422 //设置有序公共事件的结果代码回调 423 function SetCodeCallBack(err) { 424 console.info("==========================>SetCodeCallBack=======================>"); 425 } 426 //设置有序公共事件的结果数据回调 427 function SetDataCallBack(err) { 428 console.info("==========================>SetDataCallBack=======================>"); 429 } 430 //完成本次有序公共事件处理回调 431 function FinishCommonEventCallBack(err) { 432 console.info("==========================>FinishCommonEventCallBack=======================>"); 433 } 434 //订阅公共事件回调 435 function SubscribeCallBack(err, data) { 436 console.info("==========================>SubscribeCallBack=======================>"); 437 //设置有序公共事件的结果代码 438 subscriber.setCode(0, SetCodeCallBack); 439 //设置有序公共事件的结果数据 440 subscriber.setData("publish_data_changed", SetDataCallBack); 441 //完成本次有序公共事件处理 442 subscriber.finishCommonEvent(FinishCommonEventCallBack) 443 } 444 445 //创建订阅者回调 446 function CreateSubscriberCallBack(err, data) { 447 console.info("==========================>CreateSubscriberCallBack=======================>"); 448 subscriber = data; 449 //订阅公共事件 450 CommonEvent.subscribe(subscriber, SubscribeCallBack); 451 } 452 453 //创建订阅者 454 CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack); 455 ``` 456 457 458 459#### CommonEvent.unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback<void>) 460 461- 接口说明 462 463 取消订阅公共事件（callback形式） 464 465- unsubscribe参数描述 466 467 | 名称 | 读写属性 | 类型 | 必填 | 描述 | 468 | ---------- | -------- | --------------------- | ---- | ---------------------- | 469 | subscriber | 只读 | CommonEventSubscriber | 是 | 表示订阅者对象 | 470 | callback | 只读 | AsyncCallback<void> | 是 | 表示取消订阅的回调方法 | 471 472- 返回值 473 474 void 475 476- 示例 477 478```js 479var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 480//订阅者信息 481var subscribeInfo = { 482 events: ["event"] 483}; 484//订阅公共事件回调 485function SubscribeCallBack(err, data) { 486 console.info("==========================>SubscribeCallBack=======================>"); 487} 488//创建订阅者回调 489function CreateSubscriberCallBack(err, data) { 490 console.info("==========================>CreateSubscriberCallBack=======================>"); 491 subscriber = data; 492 //订阅公共事件 493 CommonEvent.subscribe(subscriber, SubscribeCallBack); 494} 495//取消订阅公共事件回调 496function UnsubscribeCallBack(err) { 497 console.info("==========================>UnsubscribeCallBack=======================>"); 498} 499//创建订阅者 500CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack); 501//取消订阅公共事件 502CommonEvent.unsubscribe(subscriber, UnsubscribeCallBack); 503``` 504 505 506 507 508 509