1# CommonEvent 2 3 4## 概述 5 6描述CommonEvent向应用提供公共事件的能力。 7 8**系统能力：** SystemCapability.Notification.CommonEvent 9 10**起始版本：** 12 11 12 13## 汇总 14 15 16### 文件 17 18| 名称 | 描述 | 19| -------- | -------- | 20| [oh_commonevent.h](oh_commonevent_8h.md) | 声明公共事件相关的API，包含订阅公共事件与退订公共事件。<br/>**引用文件**：<BasicServicesKit/oh_commonevent.h><br/>**库**：libohcommonevent.so| 21| [oh_commonevent_support.h](oh_commonevent_support_8h.md) | 提供系统定义的公共事件常量。<br/>**引用文件**：<BasicServicesKit/oh_commonevent_support.h><br/>**库**：libohcommonevent.so | 22 23 24### 类型定义 25 26| 名称 | 描述 | 27| -------- | -------- | 28|[CommonEvent_SubscribeInfo](#commonevent_subscribeinfo) | 订阅者信息。 | 29|[CommonEvent_Subscriber](#commonevent_subscriber) | 订阅者。 | 30|[CommonEvent_RcvData](#commonevent_rcvdata) | 公共事件的回调数据。 | 31|[CommonEvent_Parameters](#commonevent_parameters) | 公共事件的回调附加信息。 | 32|[CommonEvent_ReceiveCallback](#commonevent_receivecallback)| 公共事件的回调函数。 | 33 34### 枚举 35 36| 名称 | 描述 | 37| -------- | -------- | 38| [CommonEvent_ErrCode](#commonevent_errcode) | 枚举错误码。 | 39 40 41### 函数 42 43| 名称 | 描述 | 44| -------- | -------- | 45| [OH_CommonEvent_CreateSubscribeInfo](#oh_commonevent_createsubscribeinfo)| 创建订阅者信息。 | 46| [OH_CommonEvent_SetPublisherPermission](#oh_commonevent_setpublisherpermission) | 设置订阅者权限。 | 47| [OH_CommonEvent_SetPublisherBundleName](#oh_commonevent_setpublisherbundlename) | 设置订阅者包名称。 | 48| [OH_CommonEvent_DestroySubscribeInfo](#oh_commonevent_destroysubscribeinfo) | 销毁订阅者信息。 | 49| [OH_CommonEvent_CreateSubscriber](#oh_commonevent_createsubscriber)| 创建订阅者。 | 50| [OH_CommonEvent_DestroySubscriber](#oh_commonevent_destroysubscriber) | 销毁订阅者。 | 51| [OH_CommonEvent_Subscribe](#oh_commonevent_subscribe) | 订阅事件。 | 52| [OH_CommonEvent_UnSubscribe](#oh_commonevent_unsubscribe) | 退订事件。 | 53| [OH_CommonEvent_GetEventFromRcvData](#oh_commonevent_geteventfromrcvdata)| 获取公共事件名称。 | 54| [OH_CommonEvent_GetCodeFromRcvData](#oh_commonevent_getcodefromrcvdata) | 获取公共事件结果代码。 | 55| [OH_CommonEvent_GetDataStrFromRcvData](#oh_commonevent_getdatastrfromrcvdata)| 获取公共事件自定义结果数据。 | 56| [OH_CommonEvent_GetBundleNameFromRcvData](#oh_commonevent_getbundlenamefromrcvdata)| 获取公共事件包名称。 | 57| [OH_CommonEvent_GetParametersFromRcvData](#oh_commonevent_getparametersfromrcvdata) | 获取公共事件附加信息。 | 58| [OH_CommonEvent_HasKeyInParameters](#oh_commonevent_haskeyinparameters) | 检查公共事件附加信息中是否包含某个键值对信息。 | 59| [OH_CommonEvent_GetIntFromParameters](#oh_commonevent_getintfromparameters) | 获取公共事件附加信息中int数据信息。 | 60| [OH_CommonEvent_GetIntArrayFromParameters](#oh_commonevent_getintarrayfromparameters)| 获取公共事件附加信息中int数组信息。 | 61| [OH_CommonEvent_GetLongFromParameters](#oh_commonevent_getlongfromparameters)| 获取公共事件附加信息中long数据信息。 | 62| [OH_CommonEvent_GetLongArrayFromParameters](#oh_commonevent_getlongarrayfromparameters)| 获取公共事件附加信息中long数组信息。 | 63| [OH_CommonEvent_GetBoolFromParameters](#oh_commonevent_getboolfromparameters)| 获取公共事件附加信息中布尔数据信息。 | 64| [OH_CommonEvent_GetBoolArrayFromParameters](#oh_commonevent_getboolarrayfromparameters)| 获取公共事件附加信息中布尔数组信息。 | 65| [OH_CommonEvent_GetCharFromParameters](#oh_commonevent_getcharfromparameters)| 获取公共事件附加信息中字符数据信息。 | 66| [OH_CommonEvent_GetCharArrayFromParameters](#oh_commonevent_getchararrayfromparameters)| 获取公共事件附加信息中字符数组信息。 | 67| [OH_CommonEvent_GetDoubleFromParameters](#oh_commonevent_getdoublefromparameters)| 获取公共事件附加信息中double数据信息。 | 68| [OH_CommonEvent_GetDoubleArrayFromParameters](#oh_commonevent_getdoublearrayfromparameters)| 获取公共事件附加信息中double数组信息。 | 69 70### 常量 71| 名称 | 描述 | 72| -------- | -------- | 73|static const char* const [COMMON_EVENT_SHUTDOWN](common_event/commonEventManager-definitions.md#common_event_shutdown) = "usual.event.SHUTDOWN" | 表示设备正在关闭并将继续直至最终关闭的公共事件。 | 74|static const char* const [COMMON_EVENT_BATTERY_CHANGED](common_event/commonEventManager-definitions.md#common_event_battery_changed) = "usual.event.BATTERY_CHANGED" | 表示电池充电状态、电平和其他信息发生变化的公共事件。| 75|static const char* const [COMMON_EVENT_BATTERY_LOW](common_event/commonEventManager-definitions.md#common_event_battery_low) = "usual.event.BATTERY_LOW"|表示电池电量低的公共事件。 | 76|static const char* const [COMMON_EVENT_BATTERY_OKAY](common_event/commonEventManager-definitions.md#common_event_battery_okay) = "usual.event.BATTERY_OKAY"|表示电池退出低电平状态的公共事件。 | 77|static const char* const [COMMON_EVENT_POWER_CONNECTED](common_event/commonEventManager-definitions.md#common_event_power_connected) = "usual.event.POWER_CONNECTED"|表示设备连接到外部电源的公共事件。| 78|static const char* const [COMMON_EVENT_POWER_DISCONNECTED](common_event/commonEventManager-definitions.md#common_event_power_disconnected) = "usual.event.POWER_DISCONNECTED"|表示设备与外部电源断开的公共事件。| 79|static const char* const [COMMON_EVENT_SCREEN_OFF](common_event/commonEventManager-definitions.md#common_event_screen_off) = "usual.event.SCREEN_OFF"| 表示设备屏幕关闭且设备处于睡眠状态的公共事件。| 80|static const char* const [COMMON_EVENT_SCREEN_ON](common_event/commonEventManager-definitions.md#common_event_screen_on) = "usual.event.SCREEN_ON"|表示设备屏幕打开且设备处于交互状态的公共事件。 | 81|static const char* const [COMMON_EVENT_THERMAL_LEVEL_CHANGED](common_event/commonEventManager-definitions.md#common_event_thermal_level_changed) = "usual.event.THERMAL_LEVEL_CHANGED"|表示设备热状态的公共事件。 | 82|static const char* const [COMMON_EVENT_TIME_TICK](common_event/commonEventManager-definitions.md#common_event_time_tick) = "usual.event.TIME_TICK"|表示系统时间随时间流逝而发生变化的公共事件。 | 83|static const char* const [COMMON_EVENT_TIME_CHANGED](common_event/commonEventManager-definitions.md#common_event_time_changed) = "usual.event.TIME_CHANGED"|表示系统时间被重新设置的公共事件。 | 84|static const char* const [COMMON_EVENT_TIMEZONE_CHANGED](common_event/commonEventManager-definitions.md#common_event_timezone_changed) = "usual.event.TIMEZONE_CHANGED"|表示系统时区更改的公共事件。 | 85|static const char* const [COMMON_EVENT_PACKAGE_ADDED](common_event/commonEventManager-definitions.md#common_event_package_added) = "usual.event.PACKAGE_ADDED"| 表示设备上已安装新应用包的公共事件。| 86|static const char* const [COMMON_EVENT_PACKAGE_REMOVED](common_event/commonEventManager-definitions.md#common_event_package_removed) = "usual.event.PACKAGE_REMOVED"| 表示已安装的应用程序从设备中卸载，但应用程序数据保留的公共事件。| 87|static const char* const [COMMON_EVENT_BUNDLE_REMOVED](common_event/commonEventManager-definitions.md#common_event_bundle_removed) = "usual.event.BUNDLE_REMOVED"| 表示从设备中卸载已安装应用程序的附加包，但应用程序数据仍保留的公共事件。| 88|static const char* const [COMMON_EVENT_PACKAGE_FULLY_REMOVED](common_event/commonEventManager-definitions.md#common_event_package_fully_removed) = "usual.event.PACKAGE_FULLY_REMOVED"|表示已从设备中完全卸载已安装的应用程序（包括应用程序数据和代码）的公共事件。 | 89|static const char* const [COMMON_EVENT_PACKAGE_CHANGED](common_event/commonEventManager-definitions.md#common_event_package_changed) = "usual.event.PACKAGE_CHANGED"| 表示应用包已更改的公共事件（例如，包中的组件已启用或禁用）。| 90|static const char* const [COMMON_EVENT_PACKAGE_RESTARTED](common_event/commonEventManager-definitions.md#common_event_package_restarted) = "usual.event.PACKAGE_RESTARTED"| 表示用户重启应用包并杀死其所有进程的公共事件。| 91|static const char* const [COMMON_EVENT_PACKAGE_DATA_CLEARED](common_event/commonEventManager-definitions.md#common_event_package_data_cleared) = "usual.event.PACKAGE_DATA_CLEARED"| 表示用户清除应用包数据的公共事件| 92|static const char* const [COMMON_EVENT_PACKAGE_CACHE_CLEARED](common_event/commonEventManager-definitions.md#common_event_package_cache_cleared) = "usual.event.PACKAGE_CACHE_CLEARED"|表示用户清除应用包缓存数据的公共事件。 | 93|static const char* const [COMMON_EVENT_PACKAGES_SUSPENDED](common_event/commonEventManager-definitions.md#common_event_packages_suspended) = "usual.event.PACKAGES_SUSPENDED"|表示应用包已挂起的公共事件。 | 94|static const char* const [COMMON_EVENT_MY_PACKAGE_SUSPENDED](common_event/commonEventManager-definitions.md#common_event_my_package_suspended) = "usual.event.MY_PACKAGE_SUSPENDED"| 表示应用程序包已被挂起的公共事件，该事件可以发送到被挂起的应用程序包。| 95|static const char* const [COMMON_EVENT_MY_PACKAGE_UNSUSPENDED](common_event/commonEventManager-definitions.md#common_event_my_package_unsuspended) = "usual.event.MY_PACKAGE_UNSUSPENDED"| 表示应用包未挂起的公共事件。 | 96|static const char* const [COMMON_EVENT_LOCALE_CHANGED](common_event/commonEventManager-definitions.md#common_event_locale_changed) = "usual.event.LOCALE_CHANGED"| 表示设备区域设置已更改的公共事件。| 97|static const char* const [COMMON_EVENT_MANAGE_PACKAGE_STORAGE](common_event/commonEventManager-definitions.md#common_event_manage_package_storage) = "usual.event.MANAGE_PACKAGE_STORAGE"| 设备存储空间不足的公共事件。| 98|static const char* const [COMMON_EVENT_USER_UNLOCKED](common_event/commonEventManager-definitions.md#common_event_user_unlocked) = "usual.event.USER_UNLOCKED"| 表示设备重启后解锁时，当前用户的凭据加密存储已解锁的公共事件。 | 99|static const char* const [COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOUT](common_event/commonEventManager-definitions.md#common_event_distributed_account_logout) = "common.event.DISTRIBUTED_ACCOUNT_LOGOUT"|表示分布式账号登出成功的公共事件。 | 100|static const char* const [COMMON_EVENT_DISTRIBUTED_ACCOUNT_TOKEN_INVALID](common_event/commonEventManager-definitions.md#common_event_distributed_account_token_invalid) = "common.event.DISTRIBUTED_ACCOUNT_TOKEN_INVALID"|表示分布式账号token令牌无效的公共事件。 | 101|static const char* const [COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOFF](common_event/commonEventManager-definitions.md#common_event_distributed_account_logoff) = "common.event.DISTRIBUTED_ACCOUNT_LOGOFF"| 表示分布式账号注销的公共事件。| 102|static const char* const [COMMON_EVENT_WIFI_POWER_STATE](common_event/commonEventManager-definitions.md#common_event_wifi_power_state) = "usual.event.wifi.POWER_STATE"| 表示Wi-Fi状态公共事件，如启用和禁用。| 103|static const char* const [COMMON_EVENT_WIFI_SCAN_FINISHED](common_event/commonEventManager-definitions.md#common_event_wifi_scan_finished) = "usual.event.wifi.SCAN_FINISHED"|表示Wi-Fi接入点已被扫描并证明可用的公共事件。 | 104|static const char* const [COMMON_EVENT_WIFI_RSSI_VALUE](common_event/commonEventManager-definitions.md#common_event_wifi_rssi_value) = "usual.event.wifi.RSSI_VALUE"|表示Wi-Fi信号强度（RSSI）改变的公共事件。 | 105|static const char* const [COMMON_EVENT_WIFI_CONN_STATE](common_event/commonEventManager-definitions.md#common_event_wifi_conn_state) = "usual.event.wifi.CONN_STATE"| 表示Wi-Fi连接状态发生改变的公共事件。| 106|static const char* const [COMMON_EVENT_WIFI_HOTSPOT_STATE](common_event/commonEventManager-definitions.md#common_event_wifi_hotspot_state) = "usual.event.wifi.HOTSPOT_STATE"| 表示Wi-Fi热点状态的公共事件，如启用或禁用。| 107|static const char* const [COMMON_EVENT_WIFI_AP_STA_JOIN](common_event/commonEventManager-definitions.md#common_event_wifi_ap_sta_join) = "usual.event.wifi.WIFI_HS_STA_JOIN"| 表示客户端加入当前设备Wi-Fi热点的公共事件。| 108|static const char* const [COMMON_EVENT_WIFI_AP_STA_LEAVE](common_event/commonEventManager-definitions.md#common_event_wifi_ap_sta_leave) = "usual.event.wifi.WIFI_HS_STA_LEAVE"|表示客户端已断开与当前设备Wi-Fi热点的连接的公共事件。 | 109|static const char* const [COMMON_EVENT_WIFI_MPLINK_STATE_CHANGE](common_event/commonEventManager-definitions.md#common_event_wifi_mplink_state_change) = "usual.event.wifi.mplink.STATE_CHANGE"|表示MPLink（增强Wi-Fi功能）状态已更改的公共事件。 | 110|static const char* const [COMMON_EVENT_WIFI_P2P_CONN_STATE](common_event/commonEventManager-definitions.md#common_event_wifi_p2p_conn_state) = "usual.event.wifi.p2p.CONN_STATE_CHANGE"|表示Wi-Fi P2P连接状态改变的公共事件。 | 111|static const char* const [COMMON_EVENT_WIFI_P2P_STATE_CHANGED](common_event/commonEventManager-definitions.md#common_event_wifi_p2p_state_changed) = "usual.event.wifi.p2p.STATE_CHANGE"|表示Wi-Fi P2P状态公共事件，如启用和禁用。 | 112|static const char* const [COMMON_EVENT_WIFI_P2P_PEERS_STATE_CHANGED](common_event/commonEventManager-definitions.md#common_event_wifi_p2p_peers_state_changed) = "usual.event.wifi.p2p.DEVICES_CHANGE"|表示Wi-Fi P2P对等体状态变化的公共事件。 | 113|static const char* const [COMMON_EVENT_WIFI_P2P_PEERS_DISCOVERY_STATE_CHANGED](common_event/commonEventManager-definitions.md#common_event_wifi_p2p_peers_discovery_state_changed) = "usual.event.wifi.p2p.PEER_DISCOVERY_STATE_CHANGE"|表示Wi-Fi P2P发现状态变化的公共事件。 | 114|static const char* const [COMMON_EVENT_WIFI_P2P_CURRENT_DEVICE_STATE_CHANGED](common_event/commonEventManager-definitions.md#common_event_wifi_p2p_current_device_state_changed) = "usual.event.wifi.p2p.CURRENT_DEVICE_CHANGE"|表示Wi-Fi P2P当前设备状态变化的公共事件。 | 115|static const char* const [COMMON_EVENT_WIFI_P2P_GROUP_STATE_CHANGED](common_event/commonEventManager-definitions.md#common_event_wifi_p2p_group_state_changed) = "usual.event.wifi.p2p.GROUP_STATE_CHANGED"|表示Wi-Fi P2P群组信息已更改的公共事件。 | 116|static const char* const [COMMON_EVENT_NFC_ACTION_ADAPTER_STATE_CHANGED](common_event/commonEventManager-definitions.md#common_event_nfc_action_adapter_state_changed) = "usual.event.nfc.action.ADAPTER_STATE_CHANGED"| 表示设备NFC状态已更改的公共事件。| 117|static const char* const [COMMON_EVENT_NFC_ACTION_RF_FIELD_ON_DETECTED](common_event/commonEventManager-definitions.md#common_event_nfc_action_rf_field_on_detected) = "usual.event.nfc.action.RF_FIELD_ON_DETECTED"|表示检测到NFC场强进入的公共事件。 | 118|static const char* const [COMMON_EVENT_NFC_ACTION_RF_FIELD_OFF_DETECTED](common_event/commonEventManager-definitions.md#common_event_nfc_action_rf_field_off_detected) = "usual.event.nfc.action.RF_FIELD_OFF_DETECTED"|表示检测到NFC场强离开的公共事件。 | 119|static const char* const [COMMON_EVENT_DISCHARGING](common_event/commonEventManager-definitions.md#common_event_discharging) = "usual.event.DISCHARGING"| 表示系统停止为电池充电的公共事件。| 120|static const char* const [COMMON_EVENT_CHARGING](common_event/commonEventManager-definitions.md#common_event_charging) = "usual.event.CHARGING"|表示系统开始为电池充电的公共事件。 | 121|static const char* const [COMMON_EVENT_DEVICE_IDLE_MODE_CHANGED](common_event/commonEventManager-definitions.md#common_event_device_idle_mode_changed) = "usual.event.DEVICE_IDLE_MODE_CHANGED"| 表示系统待机空闲模式已更改的公共事件。| 122|static const char* const [COMMON_EVENT_CHARGE_IDLE_MODE_CHANGED](common_event/commonEventManager-definitions.md#common_event_charge_idle_mode_changed10) = "usual.event.CHARGE_IDLE_MODE_CHANGED"|表示设备进入充电空闲模式的公共事件。 | 123|static const char* const [COMMON_EVENT_POWER_SAVE_MODE_CHANGED](common_event/commonEventManager-definitions.md#common_event_power_save_mode_changed) = "usual.event.POWER_SAVE_MODE_CHANGED"|表示系统节能模式更改的公共事件。 | 124|static const char* const [COMMON_EVENT_USB_STATE](common_event/commonEventManager-definitions.md#common_event_usb_state) = "usual.event.hardware.usb.action.USB_STATE"|表示USB设备状态发生变化的公共事件。 | 125|static const char* const [COMMON_EVENT_USB_PORT_CHANGED](common_event/commonEventManager-definitions.md#common_event_usb_port_changed) = "usual.event.hardware.usb.action.USB_PORT_CHANGED"|表示用户设备的USB端口状态发生改变的公共事件。 | 126|static const char* const [COMMON_EVENT_USB_DEVICE_ATTACHED](common_event/commonEventManager-definitions.md#common_event_usb_device_attached) = "usual.event.hardware.usb.action.USB_DEVICE_ATTACHED"|当用户设备作为USB主机时，USB设备已挂载的公共事件。 | 127|static const char* const [COMMON_EVENT_USB_DEVICE_DETACHED](common_event/commonEventManager-definitions.md#common_event_usb_device_detached) = "usual.event.hardware.usb.action.USB_DEVICE_DETACHED"|当用户设备作为USB主机时，USB设备被卸载的公共事件。 | 128|static const char* const [COMMON_EVENT_AIRPLANE_MODE_CHANGED](common_event/commonEventManager-definitions.md#common_event_airplane_mode_changed10) = "usual.event.AIRPLANE_MODE"| 表示设备飞行模式已更改的公共事件。| 129|static const char* const [COMMON_EVENT_SPLIT_SCREEN](common_event/commonEventManager-definitions.md#common_event_split_screen) = "common.event.SPLIT_SCREEN"| 表示分屏的公共事件。| 130|static const char* const [COMMON_EVENT_QUICK_FIX_APPLY_RESULT](common_event/commonEventManager-definitions.md#common_event_quick_fix_apply_result) = "usual.event.QUICK_FIX_APPLY_RESULT"| 表示快速修复应用的公共事件。| 131|static const char* const [COMMON_EVENT_QUICK_FIX_REVOKE_RESULT](common_event/commonEventManager-definitions.md#common_event_quick_fix_revoke_result10) = "usual.event.QUICK_FIX_REVOKE_RESULT"| 表示撤销快速修复的公共事件。| 132|static const char* const [COMMON_EVENT_USER_INFO_UPDATED](common_event/commonEventManager-definitions.md#common_event_user_info_updated) = "usual.event.USER_INFO_UPDATED"| 表示用户信息已更新的公共事件。| 133|static const char* const [COMMON_EVENT_SIM_STATE_CHANGED](common_event/commonEventManager-definitions.md#common_event_sim_state_changed10) = "usual.event.SIM_STATE_CHANGED"|表示SIM卡状态更新的公共事件。 | 134|static const char* const [COMMON_EVENT_CALL_STATE_CHANGED](common_event/commonEventManager-definitions.md#common_event_call_state_changed10) = "usual.event.CALL_STATE_CHANGED"| 表示呼叫状态更新的公共事件。| 135|static const char* const [COMMON_EVENT_NETWORK_STATE_CHANGED](common_event/commonEventManager-definitions.md#common_event_network_state_changed10) = "usual.event.NETWORK_STATE_CHANGED"| 表示网络状态更新的公共事件。| 136|static const char* const [COMMON_EVENT_SIGNAL_INFO_CHANGED](common_event/commonEventManager-definitions.md#common_event_signal_info_changed10) = "usual.event.SIGNAL_INFO_CHANGED"|表示信号信息更新的公共事件。 | 137|static const char* const [COMMON_EVENT_SCREEN_UNLOCKED](common_event/commonEventManager-definitions.md#common_event_screen_unlocked) = "usual.event.SCREEN_UNLOCKED"|表示屏幕解锁的公共事件。 | 138|static const char* const [COMMON_EVENT_SCREEN_LOCKED](common_event/commonEventManager-definitions.md#common_event_screen_locked) = "usual.event.SCREEN_LOCKED"| 表示屏幕锁定的公共事件。| 139|static const char* const [COMMON_EVENT_HTTP_PROXY_CHANGE](common_event/commonEventManager-definitions.md#common_event_http_proxy_change10) = "usual.event.HTTP_PROXY_CHANGE"| 表示HTTP代理的配置信息发生变化的公共事件。| 140|static const char* const [COMMON_EVENT_CONNECTIVITY_CHANGE](common_event/commonEventManager-definitions.md#common_event_connectivity_change10) = "usual.event.CONNECTIVITY_CHANGE"| 表示网络连接状态变化的公共事件。| 141|static const char* const [COMMON_EVENT_MINORSMODE_ON](common_event/commonEventManager-definitions.md#common_event_minorsmode_on12) = "usual.event.MINORSMODE_ON"|表示未成年人模式开启的公共事件。 | 142|static const char* const [COMMON_EVENT_MINORSMODE_OFF](common_event/commonEventManager-definitions.md#common_event_minorsmode_off12) = "usual.event.MINORSMODE_OFF"| 表示未成年人模式关闭的公共事件。| 143## 类型定义说明 144 145### CommonEvent_SubscribeInfo 146 147```c 148typedef struct CommonEvent_SubscribeInfo CommonEvent_SubscribeInfo 149``` 150 151**描述** 152 153订阅者信息。 154 155**起始版本：** 12 156 157### CommonEvent_Subscriber 158 159```c 160typedef void CommonEvent_Subscriber 161``` 162 163**描述** 164 165订阅者。 166 167**起始版本：** 12 168 169### CommonEvent_RcvData 170 171```c 172typedef struct CommonEvent_RcvData CommonEvent_RcvData 173``` 174 175**描述** 176 177公共事件的回调数据。 178 179**起始版本：** 12 180 181### CommonEvent_Parameters 182 183```c 184typedef void CommonEvent_Parameters 185``` 186 187**描述** 188 189公共事件的回调附加信息。 190 191**起始版本：** 12 192 193### CommonEvent_ReceiveCallback 194 195```c 196typedef void (*CommonEvent_ReceiveCallback)(const CommonEvent_RcvData *data) 197``` 198 199**描述** 200 201公共事件的回调函数。 202 203**起始版本：** 12 204 205 206## 枚举类型说明 207 208### CommonEvent_ErrCode 209**描述** 210 211表示错误码信息。 212 213**起始版本：** 12 214 215| 枚举值 | 描述 | 216| -------- | -------- | 217| COMMONEVENT_ERR_OK = 0 |执行成功。| 218| COMMONEVENT_ERR_PERMISSION_ERROR = 201 |没有权限。| 219| COMMONEVENT_ERR_INVALID_PARAMETER = 401 |无效的参数。| 220| COMMONEVENT_ERR_SENDING_REQUEST_FAILED = 1500007 |发送IPC请求失败。| 221| COMMONEVENT_ERR_INIT_UNDONE = 1500008|服务未初始化。| 222| COMMONEVENT_ERR_SUBSCRIBER_NUM_EXCEEDED = 1500010|订阅者数量超过200个。| 223| COMMONEVENT_ERR_ALLOC_MEMORY_FAILED = 1500011|系统分配内存失败。| 224 225## 常量说明 226 227### COMMON_EVENT_SHUTDOWN 228 229```c 230static const char* const COMMON_EVENT_SHUTDOWN = "usual.event.SHUTDOWN" 231``` 232 233**描述** 234 235表示设备正在关闭并将继续直至最终关闭的公共事件。 236 237**起始版本：** 12 238 239### COMMON_EVENT_BATTERY_CHANGED 240 241```c 242static const char* const COMMON_EVENT_BATTERY_CHANGED = "usual.event.BATTERY_CHANGED" 243``` 244 245**描述** 246 247表示电池充电状态、电平和其他信息发生变化的公共事件。 248 249**起始版本：** 12 250 251### COMMON_EVENT_BATTERY_LOW 252 253```c 254static const char* const COMMON_EVENT_BATTERY_LOW = "usual.event.BATTERY_LOW" 255``` 256 257**描述** 258 259表示电池电量低的公共事件。 260 261**起始版本：** 12 262 263### COMMON_EVENT_BATTERY_OKAY 264 265```c 266static const char* const COMMON_EVENT_BATTERY_OKAY = "usual.event.BATTERY_OKAY" 267``` 268 269**描述** 270 271表示电池退出低电平状态的公共事件。 272 273**起始版本：** 12 274 275### COMMON_EVENT_POWER_CONNECTED 276 277```c 278static const char* const COMMON_EVENT_POWER_CONNECTED = "usual.event.POWER_CONNECTED" 279``` 280 281**描述** 282 283表示设备连接到外部电源的公共事件。 284 285**起始版本：** 12 286 287### COMMON_EVENT_POWER_DISCONNECTED 288 289```c 290static const char* const COMMON_EVENT_POWER_DISCONNECTED = "usual.event.POWER_DISCONNECTED" 291``` 292 293**描述** 294 295表示设备与外部电源断开的公共事件。 296 297**起始版本：** 12 298 299### COMMON_EVENT_SCREEN_OFF 300 301```c 302static const char* const COMMON_EVENT_SCREEN_OFF = "usual.event.SCREEN_OFF" 303``` 304 305**描述** 306 307表示设备屏幕关闭且设备处于睡眠状态的公共事件。 308 309**起始版本：** 12 310 311### COMMON_EVENT_SCREEN_ON 312 313```c 314static const char* const COMMON_EVENT_SCREEN_ON = "usual.event.SCREEN_ON" 315``` 316 317**描述** 318 319表示设备屏幕打开且设备处于交互状态的公共事件。 320 321**起始版本：** 12 322 323### COMMON_EVENT_THERMAL_LEVEL_CHANGED 324 325```c 326static const char* const COMMON_EVENT_THERMAL_LEVEL_CHANGED = "usual.event.THERMAL_LEVEL_CHANGED" 327``` 328 329**描述** 330 331表示设备热状态的公共事件。 332 333**起始版本：** 12 334 335### COMMON_EVENT_TIME_TICK 336 337```c 338static const char* const COMMON_EVENT_TIME_TICK = "usual.event.TIME_TICK" 339``` 340 341**描述** 342 343表示系统时间随时间流逝而发生变化的公共事件。 344 345**起始版本：** 12 346 347### COMMON_EVENT_TIME_CHANGED 348 349```c 350static const char* const COMMON_EVENT_TIME_CHANGED = "usual.event.TIME_CHANGED" 351``` 352 353**描述** 354 355表示系统时间被重新设置的公共事件。 356 357**起始版本：** 12 358 359### COMMON_EVENT_TIMEZONE_CHANGED 360 361```c 362static const char* const COMMON_EVENT_TIMEZONE_CHANGED = "usual.event.TIMEZONE_CHANGED" 363``` 364 365**描述** 366 367表示系统时区更改的公共事件。 368 369**起始版本：** 12 370 371### COMMON_EVENT_PACKAGE_ADDED 372 373```c 374static const char* const COMMON_EVENT_PACKAGE_ADDED = "usual.event.PACKAGE_ADDED" 375``` 376 377**描述** 378 379表示设备上已安装新应用包的公共事件。 380 381**起始版本：** 12 382 383### COMMON_EVENT_PACKAGE_REMOVED 384 385```c 386static const char* const COMMON_EVENT_PACKAGE_REMOVED = "usual.event.PACKAGE_REMOVED" 387``` 388 389**描述** 390 391表示已从设备卸载已安装的应用程序，但应用程序数据保留的公共事件。 392 393**起始版本：** 12 394 395### COMMON_EVENT_BUNDLE_REMOVED 396 397```c 398static const char* const COMMON_EVENT_BUNDLE_REMOVED = "usual.event.BUNDLE_REMOVED" 399``` 400 401**描述** 402 403表示已从设备中卸载已安装的捆绑包，但应用程序数据仍保留的公共事件。 404 405**起始版本：** 12 406 407### COMMON_EVENT_PACKAGE_FULLY_REMOVED 408 409```c 410static const char* const COMMON_EVENT_PACKAGE_FULLY_REMOVED = "usual.event.PACKAGE_FULLY_REMOVED" 411``` 412 413**描述** 414 415表示已从设备中完全卸载已安装的应用程序（包括应用程序数据和代码）的公共事件。 416 417**起始版本：** 12 418 419### COMMON_EVENT_PACKAGE_CHANGED 420 421```c 422static const char* const COMMON_EVENT_PACKAGE_CHANGED = "usual.event.PACKAGE_CHANGED" 423``` 424 425**描述** 426 427表示应用包已更改的公共事件（例如，包中的组件已启用或禁用）。 428 429**起始版本：** 12 430 431### COMMON_EVENT_PACKAGE_RESTARTED 432 433```c 434static const char* const COMMON_EVENT_PACKAGE_RESTARTED = "usual.event.PACKAGE_RESTARTED" 435``` 436 437**描述** 438 439表示用户重启应用包并杀死其所有进程的公共事件。 440 441**起始版本：** 12 442 443### COMMON_EVENT_PACKAGE_DATA_CLEARED 444 445```c 446static const char* const COMMON_EVENT_PACKAGE_DATA_CLEARED = "usual.event.PACKAGE_DATA_CLEARED" 447``` 448 449**描述** 450 451表示用户清除应用包数据的公共事件。 452 453**起始版本：** 12 454 455### COMMON_EVENT_PACKAGE_CACHE_CLEARED 456 457```c 458static const char* const COMMON_EVENT_PACKAGE_CACHE_CLEARED = "usual.event.PACKAGE_CACHE_CLEARED" 459``` 460 461**描述** 462 463表示用户清除应用包缓存数据的公共事件。 464 465**起始版本：** 12 466 467### COMMON_EVENT_PACKAGES_SUSPENDED 468 469```c 470static const char* const COMMON_EVENT_PACKAGES_SUSPENDED = "usual.event.PACKAGES_SUSPENDED" 471``` 472 473**描述** 474 475表示应用包已挂起的公共事件。 476 477**起始版本：** 12 478 479### COMMON_EVENT_MY_PACKAGE_SUSPENDED 480 481```c 482static const char* const COMMON_EVENT_MY_PACKAGE_SUSPENDED = "usual.event.MY_PACKAGE_SUSPENDED" 483``` 484 485**描述** 486 487表示应用程序包已被挂起的公共事件，该事件可以发送到被挂起的应用程序包。 488 489**起始版本：** 12 490 491### COMMON_EVENT_MY_PACKAGE_UNSUSPENDED 492 493```c 494static const char* const COMMON_EVENT_MY_PACKAGE_UNSUSPENDED = "usual.event.MY_PACKAGE_UNSUSPENDED" 495``` 496 497**描述** 498 499表示应用包未挂起的公共事件。 500 501**起始版本：** 12 502 503### COMMON_EVENT_LOCALE_CHANGED 504 505```c 506static const char* const COMMON_EVENT_LOCALE_CHANGED = "usual.event.LOCALE_CHANGED" 507``` 508 509**描述** 510 511表示设备区域设置已更改的公共事件。 512 513**起始版本：** 12 514 515### COMMON_EVENT_MANAGE_PACKAGE_STORAGE 516 517```c 518static const char* const COMMON_EVENT_MANAGE_PACKAGE_STORAGE = "usual.event.MANAGE_PACKAGE_STORAGE" 519``` 520 521**描述** 522 523表示设备存储空间不足的公共事件。 524 525**起始版本：** 12 526 527### COMMON_EVENT_USER_UNLOCKED 528 529```c 530static const char* const COMMON_EVENT_USER_UNLOCKED = "usual.event.USER_UNLOCKED" 531``` 532 533**描述** 534 535表示设备重启后解锁时，当前用户的凭据加密存储已解锁的公共事件。 536 537**起始版本：** 12 538 539### COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOUT 540 541```c 542static const char* const COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOUT = "common.event.DISTRIBUTED_ACCOUNT_LOGOUT" 543``` 544 545**描述** 546 547表示分布式账号登出成功的公共事件。 548 549**起始版本：** 12 550 551### COMMON_EVENT_DISTRIBUTED_ACCOUNT_TOKEN_INVALID 552 553```c 554static const char* const COMMON_EVENT_DISTRIBUTED_ACCOUNT_TOKEN_INVALID = "common.event.DISTRIBUTED_ACCOUNT_TOKEN_INVALID" 555``` 556 557**描述** 558 559表示分布式账号token令牌无效的公共事件。 560 561**起始版本：** 12 562 563### COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOFF 564 565```c 566static const char* const COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOFF = "common.event.DISTRIBUTED_ACCOUNT_LOGOFF" 567``` 568 569**描述** 570 571表示分布式账号注销的公共事件。 572 573**起始版本：** 12 574 575### COMMON_EVENT_WIFI_POWER_STATE 576 577```c 578static const char* const COMMON_EVENT_WIFI_POWER_STATE = "usual.event.wifi.POWER_STATE" 579``` 580 581**描述** 582 583表示Wi-Fi状态公共事件，如启用和禁用。 584 585**起始版本：** 12 586 587### COMMON_EVENT_WIFI_SCAN_FINISHED 588 589```c 590static const char* const COMMON_EVENT_WIFI_SCAN_FINISHED = "usual.event.wifi.SCAN_FINISHED" 591``` 592 593**描述** 594 595表示Wi-Fi接入点已被扫描并证明可用的公共事件。 596 597**起始版本：** 12 598 599### COMMON_EVENT_WIFI_RSSI_VALUE 600 601```c 602static const char* const COMMON_EVENT_WIFI_RSSI_VALUE = "usual.event.wifi.RSSI_VALUE" 603``` 604 605**描述** 606 607表示Wi-Fi信号强度（RSSI）改变的公共事件。 608 609**起始版本：** 12 610 611### COMMON_EVENT_WIFI_CONN_STATE 612 613```c 614static const char* const COMMON_EVENT_WIFI_CONN_STATE = "usual.event.wifi.CONN_STATE" 615``` 616 617**描述** 618 619表示Wi-Fi连接状态发生改变的公共事件。 620 621**起始版本：** 12 622 623### COMMON_EVENT_WIFI_HOTSPOT_STATE 624 625```c 626static const char* const COMMON_EVENT_WIFI_HOTSPOT_STATE = "usual.event.wifi.HOTSPOT_STATE" 627``` 628 629**描述** 630 631表示Wi-Fi热点状态的公共事件。 632 633**起始版本：** 12 634 635### COMMON_EVENT_WIFI_AP_STA_JOIN 636 637```c 638static const char* const COMMON_EVENT_WIFI_AP_STA_JOIN = "usual.event.wifi.WIFI_HS_STA_JOIN" 639``` 640 641**描述** 642 643表示客户端加入当前设备Wi-Fi热点的公共事件。 644 645**起始版本：** 12 646 647### COMMON_EVENT_WIFI_AP_STA_LEAVE 648 649```c 650static const char* const COMMON_EVENT_WIFI_AP_STA_LEAVE = "usual.event.wifi.WIFI_HS_STA_LEAVE" 651``` 652 653**描述** 654 655表示客户端已断开与当前设备Wi-Fi热点的连接的公共事件。 656 657**起始版本：** 12 658 659### COMMON_EVENT_WIFI_MPLINK_STATE_CHANGE 660 661```c 662static const char* const COMMON_EVENT_WIFI_MPLINK_STATE_CHANGE = "usual.event.wifi.mplink.STATE_CHANGE" 663``` 664 665**描述** 666 667表示MPLink（增强Wi-Fi功能）状态已更改的公共事件。 668 669**起始版本：** 12 670 671### COMMON_EVENT_WIFI_P2P_CONN_STATE 672 673```c 674static const char* const COMMON_EVENT_WIFI_P2P_CONN_STATE = "usual.event.wifi.p2p.CONN_STATE_CHANGE" 675``` 676 677**描述** 678 679表示Wi-Fi P2P连接状态改变的公共事件。 680 681**起始版本：** 12 682 683### COMMON_EVENT_WIFI_P2P_STATE_CHANGED 684 685```c 686static const char* const COMMON_EVENT_WIFI_P2P_STATE_CHANGED = "usual.event.wifi.p2p.STATE_CHANGE" 687``` 688 689**描述** 690 691表示Wi-Fi P2P状态公共事件，如启用和禁用。 692 693### COMMON_EVENT_WIFI_P2P_PEERS_STATE_CHANGED 694 695```c 696static const char* const COMMON_EVENT_WIFI_P2P_PEERS_STATE_CHANGED = "usual.event.wifi.p2p.DEVICES_CHANGE" 697``` 698 699**描述** 700 701表示Wi-Fi P2P对等体状态变化的公共事件。 702 703**起始版本：** 12 704 705### COMMON_EVENT_WIFI_P2P_PEERS_DISCOVERY_STATE_CHANGED 706 707```c 708static const char* const COMMON_EVENT_WIFI_P2P_PEERS_DISCOVERY_STATE_CHANGED = "usual.event.wifi.p2p.PEER_DISCOVERY_STATE_CHANGE" 709``` 710 711**描述** 712 713表示Wi-Fi P2P发现状态变化的公共事件。 714 715**起始版本：** 12 716 717### COMMON_EVENT_WIFI_P2P_CURRENT_DEVICE_STATE_CHANGED 718 719```c 720static const char* const COMMON_EVENT_WIFI_P2P_CURRENT_DEVICE_STATE_CHANGED = "usual.event.wifi.p2p.CURRENT_DEVICE_CHANGE" 721``` 722 723**描述** 724 725表示Wi-Fi P2P当前设备状态变化的公共事件。 726 727**起始版本：** 12 728 729### COMMON_EVENT_WIFI_P2P_GROUP_STATE_CHANGED 730 731```c 732static const char* const COMMON_EVENT_WIFI_P2P_GROUP_STATE_CHANGED = "usual.event.wifi.p2p.GROUP_STATE_CHANGED" 733``` 734 735**描述** 736 737表示Wi-Fi P2P群组信息已更改的公共事件。 738 739**起始版本：** 12 740 741### COMMON_EVENT_NFC_ACTION_ADAPTER_STATE_CHANGED 742 743```c 744static const char* const COMMON_EVENT_NFC_ACTION_ADAPTER_STATE_CHANGED = "usual.event.nfc.action.ADAPTER_STATE_CHANGED" 745``` 746 747**描述** 748 749表示设备NFC状态已更改的公共事件。 750 751**起始版本：** 12 752 753### COMMON_EVENT_NFC_ACTION_RF_FIELD_ON_DETECTED 754 755```c 756static const char* const COMMON_EVENT_NFC_ACTION_RF_FIELD_ON_DETECTED = "usual.event.nfc.action.RF_FIELD_ON_DETECTED" 757``` 758 759**描述** 760 761表示检测到NFC场强进入的公共事件。 762 763**起始版本：** 12 764 765### COMMON_EVENT_NFC_ACTION_RF_FIELD_OFF_DETECTED 766 767```c 768static const char* const COMMON_EVENT_NFC_ACTION_RF_FIELD_OFF_DETECTED = "usual.event.nfc.action.RF_FIELD_OFF_DETECTED" 769``` 770 771**描述** 772 773表示检测到NFC场强离开的公共事件。 774 775**起始版本：** 12 776 777### COMMON_EVENT_DISCHARGING 778 779```c 780static const char* const COMMON_EVENT_DISCHARGING = "usual.event.DISCHARGING" 781``` 782 783**描述** 784 785表示系统停止为电池充电的公共事件。 786 787**起始版本：** 12 788 789### COMMON_EVENT_CHARGING 790 791```c 792static const char* const COMMON_EVENT_CHARGING = "usual.event.CHARGING" 793``` 794 795**描述** 796 797表示系统开始为电池充电的公共事件。 798 799### COMMON_EVENT_DEVICE_IDLE_MODE_CHANGED 800 801```c 802static const char* const COMMON_EVENT_DEVICE_IDLE_MODE_CHANGED = "usual.event.DEVICE_IDLE_MODE_CHANGED" 803``` 804 805**描述** 806 807表示系统待机空闲模式已更改的公共事件。 808 809**起始版本：** 12 810 811### COMMON_EVENT_CHARGE_IDLE_MODE_CHANGED 812 813```c 814static const char* const COMMON_EVENT_CHARGE_IDLE_MODE_CHANGED = "usual.event.CHARGE_IDLE_MODE_CHANGED" 815``` 816 817**描述** 818 819表示设备进入充电空闲模式的公共事件。 820 821**起始版本：** 12 822 823### COMMON_EVENT_POWER_SAVE_MODE_CHANGED 824 825```c 826static const char* const COMMON_EVENT_POWER_SAVE_MODE_CHANGED = "usual.event.POWER_SAVE_MODE_CHANGED" 827``` 828 829**描述** 830 831表示系统节能模式更改的公共事件。 832 833**起始版本：** 12 834 835### COMMON_EVENT_USB_STATE 836 837```c 838static const char* const COMMON_EVENT_USB_STATE = "usual.event.hardware.usb.action.USB_STATE" 839``` 840 841**描述** 842 843表示USB设备状态发生变化的公共事件。 844 845**起始版本：** 12 846 847### COMMON_EVENT_USB_PORT_CHANGED 848 849```c 850static const char* const COMMON_EVENT_USB_PORT_CHANGED = "usual.event.hardware.usb.action.USB_PORT_CHANGED" 851``` 852 853**描述** 854 855表示用户设备的USB端口状态发生改变的公共事件。 856 857**起始版本：** 12 858 859### COMMON_EVENT_USB_DEVICE_ATTACHED 860 861```c 862static const char* const COMMON_EVENT_USB_DEVICE_ATTACHED = "usual.event.hardware.usb.action.USB_DEVICE_ATTACHED" 863``` 864 865**描述** 866 867当用户设备作为USB主机时，USB设备已挂载的公共事件。 868 869**起始版本：** 12 870 871### COMMON_EVENT_USB_DEVICE_DETACHED 872 873```c 874static const char* const COMMON_EVENT_USB_DEVICE_DETACHED = "usual.event.hardware.usb.action.USB_DEVICE_DETACHED" 875``` 876 877**描述** 878 879当用户设备作为USB主机时，USB设备被卸载的公共事件。 880 881**起始版本：** 12 882 883### COMMON_EVENT_AIRPLANE_MODE_CHANGED 884 885```c 886static const char* const COMMON_EVENT_AIRPLANE_MODE_CHANGED = "usual.event.AIRPLANE_MODE" 887``` 888 889**描述** 890 891表示设备飞行模式已更改的公共事件。 892 893**起始版本：** 12 894 895### COMMON_EVENT_SPLIT_SCREEN 896 897```c 898static const char* const COMMON_EVENT_SPLIT_SCREEN = "common.event.SPLIT_SCREEN" 899``` 900 901**描述** 902 903表示分屏的公共事件。 904 905**起始版本：** 12 906 907### COMMON_EVENT_QUICK_FIX_APPLY_RESULT 908 909```c 910static const char* const COMMON_EVENT_QUICK_FIX_APPLY_RESULT = "usual.event.QUICK_FIX_APPLY_RESULT" 911``` 912 913**描述** 914 915表示快速修复应用的公共事件。 916 917**起始版本：** 12 918 919### COMMON_EVENT_QUICK_FIX_REVOKE_RESULT 920 921```c 922static const char* const COMMON_EVENT_QUICK_FIX_REVOKE_RESULT = "usual.event.QUICK_FIX_REVOKE_RESULT" 923``` 924 925**描述** 926 927表示撤销快速修复的公共事件。 928 929**起始版本：** 12 930 931### COMMON_EVENT_USER_INFO_UPDATED 932 933```c 934static const char* const COMMON_EVENT_USER_INFO_UPDATED = "usual.event.USER_INFO_UPDATED" 935``` 936 937**描述** 938 939表示用户信息已更新的公共事件。 940 941**起始版本：** 12 942 943### COMMON_EVENT_SIM_STATE_CHANGED 944 945```c 946static const char* const COMMON_EVENT_SIM_STATE_CHANGED = "usual.event.SIM_STATE_CHANGED" 947``` 948 949**描述** 950 951表示SIM卡状态更新的公共事件。 952 953**起始版本：** 12 954 955### COMMON_EVENT_CALL_STATE_CHANGED 956 957```c 958static const char* const COMMON_EVENT_CALL_STATE_CHANGED = "usual.event.CALL_STATE_CHANGED" 959``` 960 961**描述** 962 963表示呼叫状态更新的公共事件。 964 965**起始版本：** 12 966 967### COMMON_EVENT_NETWORK_STATE_CHANGED 968 969```c 970static const char* const COMMON_EVENT_NETWORK_STATE_CHANGED = "usual.event.NETWORK_STATE_CHANGED" 971``` 972 973**描述** 974 975表示网络状态更新的公共事件。 976 977**起始版本：** 12 978 979### COMMON_EVENT_SIGNAL_INFO_CHANGED 980 981```c 982static const char* const COMMON_EVENT_SIGNAL_INFO_CHANGED = "usual.event.SIGNAL_INFO_CHANGED" 983``` 984 985**描述** 986 987表示信号信息更新的公共事件。 988 989**起始版本：** 12 990 991### COMMON_EVENT_SCREEN_UNLOCKED 992 993```c 994static const char* const COMMON_EVENT_SCREEN_UNLOCKED = "usual.event.SCREEN_UNLOCKED" 995``` 996 997**描述** 998 999表示屏幕解锁的公共事件。 1000 1001**起始版本：** 12 1002 1003### COMMON_EVENT_SCREEN_LOCKED 1004 1005```c 1006static const char* const COMMON_EVENT_SCREEN_LOCKED = "usual.event.SCREEN_LOCKED" 1007``` 1008 1009**描述** 1010 1011表示屏幕锁定的公共事件。 1012 1013**起始版本：** 12 1014 1015### COMMON_EVENT_HTTP_PROXY_CHANGE 1016 1017```c 1018static const char* const COMMON_EVENT_HTTP_PROXY_CHANGE = "usual.event.HTTP_PROXY_CHANGE" 1019``` 1020 1021**描述** 1022 1023表示HTTP代理的配置信息发生变化的公共事件。 1024 1025**起始版本：** 12 1026 1027### COMMON_EVENT_CONNECTIVITY_CHANGE 1028 1029```c 1030static const char* const COMMON_EVENT_CONNECTIVITY_CHANGE = "usual.event.CONNECTIVITY_CHANGE" 1031``` 1032 1033**描述** 1034 1035表示网络连接状态变化的公共事件。 1036 1037**起始版本：** 12 1038 1039### COMMON_EVENT_MINORSMODE_ON 1040 1041```c 1042static const char* const COMMON_EVENT_MINORSMODE_ON = "usual.event.MINORSMODE_ON" 1043``` 1044 1045**描述** 1046 1047表示未成年人模式开启的公共事件。 1048 1049**起始版本：** 12 1050 1051### COMMON_EVENT_MINORSMODE_OFF 1052 1053```c 1054static const char* const COMMON_EVENT_MINORSMODE_OFF = "usual.event.MINORSMODE_OFF" 1055``` 1056 1057**描述** 1058 1059表示未成年人模式关闭的公共事件。 1060 1061**起始版本：** 12 1062 1063## 函数说明 1064 1065### OH_CommonEvent_CreateSubscribeInfo 1066 1067```cpp 1068CommonEvent_SubscribeInfo* OH_CommonEvent_CreateSubscribeInfo(const char* events[], int32_t eventsNum) 1069``` 1070 1071**描述** 1072 1073创建订阅者信息。 1074 1075**起始版本：** 12 1076 1077**参数:** 1078 1079| 名称 | 描述 | 1080| -------- | -------- | 1081| events | 订阅的事件。 | 1082| eventsNum | 事件数量。 | 1083 1084**返回：** 1085 1086返回订阅者信息。 1087 1088### OH_CommonEvent_SetPublisherPermission 1089 1090```cpp 1091CommonEvent_ErrCode OH_CommonEvent_SetPublisherPermission(CommonEvent_SubscribeInfo* info, const char* permission) 1092``` 1093 1094**描述** 1095 1096设置订阅者权限。 1097 1098**起始版本：** 12 1099 1100**参数:** 1101 1102| 名称 | 描述 | 1103| -------- | -------- | 1104| info | 订阅者信息。 | 1105| permission | 权限名称。 | 1106 1107**返回：** 1108 1109返回COMMONEVENT_ERR_OK表示成功；返回COMMONEVENT_ERR_INVALID_PARAMETER表示info为空指针。 1110 1111### OH_CommonEvent_SetPublisherBundleName 1112 1113```cpp 1114CommonEvent_ErrCode OH_CommonEvent_SetPublisherBundleName(CommonEvent_SubscribeInfo* info, const char* bundleName) 1115``` 1116 1117**描述** 1118 1119设置订阅者包名称。 1120 1121**起始版本：** 12 1122 1123**参数:** 1124 1125| 名称 | 描述 | 1126| -------- | -------- | 1127| info | 订阅者信息。 | 1128| bundleName | 包名称。 | 1129 1130**返回：** 1131 1132返回COMMONEVENT_ERR_OK表示成功；返回COMMONEVENT_ERR_INVALID_PARAMETER表示info为空指针。 1133 1134### OH_CommonEvent_DestroySubscribeInfo 1135 1136```cpp 1137void OH_CommonEvent_DestroySubscribeInfo(CommonEvent_SubscribeInfo* info) 1138``` 1139 1140**描述** 1141 1142销毁订阅者信息。 1143 1144**起始版本：** 12 1145 1146**参数:** 1147 1148| 名称 | 描述 | 1149| -------- | -------- | 1150| info | 订阅者信息。 | 1151 1152### OH_CommonEvent_CreateSubscriber 1153 1154```cpp 1155CommonEvent_Subscriber* OH_CommonEvent_CreateSubscriber(const CommonEvent_SubscribeInfo* info, CommonEvent_ReceiveCallback callback) 1156``` 1157 1158**描述** 1159 1160创建订阅者。 1161 1162**起始版本：** 12 1163 1164**参数:** 1165 1166| 名称 | 描述 | 1167| -------- | -------- | 1168| info | 订阅者信息。 | 1169| callback | 事件回调函数。 | 1170 1171**返回：** 1172 1173返回订阅者。 1174 1175### OH_CommonEvent_DestroySubscriber 1176 1177```cpp 1178void OH_CommonEvent_DestroySubscriber(CommonEvent_Subscriber* subscriber) 1179``` 1180 1181**描述** 1182 1183销毁订阅者。 1184 1185**起始版本：** 12 1186 1187**参数:** 1188 1189| 名称 | 描述 | 1190| -------- | -------- | 1191| subscriber | 订阅者。 | 1192 1193### OH_CommonEvent_Subscribe 1194 1195```cpp 1196CommonEvent_ErrCode OH_CommonEvent_Subscribe(const CommonEvent_Subscriber* subscriber) 1197``` 1198 1199**描述** 1200 1201订阅公共事件。 1202 1203**起始版本：** 12 1204 1205**参数:** 1206 1207| 名称 | 描述 | 1208| -------- | -------- | 1209| subscriber | 订阅者。 | 1210 1211**返回：** 1212 1213返回COMMONEVENT_ERR_OK表示成功；返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数subscriber为空；返回COMMONEVENT_ERR_SENDING_REQUEST_FAILED表示IPC发送失败；返回COMMONEVENT_ERR_INIT_UNDONE表示公共事件服务未初始化；返回COMMONEVENT_ERR_SUBSCRIBER_NUM_EXCEEDED表示当前进程订阅者超过200个；返回COMMONEVENT_ERR_ALLOC_MEMORY_FAILED表示系统分配内存失败。 1214 1215### OH_CommonEvent_UnSubscribe 1216 1217```cpp 1218CommonEvent_ErrCode OH_CommonEvent_UnSubscribe(const CommonEvent_Subscriber* subscriber) 1219``` 1220 1221**描述** 1222 1223退订公共事件。 1224 1225**起始版本：** 12 1226 1227**参数:** 1228 1229| 名称 | 描述 | 1230| -------- | -------- | 1231| subscriber | 订阅者。 | 1232 1233**返回：** 1234 1235返回COMMONEVENT_ERR_OK表示成功；返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数subscriber为空；返回COMMONEVENT_ERR_SENDING_REQUEST_FAILED表示IPC发送失败；返回COMMONEVENT_ERR_INIT_UNDONE表示公共事件服务未初始化。 1236 1237### OH_CommonEvent_GetEventFromRcvData 1238 1239```cpp 1240const char* OH_CommonEvent_GetEventFromRcvData(const CommonEvent_RcvData* rcvData) 1241``` 1242 1243**描述** 1244 1245获取回调公共事件名称。 1246 1247**起始版本：** 12 1248 1249**参数:** 1250 1251| 名称 | 描述 | 1252| -------- | -------- | 1253| rcvData | 公共事件回调数据。 | 1254 1255**返回：** 1256 1257返回公共事件名称。 1258 1259### OH_CommonEvent_GetCodeFromRcvData 1260 1261```cpp 1262int32_t OH_CommonEvent_GetCodeFromRcvData(const CommonEvent_RcvData* rcvData) 1263``` 1264 1265**描述** 1266 1267获取回调公共事件结果代码。 1268 1269**起始版本：** 12 1270 1271**参数:** 1272 1273| 名称 | 描述 | 1274| -------- | -------- | 1275| rcvData | 公共事件回调数据。 | 1276 1277**返回：** 1278 1279返回公共事件结果代码。默认为0。 1280 1281### OH_CommonEvent_GetDataStrFromRcvData 1282 1283```cpp 1284const char* OH_CommonEvent_GetDataStrFromRcvData(const CommonEvent_RcvData* rcvData) 1285``` 1286 1287**描述** 1288 1289获取回调公共事件自定义结果数据。 1290 1291**起始版本：** 12 1292 1293**参数:** 1294 1295| 名称 | 描述 | 1296| -------- | -------- | 1297| rcvData | 公共事件回调数据。 | 1298 1299**返回：** 1300 1301返回公共事件自定义结果数据。默认为null。 1302 1303### OH_CommonEvent_GetBundleNameFromRcvData 1304 1305```cpp 1306const char* OH_CommonEvent_GetBundleNameFromRcvData(const CommonEvent_RcvData* rcvData) 1307``` 1308 1309**描述** 1310 1311获取回调公共事件包名称。 1312 1313**起始版本：** 12 1314 1315**参数:** 1316 1317| 名称 | 描述 | 1318| -------- | -------- | 1319| rcvData | 公共事件回调数据。 | 1320 1321**返回：** 1322 1323返回公共事件包名称。默认为null。 1324 1325### OH_CommonEvent_GetParametersFromRcvData 1326 1327```cpp 1328const CommonEvent_Parameters* OH_CommonEvent_GetParametersFromRcvData(const CommonEvent_RcvData* rcvData) 1329``` 1330 1331**描述** 1332 1333获取回调公共事件附件信息。 1334 1335**起始版本：** 12 1336 1337**参数:** 1338 1339| 名称 | 描述 | 1340| -------- | -------- | 1341| rcvData | 公共事件回调数据。 | 1342 1343**返回：** 1344 1345返回公共事件附加信息。默认为null。 1346 1347### OH_CommonEvent_HasKeyInParameters 1348 1349```cpp 1350bool OH_CommonEvent_HasKeyInParameters(const CommonEvent_Parameters* para, const char* key) 1351``` 1352 1353**描述** 1354 1355查询公共事件附加信息中是否存在该键值对信息。 1356 1357**起始版本：** 12 1358 1359**参数:** 1360 1361| 名称 | 描述 | 1362| -------- | -------- | 1363| para | 公共事件附加信息。 | 1364| key | 数据键。 | 1365 1366**返回：** 1367 1368返回true表示存在该键值对信息，返回false表示不存在。 1369 1370### OH_CommonEvent_GetIntFromParameters 1371 1372```cpp 1373int OH_CommonEvent_GetIntFromParameters(const CommonEvent_Parameters* para, const char* key, const int defaultValue) 1374``` 1375 1376**描述** 1377 1378获取公共事件附加信息中键为key的int类型数据。 1379 1380**起始版本：** 12 1381 1382**参数:** 1383 1384| 名称 | 描述 | 1385| -------- | -------- | 1386| para | 公共事件附加信息。 | 1387| key | 数据键。 | 1388| defaultValue | 默认返回值。 | 1389 1390### OH_CommonEvent_GetIntArrayFromParameters 1391 1392```cpp 1393int32_t OH_CommonEvent_GetIntArrayFromParameters(const CommonEvent_Parameters* para, const char* key, int** array) 1394``` 1395 1396**描述** 1397 1398获取公共事件附加信息中键为key的int数组数据。 1399 1400**起始版本：** 12 1401 1402**参数:** 1403 1404| 名称 | 描述 | 1405| -------- | -------- | 1406| para | 公共事件附加信息。 | 1407| key | 数据键。 | 1408| array | 接收数据的int数组。 | 1409 1410**返回：** 1411 1412返回数组长度。 1413 1414### OH_CommonEvent_GetLongFromParameters 1415 1416```cpp 1417long OH_CommonEvent_GetLongFromParameters(const CommonEvent_Parameters* para, const char* key, const long defaultValue) 1418``` 1419 1420**描述** 1421 1422获取公共事件附加信息中键为key的long类型数据。 1423 1424**起始版本：** 12 1425 1426**参数:** 1427 1428| 名称 | 描述 | 1429| -------- | -------- | 1430| para | 公共事件附加信息。 | 1431| key | 数据键。 | 1432| defaultValue | 默认返回值。 | 1433 1434### OH_CommonEvent_GetLongArrayFromParameters 1435 1436```cpp 1437int32_t OH_CommonEvent_GetLongArrayFromParameters(const CommonEvent_Parameters* para, const char* key, long** array) 1438``` 1439 1440**描述** 1441 1442获取公共事件附加信息中键为key的long数组数据。 1443 1444**起始版本：** 12 1445 1446**参数:** 1447 1448| 名称 | 描述 | 1449| -------- | -------- | 1450| para | 公共事件附加信息。 | 1451| key | 数据键。 | 1452| array | 接收数据的long数组。 | 1453 1454**返回：** 1455 1456返回数组长度。 1457 1458### OH_CommonEvent_GetBoolFromParameters 1459 1460```cpp 1461bool OH_CommonEvent_GetBoolFromParameters(const CommonEvent_Parameters* para, const char* key, const bool defaultValue) 1462``` 1463 1464**描述** 1465 1466获取公共事件附加信息中键为key的布尔类型数据。 1467 1468**起始版本：** 12 1469 1470**参数:** 1471 1472| 名称 | 描述 | 1473| -------- | -------- | 1474| para | 公共事件附加信息。 | 1475| key | 数据键。 | 1476| defaultValue | 默认返回值。 | 1477 1478### OH_CommonEvent_GetBoolArrayFromParameters 1479 1480```cpp 1481int32_t OH_CommonEvent_GetBoolArrayFromParameters(const CommonEvent_Parameters* para, const char* key, bool** array) 1482``` 1483 1484**描述** 1485 1486获取公共事件附加信息中键为key的布尔数组数据。 1487 1488**起始版本：** 12 1489 1490**参数:** 1491 1492| 名称 | 描述 | 1493| -------- | -------- | 1494| para | 公共事件附加信息。 | 1495| key | 数据键。 | 1496| array | 接收数据的long数组。 | 1497 1498**返回：** 1499 1500返回数组长度。 1501 1502### OH_CommonEvent_GetCharFromParameters 1503 1504```cpp 1505char OH_CommonEvent_GetCharFromParameters(const CommonEvent_Parameters* para, const char* key, const char defaultValue) 1506``` 1507 1508**描述** 1509 1510获取公共事件附加信息中键为key的字符类型数据。 1511 1512**起始版本：** 12 1513 1514**参数:** 1515 1516| 名称 | 描述 | 1517| -------- | -------- | 1518| para | 公共事件附加信息。 | 1519| key | 数据键。 | 1520| defaultValue | 默认返回值。 | 1521 1522### OH_CommonEvent_GetCharArrayFromParameters 1523 1524```cpp 1525int32_t OH_CommonEvent_GetCharArrayFromParameters(const CommonEvent_Parameters* para, const char* key, char** array) 1526``` 1527 1528**描述** 1529 1530获取公共事件附加信息中键为key的字符数组数据。 1531 1532**起始版本：** 12 1533 1534**参数:** 1535 1536| 名称 | 描述 | 1537| -------- | -------- | 1538| para | 公共事件附加信息。 | 1539| key | 数据键。 | 1540| array | 接收数据的字符数组。 | 1541 1542**返回：** 1543 1544返回数组长度。 1545 1546### OH_CommonEvent_GetDoubleFromParameters 1547 1548```cpp 1549double OH_CommonEvent_GetDoubleFromParameters(const CommonEvent_Parameters* para, const char* key, const double defaultValue) 1550``` 1551 1552**描述** 1553 1554获取公共事件附加信息中键为key的double类型数据。 1555 1556**起始版本：** 12 1557 1558**参数:** 1559 1560| 名称 | 描述 | 1561| -------- | -------- | 1562| para | 公共事件附加信息。 | 1563| key | 数据键。 | 1564| defaultValue | 默认返回值。 | 1565 1566### OH_CommonEvent_GetDoubleArrayFromParameters 1567 1568```cpp 1569int32_t OH_CommonEvent_GetDoubleArrayFromParameters(const CommonEvent_Parameters* para, const char* key, double** array) 1570``` 1571 1572**描述** 1573 1574获取公共事件附加信息中键为key的double数组数据。 1575 1576**起始版本：** 12 1577 1578**参数:** 1579 1580| 名称 | 描述 | 1581| -------- | -------- | 1582| para | 公共事件附加信息。 | 1583| key | 数据键。 | 1584| array | 接收数据的字符数组。 | 1585 1586**返回：** 1587 1588返回数组长度。默认为0。 1589