Skip to content

D
Docs

OpenHarmony / Docs
大约 1 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs
切换分支/标签
查找文件 普通视图历史永久链接Permalink
js-apis-commonEvent.md 62.7 KB
Newer Older
X
Update js-apis  
xuchenghua09 已提交
1 2 
# 公共事件模块
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
3 
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
Z
update docs  
zengyawen 已提交
4 
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
X
Update js-apis  
xuchenghua09 已提交
5
Z
fix: fix required permissions  
zengsiyu 已提交
6 
## 权限列表
X
Update js-apis  
xuchenghua09 已提交
7
Z
update docs  
zengyawen 已提交
8 9 
| 系统公共事件宏      | 系统公共事件名称          | 订阅者所需权限     |
| ------------ | ------------------ | ---------------------- |
X
Update js-apis  
xuchenghua09 已提交
10 
| COMMON_EVENT_BOOT_COMPLETED                                  | usual.event.BOOT_COMPLETED                                  | ohos.permission.RECEIVER_STARTUP_COMPLETED                   |
X
Fix issue of unmatched content between dts files and md files  
xuzhihao 已提交
11 
| COMMON_EVENT_LOCKED_BOOT_COMPLETED                           | usual.event.LOCKED_BOOT_COMPLETED                           | ohos.permission.RECEIVER_STARTUP_COMPLETED                   |
X
Update js-apis  
xuchenghua09 已提交
12 13 14 15 16 17 18 19 
| 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                                       | 无                                                           |
X
Fix issue of unmatched content between dts files and md files  
xuzhihao 已提交
20 
| COMMON_EVENT_THERMAL_LEVEL_CHANGED                           | usual.event.THERMAL_LEVEL_CHANGED                           | 无                                                           |
X
Update js-apis  
xuchenghua09 已提交
21 22 23 24 25 26 27 28 29 30 
| 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                                 | 无                                                           |
Z
fix: sync support with d.ts  
zengsiyu 已提交
31 
| COMMON_EVENT_BUNDLE_REMOVED                                  | usual.event.BUNDLE_REMOVED                                  | 无                                                           |
X
Update js-apis  
xuchenghua09 已提交
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 
| 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                                 |
X
Fix issue of unmatched content between dts files and md files  
xuzhihao 已提交
56 
| COMMON_EVENT_USER_STARTING                                   | usual.event.USER_STARTING                                   | ohos.permission.INTERACT_ACROSS_USERS                        |
X
Update js-apis  
xuchenghua09 已提交
57 
| COMMON_EVENT_USER_UNLOCKED                                   | usual.event.USER_UNLOCKED                                   | 无                                                           |
X
Fix issue of unmatched content between dts files and md files  
xuzhihao 已提交
58 
| COMMON_EVENT_USER_STOPPING                                   | usual.event.USER_STOPPING                                   | ohos.permission.INTERACT_ACROSS_USERS                        |
X
Update js-apis  
xuchenghua09 已提交
59 60 61 62 63 64 65 66 67 68 69 70 
| 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                                |
X
Fix issue of unmatched content between dts files and md files  
xuzhihao 已提交
71 
| COMMON_EVENT_WIFI_MPLINK_STATE_CHANGE                        | usual.event.wifi.mplink.STATE_CHANGE                        | ohos.permission.MPLINK_CHANGE_STATE                          |
X
Update js-apis  
xuchenghua09 已提交
72 73 74 75 76 77 
| 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                                |
X
Fix issue of unmatched content between dts files and md files  
xuzhihao 已提交
78 79 80 81 82 83 
| COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_CONNECT_STATE_UPDATE     | usual.event.bluetooth.handsfree.ag.CONNECT_STATE_UPDATE     | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_CURRENT_DEVICE_UPDATE    | usual.event.bluetooth.handsfree.ag.CURRENT_DEVICE_UPDATE    | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_AUDIO_STATE_UPDATE       | usual.event.bluetooth.handsfree.ag.AUDIO_STATE_UPDATE       | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CONNECT_STATE_UPDATE       | usual.event.bluetooth.a2dpsource.CONNECT_STATE_UPDATE       | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CURRENT_DEVICE_UPDATE      | usual.event.bluetooth.a2dpsource.CURRENT_DEVICE_UPDATE      | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_PLAYING_STATE_UPDATE       | usual.event.bluetooth.a2dpsource.PLAYING_STATE_UPDATE       | ohos.permission.USE_BLUETOOTH                                |
X
Update js-apis  
xuchenghua09 已提交
84 
| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_AVRCP_CONNECT_STATE_UPDATE | usual.event.bluetooth.a2dpsource.AVRCP_CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH                                |
X
Fix issue of unmatched content between dts files and md files  
xuzhihao 已提交
85 
| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CODEC_VALUE_UPDATE         | usual.event.bluetooth.a2dpsource.CODEC_VALUE_UPDATE         | ohos.permission.USE_BLUETOOTH                                |
Z
fix: sync support with d.ts  
zengsiyu 已提交
86 
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_DISCOVERED               | usual.event.bluetooth.remotedevice.DISCOVERED               | ohos.permission.LOCATION and ohos.permission.USE_BLUETOOTH   |
X
Fix issue of unmatched content between dts files and md files  
xuzhihao 已提交
87 88 89 90 91 92 
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CLASS_VALUE_UPDATE       | usual.event.bluetooth.remotedevice.CLASS_VALUE_UPDATE       | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_CONNECTED            | usual.event.bluetooth.remotedevice.ACL_CONNECTED            | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_DISCONNECTED         | usual.event.bluetooth.remotedevice.ACL_DISCONNECTED         | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_NAME_UPDATE              | usual.event.bluetooth.remotedevice.NAME_UPDATE              | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIR_STATE               | usual.event.bluetooth.remotedevice.PAIR_STATE               | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_BATTERY_VALUE_UPDATE     | usual.event.bluetooth.remotedevice.BATTERY_VALUE_UPDATE     | ohos.permission.USE_BLUETOOTH                                |
X
Update js-apis  
xuchenghua09 已提交
93 
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_SDP_RESULT               | usual.event.bluetooth.remotedevice.SDP_RESULT               | 无                                                           |
X
Fix issue of unmatched content between dts files and md files  
xuzhihao 已提交
94 95 
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_UUID_VALUE               | usual.event.bluetooth.remotedevice.UUID_VALUE               | ohos.permission.DISCOVER_BLUETOOTH                           |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIRING_REQ              | usual.event.bluetooth.remotedevice.PAIRING_REQ              | ohos.permission.DISCOVER_BLUETOOTH                           |
X
Update js-apis  
xuchenghua09 已提交
96 97 98 99 100 101 102 103 
| 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    | 无                                                           |
X
Fix issue of unmatched content between dts files and md files  
xuzhihao 已提交
104 
| COMMON_EVENT_BLUETOOTH_HOST_STATE_UPDATE                     | usual.event.bluetooth.host.STATE_UPDATE                     | ohos.permission.USE_BLUETOOTH                                |
X
Update js-apis  
xuchenghua09 已提交
105 
| COMMON_EVENT_BLUETOOTH_HOST_REQ_DISCOVERABLE                 | usual.event.bluetooth.host.REQ_DISCOVERABLE                 | 无                                                           |
X
Fix issue of unmatched content between dts files and md files  
xuzhihao 已提交
106 107 108 109 110 111 112 113 114 
| COMMON_EVENT_BLUETOOTH_HOST_REQ_ENABLE                       | usual.event.bluetooth.host.REQ_ENABLE                       | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_HOST_REQ_DISABLE                      | usual.event.bluetooth.host.REQ_DISABLE                      | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_HOST_SCAN_MODE_UPDATE                 | usual.event.bluetooth.host.SCAN_MODE_UPDATE                 | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_HOST_DISCOVERY_STARTED                | usual.event.bluetooth.host.DISCOVERY_STARTED                | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_HOST_DISCOVERY_FINISHED               | usual.event.bluetooth.host.DISCOVERY_FINISHED               | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_HOST_NAME_UPDATE                      | usual.event.bluetooth.host.NAME_UPDATE                      | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_A2DPSINK_CONNECT_STATE_UPDATE         | usual.event.bluetooth.a2dpsink.CONNECT_STATE_UPDATE         | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_A2DPSINK_PLAYING_STATE_UPDATE         | usual.event.bluetooth.a2dpsink.PLAYING_STATE_UPDATE         | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_A2DPSINK_AUDIO_STATE_UPDATE           | usual.event.bluetooth.a2dpsink.AUDIO_STATE_UPDATE           | ohos.permission.USE_BLUETOOTH                                |
X
Update js-apis  
xuchenghua09 已提交
115 
| COMMON_EVENT_NFC_ACTION_ADAPTER_STATE_CHANGED                | usual.event.nfc.action.ADAPTER_STATE_CHANGED                | 无                                                           |
X
Fix issue of unmatched content between dts files and md files  
xuzhihao 已提交
116 117 
| COMMON_EVENT_NFC_ACTION_RF_FIELD_ON_DETECTED                 | usual.event.nfc.action.RF_FIELD_ON_DETECTED                 | ohos.permission.MANAGE_SECURE_SETTINGS                       |
| COMMON_EVENT_NFC_ACTION_RF_FIELD_OFF_DETECTED                | usual.event.nfc.action.RF_FIELD_OFF_DETECTED                | ohos.permission.MANAGE_SECURE_SETTINGS                       |
X
Update js-apis  
xuchenghua09 已提交
118 119 120 121 122 123 
| 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                                 |
X
Fix issue of unmatched content between dts files and md files  
xuzhihao 已提交
124 125 126 
| COMMON_EVENT_ABILITY_ADDED                                   | usual.event.ABILITY_ADDED                                   | ohos.permission.LISTEN_BUNDLE_CHANGE                         |
| COMMON_EVENT_ABILITY_REMOVED                                 | usual.event.ABILITY_REMOVED                                 | ohos.permission.LISTEN_BUNDLE_CHANGE                         |
| COMMON_EVENT_ABILITY_UPDATED                                 | usual.event.ABILITY_UPDATED                                 | ohos.permission.LISTEN_BUNDLE_CHANGE                         |
X
Update js-apis  
xuchenghua09 已提交
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 
| 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
update docs  
zengyawen 已提交
143 144 145 146 
| 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 |
X
Fix issue of unmatched content between dts files and md files  
xuzhihao 已提交
147 
| COMMON_EVENT_DISK_UNMOUNTABLE                                | usual.event.data.DISK_UNMOUNTABLE                           | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE |
Z
update docs  
zengyawen 已提交
148 
| COMMON_EVENT_DISK_EJECT                                      | usual.event.data.DISK_EJECT                                 | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE |
X
Fix issue of unmatched content between dts files and md files  
xuzhihao 已提交
149 150 151 152 153 154 155 156 
| COMMON_EVENT_VOLUME_REMOVED                                  | usual.event.data.VOLUME_REMOVED                             | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_VOLUME_UNMOUNTED                                | usual.event.data.VOLUME_UNMOUNTED                           | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_VOLUME_MOUNTED                                  | usual.event.data.VOLUME_MOUNTED                             | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_VOLUME_BAD_REMOVAL                              | usual.event.data.VOLUME_BAD_REMOVAL                         | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_VOLUME_EJECT                                    | usual.event.data.VOLUME_EJECT                               | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_VISIBLE_ACCOUNTS_UPDATED                        | usual.event.data.VISIBLE_ACCOUNTS_UPDATED                   | ohos.permission.GET_APP_ACCOUNTS                             |
| COMMON_EVENT_ACCOUNT_DELETED                                 | usual.event.data.ACCOUNT_DELETED                            | ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS               |
| COMMON_EVENT_FOUNDATION_READY                                | usual.event.data.FOUNDATION_READY                           | ohos.permission.RECEIVER_STARTUP_COMPLETED                   |
X
Update js-apis  
xuchenghua09 已提交
157 
| COMMON_EVENT_AIRPLANE_MODE_CHANGED                           | usual.event.AIRPLANE_MODE                                   | 无                                                           |
X
Fix issue of unmatched content between dts files and md files  
xuzhihao 已提交
158 
| COMMON_EVENT_SPLIT_SCREEN                                    | usual.event.SPLIT_SCREEN                                    | ohos.permission.RECEIVER_SPLIT_SCREEN                        |
X
Update js-apis  
xuchenghua09 已提交
159 160 161 162 

## 导入模块

```js
Z
reformat  
zengsiyu 已提交
163 
import CommonEvent from '@ohos.commonEvent';
X
Update js-apis  
xuchenghua09 已提交
164 165 
```
Z
update docs  
zengyawen 已提交
166 
## CommonEvent.publish
X
Update js-apis  
xuchenghua09 已提交
167
Z
update docs  
zengyawen 已提交
168 
publish(event: string, callback: AsyncCallback\<void>): void
X
Update js-apis  
xuchenghua09 已提交
169
Z
update docs  
zengyawen 已提交
170 
发布公共事件（callback形式）。
X
Update js-apis  
xuchenghua09 已提交
171
Z
remove ordered common event examples  
zengsiyu 已提交
172 
**系统能力：** SystemCapability.Notification.CommonEvent
Z
fix: update commonevent  
zengsiyu 已提交
173
Z
update docs  
zengyawen 已提交
174 
**参数：**
X
Update js-apis  
xuchenghua09 已提交
175
Z
update docs  
zengyawen 已提交
176 177 178 179 
| 名称     | 读写属性 | 类型                 | 必填 | 描述                   |
| -------- | -------- | -------------------- | ---- | ---------------------- |
| event    | 只读     | string               | 是   | 表示要发送的公共事件。 |
| callback | 只读     | AsyncCallback\<void> | 是   | 表示被指定的回调方法。 |
X
Update js-apis  
xuchenghua09 已提交
180
Z
update docs  
zengyawen 已提交
181 
**示例：**
X
Update js-apis  
xuchenghua09 已提交
182 183 184 185 

```js
//发布公共事件回调
function PublishCallBack(err) {
Z
fix: update commonevent  
zengsiyu 已提交
186 187 188 189 190 
	if (err.code) {
        console.error("publish failed " + JSON.stringify(err));
    } else {
        console.info("publish");
    }
X
Update js-apis  
xuchenghua09 已提交
191 
}
Z
fix: update commonevent  
zengsiyu 已提交
192
X
Update js-apis  
xuchenghua09 已提交
193 
//发布公共事件
Z
fix: update commonevent  
zengsiyu 已提交
194 
CommonEvent.publish("event", PublishCallBack);
X
Update js-apis  
xuchenghua09 已提交
195 196 197 198 
```
Z
update docs  
zengyawen 已提交
199 
## CommonEvent.publish
X
Update js-apis  
xuchenghua09 已提交
200
Z
update docs  
zengyawen 已提交
201 
publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\<void>): void
X
Update js-apis  
xuchenghua09 已提交
202
Z
update docs  
zengyawen 已提交
203 
发布公共事件指定发布信息（callback形式）。
X
Update js-apis  
xuchenghua09 已提交
204
Z
remove ordered common event examples  
zengsiyu 已提交
205 
**系统能力：** SystemCapability.Notification.CommonEvent
Z
fix: update commonevent  
zengsiyu 已提交
206
Z
update docs  
zengyawen 已提交
207 
**参数：**
X
Update js-apis  
xuchenghua09 已提交
208
Z
update docs  
zengyawen 已提交
209 210 211 
| 名称     | 读写属性 | 类型                   | 必填 | 描述                   |
| -------- | -------- | ---------------------- | ---- | ---------------------- |
| event    | 只读     | string                 | 是   | 表示要发布的公共事件。  |
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
212 
| options  | 只读     | [CommonEventPublishData](#commoneventpublishdata) | 是   | 表示发布公共事件的属性。 |
Z
update docs  
zengyawen 已提交
213 
| callback | 只读     | AsyncCallback\<void>   | 是   | 表示被指定的回调方法。  |
X
Update js-apis  
xuchenghua09 已提交
214
Z
update docs  
zengyawen 已提交
215 
**示例：**
X
Update js-apis  
xuchenghua09 已提交
216 217 218 219 220 


```js
//公共事件相关信息
var options = {
L
update zh-cn/application-dev/reference/apis/js-apis-commonEvent.md.  
LiAn 已提交
221 222 223 
	code: 0,			 //公共事件的初始代码
	data: "initial data",//公共事件的初始数据
	isOrdered: true	 //有序公共事件
X
Update js-apis  
xuchenghua09 已提交
224 
}
Z
fix: update commonevent  
zengsiyu 已提交
225
X
Update js-apis  
xuchenghua09 已提交
226 227 
//发布公共事件回调
function PublishCallBack(err) {
Z
fix: update commonevent  
zengsiyu 已提交
228 229 230 231 232 
	if (err.code) {
        console.error("publish failed " + JSON.stringify(err));
    } else {
        console.info("publish");
    }
X
Update js-apis  
xuchenghua09 已提交
233 
}
Z
fix: update commonevent  
zengsiyu 已提交
234
X
Update js-apis  
xuchenghua09 已提交
235 
//发布公共事件
Z
fix: update commonevent  
zengsiyu 已提交
236 
CommonEvent.publish("event", options, PublishCallBack);
X
Update js-apis  
xuchenghua09 已提交
237 238 239 240 
```
X
Fix issue of unmatched content between dts files and md files  
xuzhihao 已提交
241 
## CommonEvent.publishAsUser<sup>8+</sup>
Z
reformat  
zengsiyu 已提交
242 243 244 245 246 

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

向指定用户发布公共事件（callback形式）。
Z
remove ordered common event examples  
zengsiyu 已提交
247 
**系统能力：** SystemCapability.Notification.CommonEvent
Z
fix: update commonevent  
zengsiyu 已提交
248
X
Add sysapi description && fix issues of emnu values`  
xuzhihao 已提交
249 250 
**系统API**：此接口为系统接口，三方应用不支持调用。
Z
reformat  
zengsiyu 已提交
251 252 253 254 255 256 257 258 259 260 261 262 263 264 
**参数：**

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

**示例：**

```js
//发布公共事件回调
function PublishAsUserCallBack(err) {
	if (err.code) {
Z
fix: update commonevent  
zengsiyu 已提交
265 
        console.error("publishAsUser failed " + JSON.stringify(err));
Z
reformat  
zengsiyu 已提交
266 267 268 269 
    } else {
        console.info("publishAsUser");
    }
}
Z
fix: update commonevent  
zengsiyu 已提交
270
Z
reformat  
zengsiyu 已提交
271 272 
//指定发送的用户
var userId = 100;
Z
fix: update commonevent  
zengsiyu 已提交
273
Z
reformat  
zengsiyu 已提交
274 
//发布公共事件
Z
fix: update commonevent  
zengsiyu 已提交
275 
CommonEvent.publishAsUser("event", userId, PublishAsUserCallBack);
Z
reformat  
zengsiyu 已提交
276 277 278 279 
```
X
Fix issue of unmatched content between dts files and md files  
xuzhihao 已提交
280 
## CommonEvent.publishAsUser<sup>8+</sup>
Z
reformat  
zengsiyu 已提交
281 282 283 284 285 

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

向指定用户发布公共事件并指定发布信息（callback形式）。
Z
remove ordered common event examples  
zengsiyu 已提交
286 
**系统能力：** SystemCapability.Notification.CommonEvent
Z
fix: update commonevent  
zengsiyu 已提交
287
X
Add sysapi description && fix issues of emnu values`  
xuzhihao 已提交
288 289 
**系统API**：此接口为系统接口，三方应用不支持调用。
Z
reformat  
zengsiyu 已提交
290 291 292 293 294 295 
**参数：**

| 名称     | 读写属性 | 类型                   | 必填 | 描述                   |
| -------- | -------- | ---------------------- | ---- | ---------------------- |
| event    | 只读     | string                 | 是   | 表示要发布的公共事件。  |
| userId | 只读 | number | 是 | 表示指定向该用户ID发送此公共事件。 |
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
296 
| options  | 只读     | [CommonEventPublishData](#commoneventpublishdata) | 是   | 表示发布公共事件的属性。 |
Z
reformat  
zengsiyu 已提交
297 298 299 300 301 302 303 304 
| callback | 只读     | AsyncCallback\<void>   | 是   | 表示被指定的回调方法。  |

**示例：**


```js
//公共事件相关信息
var options = {
X
api文档修改  
xuezhongzhu 已提交
305 306 
	code: 0,			 //公共事件的初始代码
	data: "initial data",//公共事件的初始数据
Z
reformat  
zengsiyu 已提交
307 
}
Z
fix: update commonevent  
zengsiyu 已提交
308
Z
reformat  
zengsiyu 已提交
309 310 311 
//发布公共事件回调
function PublishAsUserCallBack(err) {
	if (err.code) {
Z
fix: update commonevent  
zengsiyu 已提交
312 
        console.error("publishAsUser failed " + JSON.stringify(err));
Z
reformat  
zengsiyu 已提交
313 314 315 316 
    } else {
        console.info("publishAsUser");
    }
}
Z
fix: update commonevent  
zengsiyu 已提交
317
Z
reformat  
zengsiyu 已提交
318 319 
//指定发送的用户
var userId = 100;
Z
fix: update commonevent  
zengsiyu 已提交
320
Z
reformat  
zengsiyu 已提交
321 
//发布公共事件
Z
fix: update commonevent  
zengsiyu 已提交
322 
CommonEvent.publishAsUser("event", userId, options, PublishAsUserCallBack);
Z
reformat  
zengsiyu 已提交
323 324 325 326 
```
Z
update docs  
zengyawen 已提交
327 
## CommonEvent.createSubscriber
X
Update js-apis  
xuchenghua09 已提交
328
Z
update docs  
zengyawen 已提交
329 
createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback\<CommonEventSubscriber>): void
X
Update js-apis  
xuchenghua09 已提交
330
Z
update docs  
zengyawen 已提交
331 
创建订阅者（callback形式）。
X
Update js-apis  
xuchenghua09 已提交
332
Z
remove ordered common event examples  
zengsiyu 已提交
333 
**系统能力：** SystemCapability.Notification.CommonEvent
Z
fix: update commonevent  
zengsiyu 已提交
334
Z
update docs  
zengyawen 已提交
335 
**参数：**
X
Update js-apis  
xuchenghua09 已提交
336
Z
update docs  
zengyawen 已提交
337 338 
| 名称          | 读写属性 | 类型                                                         | 必填 | 描述                       |
| ------------- | -------- | ------------------------------------------------------------ | ---- | -------------------------- |
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
339 340 
| subscribeInfo | 只读     | [CommonEventSubscribeInfo](#commoneventsubscribeinfo)        | 是   | 表示订阅信息。             |
| callback      | 只读     | AsyncCallback\<[CommonEventSubscriber](#commoneventsubscriber)> | 是   | 表示创建订阅者的回调方法。 |
X
Update js-apis  
xuchenghua09 已提交
341
Z
update docs  
zengyawen 已提交
342 
**示例：**
X
Update js-apis  
xuchenghua09 已提交
343 344 345 346 


```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
Z
fix: update commonevent  
zengsiyu 已提交
347
X
Update js-apis  
xuchenghua09 已提交
348 349 350 351 
//订阅者信息
var subscribeInfo = {
	events: ["event"]
};
Z
fix: update commonevent  
zengsiyu 已提交
352
X
Update js-apis  
xuchenghua09 已提交
353 
//创建订阅者回调
Z
fix: update commonevent  
zengsiyu 已提交
354 355 356 357 358 359 360 
function CreateSubscriberCallBack(err, commonEventSubscriber) {
    if (err.code) {
        console.error("createSubscriber failed " + JSON.stringify(err));
    } else {
        console.info("createSubscriber");
        subscriber = commonEventSubscriber;
    }
X
Update js-apis  
xuchenghua09 已提交
361 
}
Z
fix: update commonevent  
zengsiyu 已提交
362
X
Update js-apis  
xuchenghua09 已提交
363 364 365 366 367 368 
//创建订阅者
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
```
Z
update docs  
zengyawen 已提交
369 
## CommonEvent.createSubscriber
X
Update js-apis  
xuchenghua09 已提交
370
Z
update docs  
zengyawen 已提交
371 
createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise\<CommonEventSubscriber>
X
Update js-apis  
xuchenghua09 已提交
372
Z
update docs  
zengyawen 已提交
373 
创建订阅者（Promise形式）。
X
Update js-apis  
xuchenghua09 已提交
374
Z
remove ordered common event examples  
zengsiyu 已提交
375 
**系统能力：** SystemCapability.Notification.CommonEvent
Z
fix: update commonevent  
zengsiyu 已提交
376
Z
update docs  
zengyawen 已提交
377 
**参数：**
X
Update js-apis  
xuchenghua09 已提交
378
Z
update docs  
zengyawen 已提交
379 380 
| 名称          | 读写属性 | 类型                                                  | 必填 | 描述           |
| ------------- | -------- | ----------------------------------------------------- | ---- | -------------- |
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
381 
| subscribeInfo | 只读     | [CommonEventSubscribeInfo](#commoneventsubscribeinfo) | 是   | 表示订阅信息。 |
X
Update js-apis  
xuchenghua09 已提交
382
Z
update docs  
zengyawen 已提交
383 384 385 
**返回值：**
| 类型                                                      | 说明             |
| --------------------------------------------------------- | ---------------- |
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
386 
| Promise\<[CommonEventSubscriber](#commoneventsubscriber)> | 返回订阅者对象。 |
X
Update js-apis  
xuchenghua09 已提交
387
Z
update docs  
zengyawen 已提交
388 
**示例：**
X
Update js-apis  
xuchenghua09 已提交
389 390 391 

```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
Z
fix: update commonevent  
zengsiyu 已提交
392
X
Update js-apis  
xuchenghua09 已提交
393 394 395 396 
//订阅者信息
var subscribeInfo = {
	events: ["event"]
};
Z
fix: update commonevent  
zengsiyu 已提交
397
X
Update js-apis  
xuchenghua09 已提交
398 
//创建订阅者
Z
fix: update commonevent  
zengsiyu 已提交
399 400 401 402 403 
CommonEvent.createSubscriber(subscribeInfo).then((commonEventSubscriber) => {
    console.info("createSubscriber");
    subscriber = commonEventSubscriber;
}).catch((err) => {
    console.error("createSubscriber failed " + JSON.stringify(err));
X
Update js-apis  
xuchenghua09 已提交
404 405 406 407 408 
});
```
Z
update docs  
zengyawen 已提交
409 
## CommonEvent.subscribe
X
Update js-apis  
xuchenghua09 已提交
410
Z
update docs  
zengyawen 已提交
411 
subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\<CommonEventData>): void
X
Update js-apis  
xuchenghua09 已提交
412
Z
update docs  
zengyawen 已提交
413 
订阅公共事件（callback形式）。
X
Update js-apis  
xuchenghua09 已提交
414
Z
remove ordered common event examples  
zengsiyu 已提交
415 
**系统能力：** SystemCapability.Notification.CommonEvent
Z
fix: update commonevent  
zengsiyu 已提交
416
Z
update docs  
zengyawen 已提交
417 
**参数：**
X
Update js-apis  
xuchenghua09 已提交
418
Z
update docs  
zengyawen 已提交
419 420 
| 名称       | 读写属性 | 类型                                                | 必填 | 描述                             |
| ---------- | -------- | --------------------------------------------------- | ---- | -------------------------------- |
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
421 422 
| subscriber | 只读     | [CommonEventSubscriber](#commoneventsubscriber)     | 是   | 表示订阅者对象。                 |
| callback   | 只读     | AsyncCallback\<[CommonEventData](#commoneventdata)> | 是   | 表示接收公共事件数据的回调函数。 |
X
Update js-apis  
xuchenghua09 已提交
423
Z
update docs  
zengyawen 已提交
424 
**示例：**
X
Update js-apis  
xuchenghua09 已提交
425 426 427 

```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
Z
fix: update commonevent  
zengsiyu 已提交
428
X
Update js-apis  
xuchenghua09 已提交
429 430 431 432 433 434 435 
//订阅者信息
var subscribeInfo = {
    events: ["event"]
};

//订阅公共事件回调
function SubscribeCallBack(err, data) {
Z
fix: update commonevent  
zengsiyu 已提交
436 437 438 439 440 
    if (err.code) {
        console.error("subscribe failed " + JSON.stringify(err));
    } else {
        console.info("subscribe " + JSON.stringify(data));
    }
X
Update js-apis  
xuchenghua09 已提交
441 442 443 
}

//创建订阅者回调
Z
fix: update commonevent  
zengsiyu 已提交
444 445 446 447 448 449 450 451 452 
function CreateSubscriberCallBack(err, commonEventSubscriber) {
    if (err.code) {
        console.error("createSubscriber failed " + JSON.stringify(err));
    } else {
        console.info("createSubscriber");
        subscriber = commonEventSubscriber;
        //订阅公共事件
        CommonEvent.subscribe(subscriber, SubscribeCallBack);
    }
X
Update js-apis  
xuchenghua09 已提交
453 454 455 456 457 458 
}

//创建订阅者
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
```
Z
fix: sync support with d.ts  
zengsiyu 已提交
459
X
Update js-apis  
xuchenghua09 已提交
460
Z
update docs  
zengyawen 已提交
461 
## CommonEvent.unsubscribe
X
Update js-apis  
xuchenghua09 已提交
462
Z
update docs  
zengyawen 已提交
463 
unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback\<void>): void
X
Update js-apis  
xuchenghua09 已提交
464
Z
update docs  
zengyawen 已提交
465 
取消订阅公共事件（callback形式）。
X
Update js-apis  
xuchenghua09 已提交
466
Z
remove ordered common event examples  
zengsiyu 已提交
467 
**系统能力：** SystemCapability.Notification.CommonEvent
Z
fix: update commonevent  
zengsiyu 已提交
468
Z
update docs  
zengyawen 已提交
469 
**参数：**
X
Update js-apis  
xuchenghua09 已提交
470
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
471 472 473 474 
| 名称       | 读写属性 | 类型                                             | 必填 | 描述                     |
| ---------- | -------- | ----------------------------------------------- | ---- | ------------------------ |
| subscriber | 只读     | [CommonEventSubscriber](#commoneventsubscriber) | 是   | 表示订阅者对象。         |
| callback   | 只读     | AsyncCallback\<void>                            | 否   | 表示取消订阅的回调方法。 |
X
Update js-apis  
xuchenghua09 已提交
475
Z
update docs  
zengyawen 已提交
476 
**示例：**
X
Update js-apis  
xuchenghua09 已提交
477 478 479 

```js
var subscriber;	//用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
Z
fix: update commonevent  
zengsiyu 已提交
480
X
Update js-apis  
xuchenghua09 已提交
481 482 483 484 
//订阅者信息
var subscribeInfo = {
	events: ["event"]
};
Z
fix: update commonevent  
zengsiyu 已提交
485
X
Update js-apis  
xuchenghua09 已提交
486 487 
//订阅公共事件回调
function SubscribeCallBack(err, data) {
Z
fix: update commonevent  
zengsiyu 已提交
488 489 490 491 492 
    if (err.code) {
        console.info("subscribe failed " + JSON.stringify(err));
    } else {
        console.info("subscribe " + JSON.stringify(data));
    }
X
Update js-apis  
xuchenghua09 已提交
493 
}
Z
fix: update commonevent  
zengsiyu 已提交
494
X
Update js-apis  
xuchenghua09 已提交
495 
//创建订阅者回调
Z
fix: update commonevent  
zengsiyu 已提交
496 497 498 499 500 501 502 503 504 
function CreateSubscriberCallBack(err, commonEventSubscriber) {
    if (err.code) {
        console.info("createSubscriber failed " + JSON.stringify(err));
    } else {
        console.info("createSubscriber");
        subscriber = commonEventSubscriber;
        //订阅公共事件
        CommonEvent.subscribe(subscriber, SubscribeCallBack);
    }
X
Update js-apis  
xuchenghua09 已提交
505 
}
Z
fix: update commonevent  
zengsiyu 已提交
506
X
Update js-apis  
xuchenghua09 已提交
507 508 
//取消订阅公共事件回调
function UnsubscribeCallBack(err) {
Z
fix: update commonevent  
zengsiyu 已提交
509 510 511 512 513 
	if (err.code) {
        console.info("unsubscribe failed " + JSON.stringify(err));
    } else {
        console.info("unsubscribe");
    }
X
Update js-apis  
xuchenghua09 已提交
514 
}
Z
fix: update commonevent  
zengsiyu 已提交
515
X
Update js-apis  
xuchenghua09 已提交
516 517 
//创建订阅者
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
Z
fix: update commonevent  
zengsiyu 已提交
518
X
Update js-apis  
xuchenghua09 已提交
519 520 521 
//取消订阅公共事件
CommonEvent.unsubscribe(subscriber, UnsubscribeCallBack);
```
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 

## CommonEventSubscriber

### getCode

getCode(callback: AsyncCallback\<number>): void

获取公共事件的结果代码（callback形式）。

**系统能力**：SystemCapability.Notification.CommonEvent

**参数：**

| 参数名   | 类型                   | 必填 | 描述               |
| -------- | ---------------------- | ---- | ------------------ |
| callback | AsyncCallback\<number> | 是   | 公共事件的结果代码。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象
Z
fix: update comments and api9 interfaces  
zengsiyu 已提交
544 
//获取有序公共事件的结果代码回调
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 
function getCodeCallback(err, Code) {
    if (err.code) {
        console.error("getCode failed " + JSON.stringify(err));
    } else {
        console.info("getCode " + JSON.stringify(Code));
    }
}
subscriber.getCode(getCodeCallback);
```

### getCode

getCode(): Promise\<number>

获取公共事件的结果代码（Promise形式）。

**系统能力**：SystemCapability.Notification.CommonEvent

**返回值：**

| 类型             | 说明                 |
| ---------------- | -------------------- |
| Promise\<number> | 公共事件的结果代码。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象

subscriber.getCode().then((Code) => {
    console.info("getCode " + JSON.stringify(Code));
}).catch((err) => {
    console.error("getCode failed " + JSON.stringify(err));
});
```

### setCode

setCode(code: number, callback: AsyncCallback\<void>): void

设置公共事件的结果代码（callback形式）。

**系统能力**：SystemCapability.Notification.CommonEvent

**参数：**

| 参数名   | 类型                 | 必填 | 描述                   |
| -------- | -------------------- | ---- | ---------------------- |
| code     | number               | 是   | 公共事件的结果代码。   |
| callback | AsyncCallback\<void> | 是   | 表示被指定的回调方法。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象
Z
fix: update comments and api9 interfaces  
zengsiyu 已提交
601 
//设置有序公共事件的结果代码回调
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 
function setCodeCallback(err) {
    if (err.code) {
        console.error("setCode failed " + JSON.stringify(err));
    } else {
        console.info("setCode");
    }
}
subscriber.setCode(1, setCodeCallback);
```

### setCode

setCode(code: number): Promise\<void>

设置公共事件的结果代码（Promise形式）。

**系统能力**：SystemCapability.Notification.CommonEvent

**参数：**

| 参数名 | 类型   | 必填 | 描述               |
| ------ | ------ | ---- | ------------------ |
| code   | number | 是   | 公共事件的结果代码。 |

**返回值：**

| 类型             | 说明                 |
| ---------------- | -------------------- |
| Promise\<void>   | 返回一个Promise的结果。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象

subscriber.setCode(1).then(() => {
    console.info("setCode");
}).catch((err) => {
    console.error("setCode failed " + JSON.stringify(err));
});
```

### getData

getData(callback: AsyncCallback\<string>): void

获取公共事件的结果数据（callback形式）。

**系统能力**：SystemCapability.Notification.CommonEvent

**参数：**

| 参数名   | 类型                   | 必填 | 描述                 |
| -------- | ---------------------- | ---- | -------------------- |
| callback | AsyncCallback\<string> | 是   | 公共事件的结果数据。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象
Z
fix: update comments and api9 interfaces  
zengsiyu 已提交
663 
//获取有序公共事件的结果数据回调
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 
function getDataCallback(err, Data) {
    if (err.code) {
        console.error("getData failed " + JSON.stringify(err));
    } else {
        console.info("getData " + JSON.stringify(Data));
    }
}
subscriber.getData(getDataCallback);
```

### getData

getData(): Promise\<string>

获取公共事件的结果数据（Promise形式）。

**系统能力**：SystemCapability.Notification.CommonEvent

**返回值：**

| 类型             | 说明               |
| ---------------- | ------------------ |
| Promise\<string> | 公共事件的结果数据。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象

subscriber.getData().then((Data) => {
    console.info("getData " + JSON.stringify(Data));
}).catch((err) => {
    console.error("getData failed " + JSON.stringify(err));
});
```

### setData

setData(data: string, callback: AsyncCallback\<void>): void

设置公共事件的结果数据（callback形式）。

**系统能力**：SystemCapability.Notification.CommonEvent

**参数：**

| 参数名   | 类型                 | 必填 | 描述                 |
| -------- | -------------------- | ---- | -------------------- |
| data     | string               | 是   | 公共事件的结果数据。   |
| callback | AsyncCallback\<void> | 是   | 表示被指定的回调方法。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象

//设置有序公共事件的结果数据回调
function setDataCallback(err) {
    if (err.code) {
        console.error("setData failed " + JSON.stringify(err));
    } else {
        console.info("setData");
    }
}
subscriber.setData("publish_data_changed", setDataCallback);
```

### setData

setData(data: string): Promise\<void>

设置公共事件的结果数据（Promise形式）。

**系统能力**：SystemCapability.Notification.CommonEvent

**参数：**

| 参数名 | 类型   | 必填 | 描述                 |
| ------ | ------ | ---- | -------------------- |
| data   | string | 是   | 公共事件的结果数据。 |

**返回值：**

| 类型             | 说明                 |
| ---------------- | -------------------- |
| Promise\<void>   | 返回一个Promise的结果。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象

subscriber.setData("publish_data_changed").then(() => {
    console.info("setData");
}).catch((err) => {
    console.error("setData failed " + JSON.stringify(err));
});
```

### setCodeAndData

setCodeAndData(code: number, data: string, callback:AsyncCallback\<void>): void

设置公共事件的结果代码和结果数据（callback形式）。

**系统能力**：SystemCapability.Notification.CommonEvent

**参数：**

| 参数名   | 类型                 | 必填 | 描述                   |
| -------- | -------------------- | ---- | ---------------------- |
| code     | number               | 是   | 公共事件的结果代码。   |
| data     | string               | 是   | 公共事件的结果数据。   |
| callback | AsyncCallback\<void> | 是   | 表示被指定的回调方法。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象
Z
fix: update comments and api9 interfaces  
zengsiyu 已提交
784 
//设置有序公共事件的结果代码和结果数据回调
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 
function setCodeDataCallback(err) {
    if (err.code) {
        console.error("setCodeAndData failed " + JSON.stringify(err));
    } else {
        console.info("setCodeDataCallback");
    }
}
subscriber.setCodeAndData(1, "publish_data_changed", setCodeDataCallback);
```

### setCodeAndData

setCodeAndData(code: number, data: string): Promise\<void>

设置公共事件的结果代码和结果数据（Promise形式）。

**系统能力**：SystemCapability.Notification.CommonEvent

**参数：**

| 参数名 | 类型   | 必填 | 描述                 |
| ------ | ------ | ---- | -------------------- |
| code   | number | 是   | 公共事件的结果代码。 |
| data   | string | 是   | 公共事件的结果数据。 |

**返回值：**

| 类型             | 说明                 |
| ---------------- | -------------------- |
| Promise\<void>   | 返回一个Promise的结果。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象

subscriber.setCodeAndData(1, "publish_data_changed").then(() => {
    console.info("setCodeAndData");
}).catch((err) => {
    console.info("setCodeAndData failed " + JSON.stringify(err));
});
```

### isOrderedCommonEvent

isOrderedCommonEvent(callback: AsyncCallback\<boolean>): void

查询当前公共事件的是否为有序公共事件（callback形式）。

返回true代表是有序公共事件，false代表不是有序公共事件。

**系统能力**：SystemCapability.Notification.CommonEvent

**参数：**

| 参数名   | 类型                    | 必填 | 描述                               |
| -------- | ----------------------- | ---- | ---------------------------------- |
| callback | AsyncCallback\<boolean> | 是   | 当前公共事件的是否为有序公共事件。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象
Z
fix: update comments and api9 interfaces  
zengsiyu 已提交
849 
//获取当前公共事件是否为有序事件的回调
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 
function isOrderedCallback(err, isOrdered) {
    if (err.code) {
        console.error("isOrderedCommonEvent failed " + JSON.stringify(err));
    } else {
        console.info("isOrdered " + JSON.stringify(isOrdered));
    }
}
subscriber.isOrderedCommonEvent(isOrderedCallback);
```

### isOrderedCommonEvent

isOrderedCommonEvent(): Promise\<boolean>

查询当前公共事件的是否为有序公共事件（Promise形式）。

返回true代表是有序公共事件，false代表不是有序公共事件。

**系统能力**：SystemCapability.Notification.CommonEvent

**返回值：**

| 类型              | 说明                             |
| ----------------- | -------------------------------- |
| Promise\<boolean> | 当前公共事件的是否为有序公共事件。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象

subscriber.isOrderedCommonEvent().then((isOrdered) => {
    console.info("isOrdered " + JSON.stringify(isOrdered));
}).catch((err) => {
    console.error("isOrdered failed " + JSON.stringify(err));
});
```

### isStickyCommonEvent

isStickyCommonEvent(callback: AsyncCallback\<boolean>): void

检查当前公共事件是否为一个粘性事件（callback形式）。

返回true代表是粘性公共事件，false代表不是粘性公共事件。

**系统能力**：SystemCapability.Notification.CommonEvent

**参数：**

| 参数名   | 类型                    | 必填 | 描述                               |
| -------- | ----------------------- | ---- | ---------------------------------- |
| callback | AsyncCallback\<boolean> | 是   | 当前公共事件的是否为粘性公共事件。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象
Z
fix: update comments and api9 interfaces  
zengsiyu 已提交
909 
//获取当前公共事件是否为粘性事件的回调
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
910 911 912 913 914 915 916 917 918 919 920 921 922 923 
function isStickyCallback(err, isSticky) {
    if (err.code) {
        console.error("isStickyCommonEvent failed " + JSON.stringify(err));
    } else {
        console.info("isSticky " + JSON.stringify(isSticky));
    }
}
subscriber.isStickyCommonEvent(isStickyCallback);
```

### isStickyCommonEvent

isStickyCommonEvent(): Promise\<boolean>
Z
fix: misspell  
zengsiyu 已提交
924 
检查当前公共事件是否为一个粘性事件（Promise形式）。
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 

返回true代表是粘性公共事件，false代表不是粘性公共事件。

**系统能力**：SystemCapability.Notification.CommonEvent

**返回值：**

| 类型              | 说明                             |
| ----------------- | -------------------------------- |
| Promise\<boolean> | 当前公共事件的是否为粘性公共事件。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象

subscriber.isStickyCommonEvent().then((isSticky) => {
    console.info("isSticky " + JSON.stringify(isSticky));
}).catch((err) => {
    console.error("isSticky failed " + JSON.stringify(err));
});
```

### abortCommonEvent

abortCommonEvent(callback: AsyncCallback\<void>): void

取消当前的公共事件，仅对有序公共事件有效，取消后，公共事件不再向下一个订阅者传递（callback形式）。

**系统能力**：SystemCapability.Notification.CommonEvent

**参数：**

| 参数名   | 类型                 | 必填 | 描述                 |
| -------- | -------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void> | 是   | 取消当前的公共事件。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象
Z
fix: update comments and api9 interfaces  
zengsiyu 已提交
967 
//取消当前有序公共事件的回调
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 
function abortCallback(err) {
    if (err.code) {
        console.error("abortCommonEvent failed " + JSON.stringify(err));
    } else {
        console.info("abortCommonEvent");
    }
}
subscriber.abortCommonEvent(abortCallback);
```

### abortCommonEvent

abortCommonEvent(): Promise\<void>

取消当前的公共事件，仅对有序公共事件有效，取消后，公共事件不再向下一个订阅者传递（Promise形式）。

**系统能力**：SystemCapability.Notification.CommonEvent

**返回值：**

| 类型             | 说明                 |
| ---------------- | -------------------- |
| Promise\<void>   | 返回一个Promise的结果。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象

subscriber.abortCommonEvent().then(() => {
    console.info("abortCommonEvent");
}).catch((err) => {
    console.error("abortCommonEvent failed " + JSON.stringify(err));
});
```

### clearAbortCommonEvent

clearAbortCommonEvent(callback: AsyncCallback\<void>): void

清除当前公共事件的取消状态，仅对有序公共事件有效（callback形式）。

**系统能力**：SystemCapability.Notification.CommonEvent

**参数：**

| 参数名   | 类型                 | 必填 | 描述                 |
| -------- | -------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void> | 是   | 表示被指定的回调方法。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象
Z
fix: update comments and api9 interfaces  
zengsiyu 已提交
1023 
//清除当前公共事件取消状态的回调
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 
function clearAbortCallback(err) {
    if (err.code) {
        console.error("clearAbortCommonEvent failed " + JSON.stringify(err));
    } else {
        console.info("clearAbortCommonEvent");
    }
}
subscriber.clearAbortCommonEvent(clearAbortCallback);
```

### clearAbortCommonEvent

clearAbortCommonEvent(): Promise\<void>

清除当前公共事件的取消状态，仅对有序公共事件有效（Promise形式）。

**系统能力**：SystemCapability.Notification.CommonEvent

**返回值：**

| 类型             | 说明                 |
| ---------------- | -------------------- |
| Promise\<void>   | 返回一个Promise的结果。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象

subscriber.clearAbortCommonEvent().then(() => {
    console.info("clearAbortCommonEvent");
}).catch((err) => {
    console.error("clearAbortCommonEvent failed " + JSON.stringify(err));
});
```

### getAbortCommonEvent

getAbortCommonEvent(callback: AsyncCallback\<boolean>): void

获取当前有序公共事件是否取消的状态（callback形式）。

**系统能力**：SystemCapability.Notification.CommonEvent

**参数：**

| 参数名   | 类型                    | 必填 | 描述                               |
| -------- | ----------------------- | ---- | ---------------------------------- |
| callback | AsyncCallback\<boolean> | 是   | 表示当前有序公共事件是否取消的状态。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象
Z
fix: update comments and api9 interfaces  
zengsiyu 已提交
1079 
//获取当前有序公共事件是否取消的回调
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 
function getAbortCallback(err, AbortCommonEvent) {
    if (err.code) {
        console.error("getAbortCommonEvent failed " + JSON.stringify(err));
    } else {
        console.info("AbortCommonEvent " + AbortCommonEvent)
    }
}
subscriber.getAbortCommonEvent(getAbortCallback);
```

### getAbortCommonEvent

getAbortCommonEvent(): Promise\<boolean>

获取当前有序公共事件是否取消的状态（Promise形式）。

**系统能力**：SystemCapability.Notification.CommonEvent

**返回值：**

| 类型              | 说明                               |
| ----------------- | ---------------------------------- |
| Promise\<boolean> | 表示当前有序公共事件是否取消的状态。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象

subscriber.getAbortCommonEvent().then((AbortCommonEvent) => {
    console.info("AbortCommonEvent " + JSON.stringify(AbortCommonEvent));
}).catch((err) => {
    console.error("getAbortCommonEvent failed " + JSON.stringify(err));
});
```

### getSubscribeInfo

getSubscribeInfo(callback: AsyncCallback\<CommonEventSubscribeInfo>): void

获取订阅者的订阅信息（callback形式）。

**系统能力**：SystemCapability.Notification.CommonEvent

**参数：**

| 参数名   | 类型                                                         | 必填 | 描述                   |
| -------- | ------------------------------------------------------------ | ---- | ---------------------- |
| callback | AsyncCallback\<[CommonEventSubscribeInfo](#commoneventsubscribeinfo)> | 是   | 表示订阅者的订阅信息。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象
Z
fix: update comments and api9 interfaces  
zengsiyu 已提交
1135 
//获取订阅者信息回调
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 
function getSubscribeInfoCallback(err, SubscribeInfo) {
    if (err.code) {
        console.error("getSubscribeInfo failed " + JSON.stringify(err));
    } else {
        console.info("SubscribeInfo " + JSON.stringify(SubscribeInfo));
    }
}
subscriber.getSubscribeInfo(getSubscribeInfoCallback);
```

### getSubscribeInfo

getSubscribeInfo(): Promise\<CommonEventSubscribeInfo>

获取订阅者的订阅信息（Promise形式）。

**系统能力**：SystemCapability.Notification.CommonEvent

**返回值：**

| 类型                                                         | 说明                   |
| ------------------------------------------------------------ | ---------------------- |
| Promise\<[CommonEventSubscribeInfo](#commoneventsubscribeinfo)> | 表示订阅者的订阅信息。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象

subscriber.getSubscribeInfo().then((SubscribeInfo) => {
    console.info("SubscribeInfo " + JSON.stringify(SubscribeInfo));
}).catch((err) => {
    console.error("getSubscribeInfo failed " + JSON.stringify(err));
});
```
Z
fix: update comments and api9 interfaces  
zengsiyu 已提交
1172 
### finishCommonEvent<sup>9+</sup>
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
1173 1174 1175 

finishCommonEvent(callback: AsyncCallback\<void\>): void
Z
fix: update comments and api9 interfaces  
zengsiyu 已提交
1176 
结束当前有序公共事件（callback形式）。
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
1177 1178 1179 1180 1181 1182 1183 

**系统能力**：SystemCapability.Notification.CommonEvent

**参数：**

| 参数名   | 类型                  | 必填 | 描述                              |
| -------- | -------------------- | ---- | -------------------------------- |
Z
fix: update comments and api9 interfaces  
zengsiyu 已提交
1184 
| callback | AsyncCallback\<void> | 是   | 表示有序公共事件结束后的回调函数。 |
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
1185 1186 1187 1188 1189 1190 

**示例：**

```js
var subscriber; //创建成功的订阅者对象
Z
fix: update comments and api9 interfaces  
zengsiyu 已提交
1191 
//结束当前有序公共事件的回调
X
Fix wrong example code of Notification docs  
xuzhihao 已提交
1192 
function finishCommonEventCallback(err) {
Z
fix: update comments and api9 interfaces  
zengsiyu 已提交
1193 
  if (err.code) {
X
Fix wrong example code of Notification docs  
xuzhihao 已提交
1194 1195 1196 1197 
    console.error("finishCommonEvent failed " + JSON.stringify(err));
} else {
    console.info("FinishCommonEvent");
}
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
1198 1199 1200 1201 
}
subscriber.finishCommonEvent(finishCommonEventCallback);
```
Z
fix: update comments and api9 interfaces  
zengsiyu 已提交
1202 
### finishCommonEvent<sup>9+</sup>
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
1203 1204 1205 

finishCommonEvent(): Promise\<void\>
Z
fix: update comments and api9 interfaces  
zengsiyu 已提交
1206 
结束当前有序公共事件（Promise形式）。
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 

**系统能力**：SystemCapability.Notification.CommonEvent

**返回值：**

| 类型             | 说明                 |
| ---------------- | -------------------- |
| Promise\<void>   | 返回一个Promise的结果。 |

**示例：**

```js
var subscriber;	//创建成功的订阅者对象
Z
fix: update comments and api9 interfaces  
zengsiyu 已提交
1221 1222 1223 1224 1225 
subscriber.finishCommonEvent().then(() => {
    console.info("FinishCommonEvent");
}).catch((err) => {
    console.error("finishCommonEvent failed " + JSON.stringify(err));
});
X
Merge children docs into CommnEvent & Notificication  
xuzhihao 已提交
1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 
```

## CommonEventData

**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent

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


## CommonEventPublishData

**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent

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

## CommonEventSubscribeInfo

**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent

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