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|[CommonEvent_PublishInfo](#commonevent_publishinfo)| 公共事件属性对象。 | 34 35### 枚举 36 37| 名称 | 描述 | 38| -------- | -------- | 39| [CommonEvent_ErrCode](#commonevent_errcode) | 枚举错误码。 | 40 41 42### 函数 43 44| 名称 | 描述 | 45| -------- | -------- | 46| [OH_CommonEvent_CreateSubscribeInfo](#oh_commonevent_createsubscribeinfo)| 创建订阅者信息。 | 47| [OH_CommonEvent_SetPublisherPermission](#oh_commonevent_setpublisherpermission) | 设置订阅者权限。 | 48| [OH_CommonEvent_SetPublisherBundleName](#oh_commonevent_setpublisherbundlename) | 设置订阅者包名称。 | 49| [OH_CommonEvent_DestroySubscribeInfo](#oh_commonevent_destroysubscribeinfo) | 销毁订阅者信息。 | 50| [OH_CommonEvent_CreateSubscriber](#oh_commonevent_createsubscriber)| 创建订阅者。 | 51| [OH_CommonEvent_DestroySubscriber](#oh_commonevent_destroysubscriber) | 销毁订阅者。 | 52| [OH_CommonEvent_Subscribe](#oh_commonevent_subscribe) | 订阅事件。 | 53| [OH_CommonEvent_UnSubscribe](#oh_commonevent_unsubscribe) | 退订事件。 | 54| [OH_CommonEvent_GetEventFromRcvData](#oh_commonevent_geteventfromrcvdata)| 获取公共事件名称。 | 55| [OH_CommonEvent_GetCodeFromRcvData](#oh_commonevent_getcodefromrcvdata) | 获取公共事件结果代码。 | 56| [OH_CommonEvent_GetDataStrFromRcvData](#oh_commonevent_getdatastrfromrcvdata)| 获取公共事件自定义结果数据。 | 57| [OH_CommonEvent_GetBundleNameFromRcvData](#oh_commonevent_getbundlenamefromrcvdata)| 获取公共事件包名称。 | 58| [OH_CommonEvent_GetParametersFromRcvData](#oh_commonevent_getparametersfromrcvdata) | 获取公共事件附加信息。 | 59| [OH_CommonEvent_HasKeyInParameters](#oh_commonevent_haskeyinparameters) | 检查公共事件附加信息中是否包含某个键值对信息。 | 60| [OH_CommonEvent_GetIntFromParameters](#oh_commonevent_getintfromparameters) | 获取公共事件附加信息中int数据信息。 | 61| [OH_CommonEvent_GetIntArrayFromParameters](#oh_commonevent_getintarrayfromparameters)| 获取公共事件附加信息中int数组信息。 | 62| [OH_CommonEvent_GetLongFromParameters](#oh_commonevent_getlongfromparameters)| 获取公共事件附加信息中long数据信息。 | 63| [OH_CommonEvent_GetLongArrayFromParameters](#oh_commonevent_getlongarrayfromparameters)| 获取公共事件附加信息中long数组信息。 | 64| [OH_CommonEvent_GetBoolFromParameters](#oh_commonevent_getboolfromparameters)| 获取公共事件附加信息中布尔数据信息。 | 65| [OH_CommonEvent_GetBoolArrayFromParameters](#oh_commonevent_getboolarrayfromparameters)| 获取公共事件附加信息中布尔数组信息。 | 66| [OH_CommonEvent_GetCharFromParameters](#oh_commonevent_getcharfromparameters)| 获取公共事件附加信息中字符数据信息。 | 67| [OH_CommonEvent_GetCharArrayFromParameters](#oh_commonevent_getchararrayfromparameters)| 获取公共事件附加信息中字符数组信息。 | 68| [OH_CommonEvent_GetDoubleFromParameters](#oh_commonevent_getdoublefromparameters)| 获取公共事件附加信息中double数据信息。 | 69| [OH_CommonEvent_GetDoubleArrayFromParameters](#oh_commonevent_getdoublearrayfromparameters)| 获取公共事件附加信息中double数组信息。 | 70| [OH_CommonEvent_CreateParameters](#oh_commonevent_createparameters)| 创建公共事件附加信息对象。 | 71| [OH_CommonEvent_DestroyParameters](#oh_commonevent_destroyparameters)| 销毁公共事件附加信息对象。 | 72| [OH_CommonEvent_SetIntToParameters](#oh_commonevent_setinttoparameters)| 设置公共事件附加信息的int类型内容。 | 73| [OH_CommonEvent_SetIntArrayToParameters](#oh_commonevent_setintarraytoparameters)| 设置公共事件附加信息的int数组内容。 | 74| [OH_CommonEvent_SetLongToParameters](#oh_commonevent_setlongtoparameters)| 设置公共事件附加信息的long类型内容。 | 75| [OH_CommonEvent_SetLongArrayToParameters](#oh_commonevent_setlongarraytoparameters)| 设置公共事件附加信息的long数组内容。 | 76| [OH_CommonEvent_SetDoubleToParameters](#oh_commonevent_setdoubletoparameters)| 设置公共事件附加信息的double类型内容。 | 77| [OH_CommonEvent_SetDoubleArrayToParameters](#oh_commonevent_setdoublearraytoparameters)| 设置公共事件附加信息的double数组内容。 | 78| [OH_CommonEvent_SetBoolToParameters](#oh_commonevent_setbooltoparameters)| 设置公共事件附加信息的布尔类型内容。 | 79| [OH_CommonEvent_SetBoolArrayToParameters](#oh_commonevent_setboolarraytoparameters)| 设置公共事件附加信息的布尔数组内容。 | 80| [OH_CommonEvent_SetCharToParameters](#oh_commonevent_setchartoparameters)| 设置公共事件附加信息的字符类型内容。 | 81| [OH_CommonEvent_SetCharArrayToParameters](#oh_commonevent_setchararraytoparameters)| 设置公共事件附加信息的字符数组内容。 | 82| [OH_CommonEvent_CreatePublishInfo](#oh_commonevent_createpublishinfo)| 创建公共事件属性对象。 | 83| [OH_CommonEvent_DestroyPublishInfo](#oh_commonevent_destroypublishinfo)| 销毁公共事件属性对象。 | 84| [OH_CommonEvent_SetPublishInfoBundleName](#oh_commonevent_setpublishinfobundlename)| 设置公共事件包名称。 | 85| [OH_CommonEvent_SetPublishInfoPermissions](#oh_commonevent_setpublishinfopermissions)| 设置公共事件权限。 | 86| [OH_CommonEvent_SetPublishInfoCode](#oh_commonevent_setpublishinfocode)| 设置公共事件结果码。 | 87| [OH_CommonEvent_SetPublishInfoData](#oh_commonevent_setpublishinfodata)| 设置公共事件结果数据。 | 88| [OH_CommonEvent_SetPublishInfoParameters](#oh_commonevent_setpublishinfoparameters)| 设置公共事件附加信息。 | 89| [OH_CommonEvent_Publish](#oh_commonevent_publish)| 发布自定义公共事件。 | 90| [OH_CommonEvent_PublishWithInfo](#oh_commonevent_publishwithinfo)| 发布带有指定属性的自定义公共事件。 | 91| [OH_CommonEvent_IsOrderedCommonEvent](#oh_commonevent_isorderedcommonevent)| 查询当前公共事件是否为有序公共事件。 | 92| [OH_CommonEvent_FinishCommonEvent](#oh_commonevent_finishcommonevent)| 用于订阅者结束对当前有序公共事件的处理。 | 93| [OH_CommonEvent_GetAbortCommonEvent](#oh_commonevent_getabortcommonevent)| 获取当前有序公共事件是否处于中止状态。 | 94| [OH_CommonEvent_AbortCommonEvent](#oh_commonevent_abortcommonevent)| 中止当前的有序公共事件。 | 95| [OH_CommonEvent_ClearAbortCommonEvent](#oh_commonevent_clearabortcommonevent)| 取消当前有序公共事件的中止状态。 | 96| [OH_CommonEvent_GetCodeFromSubscriber](#oh_commonevent_getcodefromsubscriber)| 获取有序公共事件代码。 | 97| [OH_CommonEvent_GetDataFromSubscriber](#oh_commonevent_getdatafromsubscriber)| 获取有序公共事件的数据。 | 98| [OH_CommonEvent_SetCodeToSubscriber](#oh_commonevent_setcodetosubscriber)| 设置有序公共事件的代码。 | 99| [OH_CommonEvent_SetDataToSubscriber](#oh_commonevent_setdatatosubscriber)| 设置有序公共事件的数据。 | 100 101### 常量 102| 名称 | 描述 | 103| -------- | -------- | 104|static const char* const [COMMON_EVENT_SHUTDOWN](common_event/commonEventManager-definitions.md#common_event_shutdown) = "usual.event.SHUTDOWN" | 表示设备正在关闭并将继续直至最终关闭的公共事件。 | 105|static const char* const [COMMON_EVENT_BATTERY_CHANGED](common_event/commonEventManager-definitions.md#common_event_battery_changed) = "usual.event.BATTERY_CHANGED" | 表示电池充电状态、电平和其他信息发生变化的公共事件。| 106|static const char* const [COMMON_EVENT_BATTERY_LOW](common_event/commonEventManager-definitions.md#common_event_battery_low) = "usual.event.BATTERY_LOW"|表示电池电量低的公共事件。 | 107|static const char* const [COMMON_EVENT_BATTERY_OKAY](common_event/commonEventManager-definitions.md#common_event_battery_okay) = "usual.event.BATTERY_OKAY"|表示电池退出低电平状态的公共事件。 | 108|static const char* const [COMMON_EVENT_POWER_CONNECTED](common_event/commonEventManager-definitions.md#common_event_power_connected) = "usual.event.POWER_CONNECTED"|表示设备连接到外部电源的公共事件。| 109|static const char* const [COMMON_EVENT_POWER_DISCONNECTED](common_event/commonEventManager-definitions.md#common_event_power_disconnected) = "usual.event.POWER_DISCONNECTED"|表示设备与外部电源断开的公共事件。| 110|static const char* const [COMMON_EVENT_SCREEN_OFF](common_event/commonEventManager-definitions.md#common_event_screen_off) = "usual.event.SCREEN_OFF"| 表示设备屏幕关闭且设备处于睡眠状态的公共事件。| 111|static const char* const [COMMON_EVENT_SCREEN_ON](common_event/commonEventManager-definitions.md#common_event_screen_on) = "usual.event.SCREEN_ON"|表示设备屏幕打开且设备处于交互状态的公共事件。 | 112|static const char* const [COMMON_EVENT_THERMAL_LEVEL_CHANGED](common_event/commonEventManager-definitions.md#common_event_thermal_level_changed) = "usual.event.THERMAL_LEVEL_CHANGED"|表示设备热状态的公共事件。 | 113|static const char* const [COMMON_EVENT_TIME_TICK](common_event/commonEventManager-definitions.md#common_event_time_tick) = "usual.event.TIME_TICK"|表示系统时间随时间流逝而发生变化的公共事件。 | 114|static const char* const [COMMON_EVENT_TIME_CHANGED](common_event/commonEventManager-definitions.md#common_event_time_changed) = "usual.event.TIME_CHANGED"|表示系统时间被重新设置的公共事件。 | 115|static const char* const [COMMON_EVENT_TIMEZONE_CHANGED](common_event/commonEventManager-definitions.md#common_event_timezone_changed) = "usual.event.TIMEZONE_CHANGED"|表示系统时区更改的公共事件。 | 116|static const char* const [COMMON_EVENT_PACKAGE_ADDED](common_event/commonEventManager-definitions.md#common_event_package_added) = "usual.event.PACKAGE_ADDED"| 表示设备上已安装新应用包的公共事件。| 117|static const char* const [COMMON_EVENT_PACKAGE_REMOVED](common_event/commonEventManager-definitions.md#common_event_package_removed) = "usual.event.PACKAGE_REMOVED"| 表示已安装的应用程序从设备中卸载，但应用程序数据保留的公共事件。| 118|static const char* const [COMMON_EVENT_BUNDLE_REMOVED](common_event/commonEventManager-definitions.md#common_event_bundle_removed) = "usual.event.BUNDLE_REMOVED"| 表示从设备中卸载已安装应用程序的附加包，但应用程序数据仍保留的公共事件。| 119|static const char* const [COMMON_EVENT_PACKAGE_FULLY_REMOVED](common_event/commonEventManager-definitions.md#common_event_package_fully_removed) = "usual.event.PACKAGE_FULLY_REMOVED"|表示已从设备中完全卸载已安装的应用程序（包括应用程序数据和代码）的公共事件。 | 120|static const char* const [COMMON_EVENT_PACKAGE_CHANGED](common_event/commonEventManager-definitions.md#common_event_package_changed) = "usual.event.PACKAGE_CHANGED"| 表示应用包已更改的公共事件（例如，包中的组件已启用或禁用）。| 121|static const char* const [COMMON_EVENT_PACKAGE_RESTARTED](common_event/commonEventManager-definitions.md#common_event_package_restarted) = "usual.event.PACKAGE_RESTARTED"| 表示用户重启应用包并杀死其所有进程的公共事件。| 122|static const char* const [COMMON_EVENT_PACKAGE_DATA_CLEARED](common_event/commonEventManager-definitions.md#common_event_package_data_cleared) = "usual.event.PACKAGE_DATA_CLEARED"| 表示用户清除应用包数据的公共事件。| 123|static const char* const [COMMON_EVENT_PACKAGE_CACHE_CLEARED](common_event/commonEventManager-definitions.md#common_event_package_cache_cleared) = "usual.event.PACKAGE_CACHE_CLEARED"|表示用户清除应用包缓存数据的公共事件。 | 124|static const char* const [COMMON_EVENT_PACKAGES_SUSPENDED](common_event/commonEventManager-definitions.md#common_event_packages_suspended) = "usual.event.PACKAGES_SUSPENDED"|表示应用包已挂起的公共事件。 | 125|static const char* const [COMMON_EVENT_MY_PACKAGE_SUSPENDED](common_event/commonEventManager-definitions.md#common_event_my_package_suspended) = "usual.event.MY_PACKAGE_SUSPENDED"| 表示应用程序包已被挂起的公共事件，该事件可以发送到被挂起的应用程序包。| 126|static const char* const [COMMON_EVENT_MY_PACKAGE_UNSUSPENDED](common_event/commonEventManager-definitions.md#common_event_my_package_unsuspended) = "usual.event.MY_PACKAGE_UNSUSPENDED"| 表示应用包未挂起的公共事件。 | 127|static const char* const [COMMON_EVENT_LOCALE_CHANGED](common_event/commonEventManager-definitions.md#common_event_locale_changed) = "usual.event.LOCALE_CHANGED"| 表示设备区域设置已更改的公共事件。| 128|static const char* const [COMMON_EVENT_MANAGE_PACKAGE_STORAGE](common_event/commonEventManager-definitions.md#common_event_manage_package_storage) = "usual.event.MANAGE_PACKAGE_STORAGE"| 设备存储空间不足的公共事件。| 129|static const char* const [COMMON_EVENT_USER_UNLOCKED](common_event/commonEventManager-definitions.md#common_event_user_unlocked) = "usual.event.USER_UNLOCKED"| 表示设备重启后解锁时，当前用户的凭据加密存储已解锁的公共事件。 | 130|static const char* const [COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOUT](common_event/commonEventManager-definitions.md#common_event_distributed_account_logout) = "common.event.DISTRIBUTED_ACCOUNT_LOGOUT"|表示分布式账号登出成功的公共事件。 | 131|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令牌无效的公共事件。 | 132|static const char* const [COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOFF](common_event/commonEventManager-definitions.md#common_event_distributed_account_logoff) = "common.event.DISTRIBUTED_ACCOUNT_LOGOFF"| 表示分布式账号注销的公共事件。| 133|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状态公共事件，如启用和禁用。| 134|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接入点已被扫描并证明可用的公共事件。 | 135|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）改变的公共事件。 | 136|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连接状态发生改变的公共事件。| 137|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热点状态的公共事件，如启用或禁用。| 138|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热点的公共事件。| 139|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热点的连接的公共事件。 | 140|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功能）状态已更改的公共事件。 | 141|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连接状态改变的公共事件。 | 142|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状态公共事件，如启用和禁用。 | 143|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对等体状态变化的公共事件。 | 144|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发现状态变化的公共事件。 | 145|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当前设备状态变化的公共事件。 | 146|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群组信息已更改的公共事件。 | 147|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状态已更改的公共事件。| 148|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场强进入的公共事件。 | 149|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场强离开的公共事件。 | 150|static const char* const [COMMON_EVENT_DISCHARGING](common_event/commonEventManager-definitions.md#common_event_discharging) = "usual.event.DISCHARGING"| 表示系统停止为电池充电的公共事件。| 151|static const char* const [COMMON_EVENT_CHARGING](common_event/commonEventManager-definitions.md#common_event_charging) = "usual.event.CHARGING"|表示系统开始为电池充电的公共事件。 | 152|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"| 表示系统待机空闲模式已更改的公共事件。| 153|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"|表示设备进入充电空闲模式的公共事件。 | 154|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"|表示系统节能模式更改的公共事件。 | 155|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设备状态发生变化的公共事件。 | 156|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端口状态发生改变的公共事件。 | 157|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设备已挂载的公共事件。 | 158|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设备被卸载的公共事件。 | 159|static const char* const [COMMON_EVENT_AIRPLANE_MODE_CHANGED](common_event/commonEventManager-definitions.md#common_event_airplane_mode_changed10) = "usual.event.AIRPLANE_MODE"| 表示设备飞行模式已更改的公共事件。| 160|static const char* const [COMMON_EVENT_SPLIT_SCREEN](common_event/commonEventManager-definitions.md#common_event_split_screen) = "common.event.SPLIT_SCREEN"| 表示分屏的公共事件。| 161|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"| 表示快速修复应用的公共事件。| 162|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"| 表示撤销快速修复的公共事件。| 163|static const char* const [COMMON_EVENT_USER_INFO_UPDATED](common_event/commonEventManager-definitions.md#common_event_user_info_updated) = "usual.event.USER_INFO_UPDATED"| 表示用户信息已更新的公共事件。| 164|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卡状态更新的公共事件。 | 165|static const char* const [COMMON_EVENT_CALL_STATE_CHANGED](common_event/commonEventManager-definitions.md#common_event_call_state_changed10) = "usual.event.CALL_STATE_CHANGED"| 表示呼叫状态更新的公共事件。| 166|static const char* const [COMMON_EVENT_NETWORK_STATE_CHANGED](common_event/commonEventManager-definitions.md#common_event_network_state_changed10) = "usual.event.NETWORK_STATE_CHANGED"| 表示网络状态更新的公共事件。| 167|static const char* const [COMMON_EVENT_SIGNAL_INFO_CHANGED](common_event/commonEventManager-definitions.md#common_event_signal_info_changed10) = "usual.event.SIGNAL_INFO_CHANGED"|表示信号信息更新的公共事件。 | 168|static const char* const [COMMON_EVENT_SCREEN_UNLOCKED](common_event/commonEventManager-definitions.md#common_event_screen_unlocked) = "usual.event.SCREEN_UNLOCKED"|表示屏幕解锁的公共事件。 | 169|static const char* const [COMMON_EVENT_SCREEN_LOCKED](common_event/commonEventManager-definitions.md#common_event_screen_locked) = "usual.event.SCREEN_LOCKED"| 表示屏幕锁定的公共事件。| 170|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代理的配置信息发生变化的公共事件。| 171|static const char* const [COMMON_EVENT_CONNECTIVITY_CHANGE](common_event/commonEventManager-definitions.md#common_event_connectivity_change10) = "usual.event.CONNECTIVITY_CHANGE"| 表示网络连接状态变化的公共事件。| 172|static const char* const [COMMON_EVENT_MINORSMODE_ON](common_event/commonEventManager-definitions.md#common_event_minorsmode_on12) = "usual.event.MINORSMODE_ON"|表示未成年人模式开启的公共事件。 | 173|static const char* const [COMMON_EVENT_MINORSMODE_OFF](common_event/commonEventManager-definitions.md#common_event_minorsmode_off12) = "usual.event.MINORSMODE_OFF"| 表示未成年人模式关闭的公共事件。| 174## 类型定义说明 175 176### CommonEvent_SubscribeInfo 177 178```c 179typedef struct CommonEvent_SubscribeInfo CommonEvent_SubscribeInfo 180``` 181 182**描述** 183 184订阅者信息。 185 186**起始版本：** 12 187 188### CommonEvent_Subscriber 189 190```c 191typedef void CommonEvent_Subscriber 192``` 193 194**描述** 195 196订阅者。 197 198**起始版本：** 12 199 200### CommonEvent_RcvData 201 202```c 203typedef struct CommonEvent_RcvData CommonEvent_RcvData 204``` 205 206**描述** 207 208公共事件的回调数据。 209 210**起始版本：** 12 211 212### CommonEvent_Parameters 213 214```c 215typedef void CommonEvent_Parameters 216``` 217 218**描述** 219 220公共事件的回调附加信息。 221 222**起始版本：** 12 223 224### CommonEvent_ReceiveCallback 225 226```c 227typedef void (*CommonEvent_ReceiveCallback)(const CommonEvent_RcvData *data) 228``` 229 230**描述** 231 232公共事件的回调函数。 233 234**起始版本：** 12 235 236### CommonEvent_PublishInfo 237 238```c 239typedef struct CommonEvent_PublishInfo CommonEvent_PublishInfo 240``` 241 242**描述** 243 244发布自定义公共事件时使用的公共事件属性对象。 245 246**起始版本：** 18 247 248## 枚举类型说明 249 250### CommonEvent_ErrCode 251**描述** 252 253表示错误码信息。 254 255**起始版本：** 12 256 257| 枚举值 | 描述 | 258| -------- | -------- | 259| COMMONEVENT_ERR_OK = 0 |执行成功。| 260| COMMONEVENT_ERR_PERMISSION_ERROR = 201 |没有权限。| 261| COMMONEVENT_ERR_INVALID_PARAMETER = 401 |无效的参数。| 262| COMMONEVENT_ERR_NOT_SYSTEM_SERVICE = 1500004 |当前应用无法发送系统公共事件。| 263| COMMONEVENT_ERR_SENDING_REQUEST_FAILED = 1500007 |发送IPC请求失败。| 264| COMMONEVENT_ERR_INIT_UNDONE = 1500008|服务未初始化。| 265| COMMONEVENT_ERR_SUBSCRIBER_NUM_EXCEEDED = 1500010|订阅者数量超过200个。| 266| COMMONEVENT_ERR_ALLOC_MEMORY_FAILED = 1500011|系统分配内存失败。| 267 268## 常量说明 269 270### COMMON_EVENT_SHUTDOWN 271 272```c 273static const char* const COMMON_EVENT_SHUTDOWN = "usual.event.SHUTDOWN" 274``` 275 276**描述** 277 278表示设备正在关闭并将继续直至最终关闭的公共事件。 279 280**起始版本：** 12 281 282### COMMON_EVENT_BATTERY_CHANGED 283 284```c 285static const char* const COMMON_EVENT_BATTERY_CHANGED = "usual.event.BATTERY_CHANGED" 286``` 287 288**描述** 289 290表示电池充电状态、电平和其他信息发生变化的公共事件。 291 292**起始版本：** 12 293 294### COMMON_EVENT_BATTERY_LOW 295 296```c 297static const char* const COMMON_EVENT_BATTERY_LOW = "usual.event.BATTERY_LOW" 298``` 299 300**描述** 301 302表示电池电量低的公共事件。 303 304**起始版本：** 12 305 306### COMMON_EVENT_BATTERY_OKAY 307 308```c 309static const char* const COMMON_EVENT_BATTERY_OKAY = "usual.event.BATTERY_OKAY" 310``` 311 312**描述** 313 314表示电池退出低电平状态的公共事件。 315 316**起始版本：** 12 317 318### COMMON_EVENT_POWER_CONNECTED 319 320```c 321static const char* const COMMON_EVENT_POWER_CONNECTED = "usual.event.POWER_CONNECTED" 322``` 323 324**描述** 325 326表示设备连接到外部电源的公共事件。 327 328**起始版本：** 12 329 330### COMMON_EVENT_POWER_DISCONNECTED 331 332```c 333static const char* const COMMON_EVENT_POWER_DISCONNECTED = "usual.event.POWER_DISCONNECTED" 334``` 335 336**描述** 337 338表示设备与外部电源断开的公共事件。 339 340**起始版本：** 12 341 342### COMMON_EVENT_SCREEN_OFF 343 344```c 345static const char* const COMMON_EVENT_SCREEN_OFF = "usual.event.SCREEN_OFF" 346``` 347 348**描述** 349 350表示设备屏幕关闭且设备处于睡眠状态的公共事件。 351 352**起始版本：** 12 353 354### COMMON_EVENT_SCREEN_ON 355 356```c 357static const char* const COMMON_EVENT_SCREEN_ON = "usual.event.SCREEN_ON" 358``` 359 360**描述** 361 362表示设备屏幕打开且设备处于交互状态的公共事件。 363 364**起始版本：** 12 365 366### COMMON_EVENT_THERMAL_LEVEL_CHANGED 367 368```c 369static const char* const COMMON_EVENT_THERMAL_LEVEL_CHANGED = "usual.event.THERMAL_LEVEL_CHANGED" 370``` 371 372**描述** 373 374表示设备热状态的公共事件。 375 376**起始版本：** 12 377 378### COMMON_EVENT_TIME_TICK 379 380```c 381static const char* const COMMON_EVENT_TIME_TICK = "usual.event.TIME_TICK" 382``` 383 384**描述** 385 386表示系统时间随时间流逝而发生变化的公共事件。 387 388**起始版本：** 12 389 390### COMMON_EVENT_TIME_CHANGED 391 392```c 393static const char* const COMMON_EVENT_TIME_CHANGED = "usual.event.TIME_CHANGED" 394``` 395 396**描述** 397 398表示系统时间被重新设置的公共事件。 399 400**起始版本：** 12 401 402### COMMON_EVENT_TIMEZONE_CHANGED 403 404```c 405static const char* const COMMON_EVENT_TIMEZONE_CHANGED = "usual.event.TIMEZONE_CHANGED" 406``` 407 408**描述** 409 410表示系统时区更改的公共事件。 411 412**起始版本：** 12 413 414### COMMON_EVENT_PACKAGE_ADDED 415 416```c 417static const char* const COMMON_EVENT_PACKAGE_ADDED = "usual.event.PACKAGE_ADDED" 418``` 419 420**描述** 421 422表示设备上已安装新应用包的公共事件。 423 424**起始版本：** 12 425 426### COMMON_EVENT_PACKAGE_REMOVED 427 428```c 429static const char* const COMMON_EVENT_PACKAGE_REMOVED = "usual.event.PACKAGE_REMOVED" 430``` 431 432**描述** 433 434表示已从设备卸载已安装的应用程序，但应用程序数据保留的公共事件。 435 436**起始版本：** 12 437 438### COMMON_EVENT_BUNDLE_REMOVED 439 440```c 441static const char* const COMMON_EVENT_BUNDLE_REMOVED = "usual.event.BUNDLE_REMOVED" 442``` 443 444**描述** 445 446表示已从设备中卸载已安装的捆绑包，但应用程序数据仍保留的公共事件。 447 448**起始版本：** 12 449 450### COMMON_EVENT_PACKAGE_FULLY_REMOVED 451 452```c 453static const char* const COMMON_EVENT_PACKAGE_FULLY_REMOVED = "usual.event.PACKAGE_FULLY_REMOVED" 454``` 455 456**描述** 457 458表示已从设备中完全卸载已安装的应用程序（包括应用程序数据和代码）的公共事件。 459 460**起始版本：** 12 461 462### COMMON_EVENT_PACKAGE_CHANGED 463 464```c 465static const char* const COMMON_EVENT_PACKAGE_CHANGED = "usual.event.PACKAGE_CHANGED" 466``` 467 468**描述** 469 470表示应用包已更改的公共事件（例如，包中的组件已启用或禁用）。 471 472**起始版本：** 12 473 474### COMMON_EVENT_PACKAGE_RESTARTED 475 476```c 477static const char* const COMMON_EVENT_PACKAGE_RESTARTED = "usual.event.PACKAGE_RESTARTED" 478``` 479 480**描述** 481 482表示用户重启应用包并杀死其所有进程的公共事件。 483 484**起始版本：** 12 485 486### COMMON_EVENT_PACKAGE_DATA_CLEARED 487 488```c 489static const char* const COMMON_EVENT_PACKAGE_DATA_CLEARED = "usual.event.PACKAGE_DATA_CLEARED" 490``` 491 492**描述** 493 494表示用户清除应用包数据的公共事件。 495 496**起始版本：** 12 497 498### COMMON_EVENT_PACKAGE_CACHE_CLEARED 499 500```c 501static const char* const COMMON_EVENT_PACKAGE_CACHE_CLEARED = "usual.event.PACKAGE_CACHE_CLEARED" 502``` 503 504**描述** 505 506表示用户清除应用包缓存数据的公共事件。 507 508**起始版本：** 12 509 510### COMMON_EVENT_PACKAGES_SUSPENDED 511 512```c 513static const char* const COMMON_EVENT_PACKAGES_SUSPENDED = "usual.event.PACKAGES_SUSPENDED" 514``` 515 516**描述** 517 518表示应用包已挂起的公共事件。 519 520**起始版本：** 12 521 522### COMMON_EVENT_MY_PACKAGE_SUSPENDED 523 524```c 525static const char* const COMMON_EVENT_MY_PACKAGE_SUSPENDED = "usual.event.MY_PACKAGE_SUSPENDED" 526``` 527 528**描述** 529 530表示应用程序包已被挂起的公共事件，该事件可以发送到被挂起的应用程序包。 531 532**起始版本：** 12 533 534### COMMON_EVENT_MY_PACKAGE_UNSUSPENDED 535 536```c 537static const char* const COMMON_EVENT_MY_PACKAGE_UNSUSPENDED = "usual.event.MY_PACKAGE_UNSUSPENDED" 538``` 539 540**描述** 541 542表示应用包未挂起的公共事件。 543 544**起始版本：** 12 545 546### COMMON_EVENT_LOCALE_CHANGED 547 548```c 549static const char* const COMMON_EVENT_LOCALE_CHANGED = "usual.event.LOCALE_CHANGED" 550``` 551 552**描述** 553 554表示设备区域设置已更改的公共事件。 555 556**起始版本：** 12 557 558### COMMON_EVENT_MANAGE_PACKAGE_STORAGE 559 560```c 561static const char* const COMMON_EVENT_MANAGE_PACKAGE_STORAGE = "usual.event.MANAGE_PACKAGE_STORAGE" 562``` 563 564**描述** 565 566表示设备存储空间不足的公共事件。 567 568**起始版本：** 12 569 570### COMMON_EVENT_USER_UNLOCKED 571 572```c 573static const char* const COMMON_EVENT_USER_UNLOCKED = "usual.event.USER_UNLOCKED" 574``` 575 576**描述** 577 578表示设备重启后解锁时，当前用户的凭据加密存储已解锁的公共事件。 579 580**起始版本：** 12 581 582### COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOUT 583 584```c 585static const char* const COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOUT = "common.event.DISTRIBUTED_ACCOUNT_LOGOUT" 586``` 587 588**描述** 589 590表示分布式账号登出成功的公共事件。 591 592**起始版本：** 12 593 594### COMMON_EVENT_DISTRIBUTED_ACCOUNT_TOKEN_INVALID 595 596```c 597static const char* const COMMON_EVENT_DISTRIBUTED_ACCOUNT_TOKEN_INVALID = "common.event.DISTRIBUTED_ACCOUNT_TOKEN_INVALID" 598``` 599 600**描述** 601 602表示分布式账号token令牌无效的公共事件。 603 604**起始版本：** 12 605 606### COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOFF 607 608```c 609static const char* const COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOFF = "common.event.DISTRIBUTED_ACCOUNT_LOGOFF" 610``` 611 612**描述** 613 614表示分布式账号注销的公共事件。 615 616**起始版本：** 12 617 618### COMMON_EVENT_WIFI_POWER_STATE 619 620```c 621static const char* const COMMON_EVENT_WIFI_POWER_STATE = "usual.event.wifi.POWER_STATE" 622``` 623 624**描述** 625 626表示Wi-Fi状态公共事件，如启用和禁用。 627 628**起始版本：** 12 629 630### COMMON_EVENT_WIFI_SCAN_FINISHED 631 632```c 633static const char* const COMMON_EVENT_WIFI_SCAN_FINISHED = "usual.event.wifi.SCAN_FINISHED" 634``` 635 636**描述** 637 638表示Wi-Fi接入点已被扫描并证明可用的公共事件。 639 640**起始版本：** 12 641 642### COMMON_EVENT_WIFI_RSSI_VALUE 643 644```c 645static const char* const COMMON_EVENT_WIFI_RSSI_VALUE = "usual.event.wifi.RSSI_VALUE" 646``` 647 648**描述** 649 650表示Wi-Fi信号强度（RSSI）改变的公共事件。 651 652**起始版本：** 12 653 654### COMMON_EVENT_WIFI_CONN_STATE 655 656```c 657static const char* const COMMON_EVENT_WIFI_CONN_STATE = "usual.event.wifi.CONN_STATE" 658``` 659 660**描述** 661 662表示Wi-Fi连接状态发生改变的公共事件。 663 664**起始版本：** 12 665 666### COMMON_EVENT_WIFI_HOTSPOT_STATE 667 668```c 669static const char* const COMMON_EVENT_WIFI_HOTSPOT_STATE = "usual.event.wifi.HOTSPOT_STATE" 670``` 671 672**描述** 673 674表示Wi-Fi热点状态的公共事件。 675 676**起始版本：** 12 677 678### COMMON_EVENT_WIFI_AP_STA_JOIN 679 680```c 681static const char* const COMMON_EVENT_WIFI_AP_STA_JOIN = "usual.event.wifi.WIFI_HS_STA_JOIN" 682``` 683 684**描述** 685 686表示客户端加入当前设备Wi-Fi热点的公共事件。 687 688**起始版本：** 12 689 690### COMMON_EVENT_WIFI_AP_STA_LEAVE 691 692```c 693static const char* const COMMON_EVENT_WIFI_AP_STA_LEAVE = "usual.event.wifi.WIFI_HS_STA_LEAVE" 694``` 695 696**描述** 697 698表示客户端已断开与当前设备Wi-Fi热点的连接的公共事件。 699 700**起始版本：** 12 701 702### COMMON_EVENT_WIFI_MPLINK_STATE_CHANGE 703 704```c 705static const char* const COMMON_EVENT_WIFI_MPLINK_STATE_CHANGE = "usual.event.wifi.mplink.STATE_CHANGE" 706``` 707 708**描述** 709 710表示MPLink（增强Wi-Fi功能）状态已更改的公共事件。 711 712**起始版本：** 12 713 714### COMMON_EVENT_WIFI_P2P_CONN_STATE 715 716```c 717static const char* const COMMON_EVENT_WIFI_P2P_CONN_STATE = "usual.event.wifi.p2p.CONN_STATE_CHANGE" 718``` 719 720**描述** 721 722表示Wi-Fi P2P连接状态改变的公共事件。 723 724**起始版本：** 12 725 726### COMMON_EVENT_WIFI_P2P_STATE_CHANGED 727 728```c 729static const char* const COMMON_EVENT_WIFI_P2P_STATE_CHANGED = "usual.event.wifi.p2p.STATE_CHANGE" 730``` 731 732**描述** 733 734表示Wi-Fi P2P状态公共事件，如启用和禁用。 735 736### COMMON_EVENT_WIFI_P2P_PEERS_STATE_CHANGED 737 738```c 739static const char* const COMMON_EVENT_WIFI_P2P_PEERS_STATE_CHANGED = "usual.event.wifi.p2p.DEVICES_CHANGE" 740``` 741 742**描述** 743 744表示Wi-Fi P2P对等体状态变化的公共事件。 745 746**起始版本：** 12 747 748### COMMON_EVENT_WIFI_P2P_PEERS_DISCOVERY_STATE_CHANGED 749 750```c 751static const char* const COMMON_EVENT_WIFI_P2P_PEERS_DISCOVERY_STATE_CHANGED = "usual.event.wifi.p2p.PEER_DISCOVERY_STATE_CHANGE" 752``` 753 754**描述** 755 756表示Wi-Fi P2P发现状态变化的公共事件。 757 758**起始版本：** 12 759 760### COMMON_EVENT_WIFI_P2P_CURRENT_DEVICE_STATE_CHANGED 761 762```c 763static const char* const COMMON_EVENT_WIFI_P2P_CURRENT_DEVICE_STATE_CHANGED = "usual.event.wifi.p2p.CURRENT_DEVICE_CHANGE" 764``` 765 766**描述** 767 768表示Wi-Fi P2P当前设备状态变化的公共事件。 769 770**起始版本：** 12 771 772### COMMON_EVENT_WIFI_P2P_GROUP_STATE_CHANGED 773 774```c 775static const char* const COMMON_EVENT_WIFI_P2P_GROUP_STATE_CHANGED = "usual.event.wifi.p2p.GROUP_STATE_CHANGED" 776``` 777 778**描述** 779 780表示Wi-Fi P2P群组信息已更改的公共事件。 781 782**起始版本：** 12 783 784### COMMON_EVENT_NFC_ACTION_ADAPTER_STATE_CHANGED 785 786```c 787static const char* const COMMON_EVENT_NFC_ACTION_ADAPTER_STATE_CHANGED = "usual.event.nfc.action.ADAPTER_STATE_CHANGED" 788``` 789 790**描述** 791 792表示设备NFC状态已更改的公共事件。 793 794**起始版本：** 12 795 796### COMMON_EVENT_NFC_ACTION_RF_FIELD_ON_DETECTED 797 798```c 799static const char* const COMMON_EVENT_NFC_ACTION_RF_FIELD_ON_DETECTED = "usual.event.nfc.action.RF_FIELD_ON_DETECTED" 800``` 801 802**描述** 803 804表示检测到NFC场强进入的公共事件。 805 806**起始版本：** 12 807 808### COMMON_EVENT_NFC_ACTION_RF_FIELD_OFF_DETECTED 809 810```c 811static const char* const COMMON_EVENT_NFC_ACTION_RF_FIELD_OFF_DETECTED = "usual.event.nfc.action.RF_FIELD_OFF_DETECTED" 812``` 813 814**描述** 815 816表示检测到NFC场强离开的公共事件。 817 818**起始版本：** 12 819 820### COMMON_EVENT_DISCHARGING 821 822```c 823static const char* const COMMON_EVENT_DISCHARGING = "usual.event.DISCHARGING" 824``` 825 826**描述** 827 828表示系统停止为电池充电的公共事件。 829 830**起始版本：** 12 831 832### COMMON_EVENT_CHARGING 833 834```c 835static const char* const COMMON_EVENT_CHARGING = "usual.event.CHARGING" 836``` 837 838**描述** 839 840表示系统开始为电池充电的公共事件。 841 842### COMMON_EVENT_DEVICE_IDLE_MODE_CHANGED 843 844```c 845static const char* const COMMON_EVENT_DEVICE_IDLE_MODE_CHANGED = "usual.event.DEVICE_IDLE_MODE_CHANGED" 846``` 847 848**描述** 849 850表示系统待机空闲模式已更改的公共事件。 851 852**起始版本：** 12 853 854### COMMON_EVENT_CHARGE_IDLE_MODE_CHANGED 855 856```c 857static const char* const COMMON_EVENT_CHARGE_IDLE_MODE_CHANGED = "usual.event.CHARGE_IDLE_MODE_CHANGED" 858``` 859 860**描述** 861 862表示设备进入充电空闲模式的公共事件。 863 864**起始版本：** 12 865 866### COMMON_EVENT_POWER_SAVE_MODE_CHANGED 867 868```c 869static const char* const COMMON_EVENT_POWER_SAVE_MODE_CHANGED = "usual.event.POWER_SAVE_MODE_CHANGED" 870``` 871 872**描述** 873 874表示系统节能模式更改的公共事件。 875 876**起始版本：** 12 877 878### COMMON_EVENT_USB_STATE 879 880```c 881static const char* const COMMON_EVENT_USB_STATE = "usual.event.hardware.usb.action.USB_STATE" 882``` 883 884**描述** 885 886表示USB设备状态发生变化的公共事件。 887 888**起始版本：** 12 889 890### COMMON_EVENT_USB_PORT_CHANGED 891 892```c 893static const char* const COMMON_EVENT_USB_PORT_CHANGED = "usual.event.hardware.usb.action.USB_PORT_CHANGED" 894``` 895 896**描述** 897 898表示用户设备的USB端口状态发生改变的公共事件。 899 900**起始版本：** 12 901 902### COMMON_EVENT_USB_DEVICE_ATTACHED 903 904```c 905static const char* const COMMON_EVENT_USB_DEVICE_ATTACHED = "usual.event.hardware.usb.action.USB_DEVICE_ATTACHED" 906``` 907 908**描述** 909 910当用户设备作为USB主机时，USB设备已挂载的公共事件。 911 912**起始版本：** 12 913 914### COMMON_EVENT_USB_DEVICE_DETACHED 915 916```c 917static const char* const COMMON_EVENT_USB_DEVICE_DETACHED = "usual.event.hardware.usb.action.USB_DEVICE_DETACHED" 918``` 919 920**描述** 921 922当用户设备作为USB主机时，USB设备被卸载的公共事件。 923 924**起始版本：** 12 925 926### COMMON_EVENT_AIRPLANE_MODE_CHANGED 927 928```c 929static const char* const COMMON_EVENT_AIRPLANE_MODE_CHANGED = "usual.event.AIRPLANE_MODE" 930``` 931 932**描述** 933 934表示设备飞行模式已更改的公共事件。 935 936**起始版本：** 12 937 938### COMMON_EVENT_SPLIT_SCREEN 939 940```c 941static const char* const COMMON_EVENT_SPLIT_SCREEN = "common.event.SPLIT_SCREEN" 942``` 943 944**描述** 945 946表示分屏的公共事件。 947 948**起始版本：** 12 949 950### COMMON_EVENT_QUICK_FIX_APPLY_RESULT 951 952```c 953static const char* const COMMON_EVENT_QUICK_FIX_APPLY_RESULT = "usual.event.QUICK_FIX_APPLY_RESULT" 954``` 955 956**描述** 957 958表示快速修复应用的公共事件。 959 960**起始版本：** 12 961 962### COMMON_EVENT_QUICK_FIX_REVOKE_RESULT 963 964```c 965static const char* const COMMON_EVENT_QUICK_FIX_REVOKE_RESULT = "usual.event.QUICK_FIX_REVOKE_RESULT" 966``` 967 968**描述** 969 970表示撤销快速修复的公共事件。 971 972**起始版本：** 12 973 974### COMMON_EVENT_USER_INFO_UPDATED 975 976```c 977static const char* const COMMON_EVENT_USER_INFO_UPDATED = "usual.event.USER_INFO_UPDATED" 978``` 979 980**描述** 981 982表示用户信息已更新的公共事件。 983 984**起始版本：** 12 985 986### COMMON_EVENT_SIM_STATE_CHANGED 987 988```c 989static const char* const COMMON_EVENT_SIM_STATE_CHANGED = "usual.event.SIM_STATE_CHANGED" 990``` 991 992**描述** 993 994表示SIM卡状态更新的公共事件。 995 996**起始版本：** 12 997 998### COMMON_EVENT_CALL_STATE_CHANGED 999 1000```c 1001static const char* const COMMON_EVENT_CALL_STATE_CHANGED = "usual.event.CALL_STATE_CHANGED" 1002``` 1003 1004**描述** 1005 1006表示呼叫状态更新的公共事件。 1007 1008**起始版本：** 12 1009 1010### COMMON_EVENT_NETWORK_STATE_CHANGED 1011 1012```c 1013static const char* const COMMON_EVENT_NETWORK_STATE_CHANGED = "usual.event.NETWORK_STATE_CHANGED" 1014``` 1015 1016**描述** 1017 1018表示网络状态更新的公共事件。 1019 1020**起始版本：** 12 1021 1022### COMMON_EVENT_SIGNAL_INFO_CHANGED 1023 1024```c 1025static const char* const COMMON_EVENT_SIGNAL_INFO_CHANGED = "usual.event.SIGNAL_INFO_CHANGED" 1026``` 1027 1028**描述** 1029 1030表示信号信息更新的公共事件。 1031 1032**起始版本：** 12 1033 1034### COMMON_EVENT_SCREEN_UNLOCKED 1035 1036```c 1037static const char* const COMMON_EVENT_SCREEN_UNLOCKED = "usual.event.SCREEN_UNLOCKED" 1038``` 1039 1040**描述** 1041 1042表示屏幕解锁的公共事件。 1043 1044**起始版本：** 12 1045 1046### COMMON_EVENT_SCREEN_LOCKED 1047 1048```c 1049static const char* const COMMON_EVENT_SCREEN_LOCKED = "usual.event.SCREEN_LOCKED" 1050``` 1051 1052**描述** 1053 1054表示屏幕锁定的公共事件。 1055 1056**起始版本：** 12 1057 1058### COMMON_EVENT_HTTP_PROXY_CHANGE 1059 1060```c 1061static const char* const COMMON_EVENT_HTTP_PROXY_CHANGE = "usual.event.HTTP_PROXY_CHANGE" 1062``` 1063 1064**描述** 1065 1066表示HTTP代理的配置信息发生变化的公共事件。 1067 1068**起始版本：** 12 1069 1070### COMMON_EVENT_CONNECTIVITY_CHANGE 1071 1072```c 1073static const char* const COMMON_EVENT_CONNECTIVITY_CHANGE = "usual.event.CONNECTIVITY_CHANGE" 1074``` 1075 1076**描述** 1077 1078表示网络连接状态变化的公共事件。 1079 1080**起始版本：** 12 1081 1082### COMMON_EVENT_MINORSMODE_ON 1083 1084```c 1085static const char* const COMMON_EVENT_MINORSMODE_ON = "usual.event.MINORSMODE_ON" 1086``` 1087 1088**描述** 1089 1090表示未成年人模式开启的公共事件。 1091 1092**起始版本：** 12 1093 1094### COMMON_EVENT_MINORSMODE_OFF 1095 1096```c 1097static const char* const COMMON_EVENT_MINORSMODE_OFF = "usual.event.MINORSMODE_OFF" 1098``` 1099 1100**描述** 1101 1102表示未成年人模式关闭的公共事件。 1103 1104**起始版本：** 12 1105 1106## 函数说明 1107 1108### OH_CommonEvent_CreateSubscribeInfo 1109 1110```cpp 1111CommonEvent_SubscribeInfo* OH_CommonEvent_CreateSubscribeInfo(const char* events[], int32_t eventsNum) 1112``` 1113 1114**描述** 1115 1116创建订阅者信息。 1117 1118**起始版本：** 12 1119 1120**参数:** 1121 1122| 名称 | 描述 | 1123| -------- | -------- | 1124| events | 订阅的事件。 | 1125| eventsNum | 事件数量。 | 1126 1127**返回：** 1128 1129返回订阅者信息。 1130 1131### OH_CommonEvent_SetPublisherPermission 1132 1133```cpp 1134CommonEvent_ErrCode OH_CommonEvent_SetPublisherPermission(CommonEvent_SubscribeInfo* info, const char* permission) 1135``` 1136 1137**描述** 1138 1139设置订阅者权限。 1140 1141**起始版本：** 12 1142 1143**参数:** 1144 1145| 名称 | 描述 | 1146| -------- | -------- | 1147| info | 订阅者信息。 | 1148| permission | 权限名称。 | 1149 1150**返回：** 1151 1152返回COMMONEVENT_ERR_OK表示成功。 1153 1154返回COMMONEVENT_ERR_INVALID_PARAMETER表示info为空指针。 1155 1156### OH_CommonEvent_SetPublisherBundleName 1157 1158```cpp 1159CommonEvent_ErrCode OH_CommonEvent_SetPublisherBundleName(CommonEvent_SubscribeInfo* info, const char* bundleName) 1160``` 1161 1162**描述** 1163 1164设置订阅者包名称。 1165 1166**起始版本：** 12 1167 1168**参数:** 1169 1170| 名称 | 描述 | 1171| -------- | -------- | 1172| info | 订阅者信息。 | 1173| bundleName | 包名称。 | 1174 1175**返回：** 1176 1177返回COMMONEVENT_ERR_OK表示成功。 1178 1179返回COMMONEVENT_ERR_INVALID_PARAMETER表示info为空指针。 1180 1181### OH_CommonEvent_DestroySubscribeInfo 1182 1183```cpp 1184void OH_CommonEvent_DestroySubscribeInfo(CommonEvent_SubscribeInfo* info) 1185``` 1186 1187**描述** 1188 1189销毁订阅者信息。 1190 1191**起始版本：** 12 1192 1193**参数:** 1194 1195| 名称 | 描述 | 1196| -------- | -------- | 1197| info | 订阅者信息。 | 1198 1199### OH_CommonEvent_CreateSubscriber 1200 1201```cpp 1202CommonEvent_Subscriber* OH_CommonEvent_CreateSubscriber(const CommonEvent_SubscribeInfo* info, CommonEvent_ReceiveCallback callback) 1203``` 1204 1205**描述** 1206 1207创建订阅者。 1208 1209**起始版本：** 12 1210 1211**参数:** 1212 1213| 名称 | 描述 | 1214| -------- | -------- | 1215| info | 订阅者信息。 | 1216| callback | 事件回调函数。 | 1217 1218**返回：** 1219 1220返回订阅者。 1221 1222### OH_CommonEvent_DestroySubscriber 1223 1224```cpp 1225void OH_CommonEvent_DestroySubscriber(CommonEvent_Subscriber* subscriber) 1226``` 1227 1228**描述** 1229 1230销毁订阅者。 1231 1232**起始版本：** 12 1233 1234**参数:** 1235 1236| 名称 | 描述 | 1237| -------- | -------- | 1238| subscriber | 订阅者。 | 1239 1240### OH_CommonEvent_Subscribe 1241 1242```cpp 1243CommonEvent_ErrCode OH_CommonEvent_Subscribe(const CommonEvent_Subscriber* subscriber) 1244``` 1245 1246**描述** 1247 1248订阅公共事件。 1249 1250**起始版本：** 12 1251 1252**参数:** 1253 1254| 名称 | 描述 | 1255| -------- | -------- | 1256| subscriber | 订阅者。 | 1257 1258**返回：** 1259 1260返回COMMONEVENT_ERR_OK表示成功。 1261 1262返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数subscriber为空。 1263 1264返回COMMONEVENT_ERR_SENDING_REQUEST_FAILED表示IPC发送失败。 1265 1266返回COMMONEVENT_ERR_INIT_UNDONE表示公共事件服务未初始化。 1267 1268返回COMMONEVENT_ERR_SUBSCRIBER_NUM_EXCEEDED表示当前进程订阅者超过200个。 1269 1270返回COMMONEVENT_ERR_ALLOC_MEMORY_FAILED表示系统分配内存失败。 1271 1272### OH_CommonEvent_UnSubscribe 1273 1274```cpp 1275CommonEvent_ErrCode OH_CommonEvent_UnSubscribe(const CommonEvent_Subscriber* subscriber) 1276``` 1277 1278**描述** 1279 1280退订公共事件。 1281 1282**起始版本：** 12 1283 1284**参数:** 1285 1286| 名称 | 描述 | 1287| -------- | -------- | 1288| subscriber | 订阅者。 | 1289 1290**返回：** 1291 1292返回COMMONEVENT_ERR_OK表示成功。 1293 1294返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数subscriber为空。 1295 1296返回COMMONEVENT_ERR_SENDING_REQUEST_FAILED表示IPC发送失败。 1297 1298返回COMMONEVENT_ERR_INIT_UNDONE表示公共事件服务未初始化。 1299 1300### OH_CommonEvent_GetEventFromRcvData 1301 1302```cpp 1303const char* OH_CommonEvent_GetEventFromRcvData(const CommonEvent_RcvData* rcvData) 1304``` 1305 1306**描述** 1307 1308获取回调公共事件名称。 1309 1310**起始版本：** 12 1311 1312**参数:** 1313 1314| 名称 | 描述 | 1315| -------- | -------- | 1316| rcvData | 公共事件回调数据。 | 1317 1318**返回：** 1319 1320返回公共事件名称。 1321 1322### OH_CommonEvent_GetCodeFromRcvData 1323 1324```cpp 1325int32_t OH_CommonEvent_GetCodeFromRcvData(const CommonEvent_RcvData* rcvData) 1326``` 1327 1328**描述** 1329 1330获取回调公共事件结果代码。 1331 1332**起始版本：** 12 1333 1334**参数:** 1335 1336| 名称 | 描述 | 1337| -------- | -------- | 1338| rcvData | 公共事件回调数据。 | 1339 1340**返回：** 1341 1342返回公共事件结果代码。默认为0。 1343 1344### OH_CommonEvent_GetDataStrFromRcvData 1345 1346```cpp 1347const char* OH_CommonEvent_GetDataStrFromRcvData(const CommonEvent_RcvData* rcvData) 1348``` 1349 1350**描述** 1351 1352获取回调公共事件自定义结果数据。 1353 1354**起始版本：** 12 1355 1356**参数:** 1357 1358| 名称 | 描述 | 1359| -------- | -------- | 1360| rcvData | 公共事件回调数据。 | 1361 1362**返回：** 1363 1364返回公共事件自定义结果数据。默认为null。 1365 1366### OH_CommonEvent_GetBundleNameFromRcvData 1367 1368```cpp 1369const char* OH_CommonEvent_GetBundleNameFromRcvData(const CommonEvent_RcvData* rcvData) 1370``` 1371 1372**描述** 1373 1374获取回调公共事件包名称。 1375 1376**起始版本：** 12 1377 1378**参数:** 1379 1380| 名称 | 描述 | 1381| -------- | -------- | 1382| rcvData | 公共事件回调数据。 | 1383 1384**返回：** 1385 1386返回公共事件包名称。默认为null。 1387 1388### OH_CommonEvent_GetParametersFromRcvData 1389 1390```cpp 1391const CommonEvent_Parameters* OH_CommonEvent_GetParametersFromRcvData(const CommonEvent_RcvData* rcvData) 1392``` 1393 1394**描述** 1395 1396获取回调公共事件附件信息。 1397 1398**起始版本：** 12 1399 1400**参数:** 1401 1402| 名称 | 描述 | 1403| -------- | -------- | 1404| rcvData | 公共事件回调数据。 | 1405 1406**返回：** 1407 1408返回公共事件附加信息。默认为null。 1409 1410### OH_CommonEvent_HasKeyInParameters 1411 1412```cpp 1413bool OH_CommonEvent_HasKeyInParameters(const CommonEvent_Parameters* para, const char* key) 1414``` 1415 1416**描述** 1417 1418查询公共事件附加信息中是否存在该键值对信息。 1419 1420**起始版本：** 12 1421 1422**参数:** 1423 1424| 名称 | 描述 | 1425| -------- | -------- | 1426| para | 公共事件附加信息。 | 1427| key | 数据键。 | 1428 1429**返回：** 1430 1431返回true表示存在该键值对信息。 1432 1433返回false表示不存在该键值对信息。 1434 1435### OH_CommonEvent_GetIntFromParameters 1436 1437```cpp 1438int OH_CommonEvent_GetIntFromParameters(const CommonEvent_Parameters* para, const char* key, const int defaultValue) 1439``` 1440 1441**描述** 1442 1443获取公共事件附加信息中键为key的int类型数据。 1444 1445**起始版本：** 12 1446 1447**参数:** 1448 1449| 名称 | 描述 | 1450| -------- | -------- | 1451| para | 公共事件附加信息。 | 1452| key | 数据键。 | 1453| defaultValue | 默认返回值。 | 1454 1455### OH_CommonEvent_GetIntArrayFromParameters 1456 1457```cpp 1458int32_t OH_CommonEvent_GetIntArrayFromParameters(const CommonEvent_Parameters* para, const char* key, int** array) 1459``` 1460 1461**描述** 1462 1463获取公共事件附加信息中键为key的int数组数据。 1464 1465**起始版本：** 12 1466 1467**参数:** 1468 1469| 名称 | 描述 | 1470| -------- | -------- | 1471| para | 公共事件附加信息。 | 1472| key | 数据键。 | 1473| array | 接收数据的int数组。 | 1474 1475**返回：** 1476 1477返回数组长度。 1478 1479### OH_CommonEvent_GetLongFromParameters 1480 1481```cpp 1482long OH_CommonEvent_GetLongFromParameters(const CommonEvent_Parameters* para, const char* key, const long defaultValue) 1483``` 1484 1485**描述** 1486 1487获取公共事件附加信息中键为key的long类型数据。 1488 1489**起始版本：** 12 1490 1491**参数:** 1492 1493| 名称 | 描述 | 1494| -------- | -------- | 1495| para | 公共事件附加信息。 | 1496| key | 数据键。 | 1497| defaultValue | 默认返回值。 | 1498 1499### OH_CommonEvent_GetLongArrayFromParameters 1500 1501```cpp 1502int32_t OH_CommonEvent_GetLongArrayFromParameters(const CommonEvent_Parameters* para, const char* key, long** array) 1503``` 1504 1505**描述** 1506 1507获取公共事件附加信息中键为key的long数组数据。 1508 1509**起始版本：** 12 1510 1511**参数:** 1512 1513| 名称 | 描述 | 1514| -------- | -------- | 1515| para | 公共事件附加信息。 | 1516| key | 数据键。 | 1517| array | 接收数据的long数组。 | 1518 1519**返回：** 1520 1521返回数组长度。 1522 1523### OH_CommonEvent_GetBoolFromParameters 1524 1525```cpp 1526bool OH_CommonEvent_GetBoolFromParameters(const CommonEvent_Parameters* para, const char* key, const bool defaultValue) 1527``` 1528 1529**描述** 1530 1531获取公共事件附加信息中键为key的布尔类型数据。 1532 1533**起始版本：** 12 1534 1535**参数:** 1536 1537| 名称 | 描述 | 1538| -------- | -------- | 1539| para | 公共事件附加信息。 | 1540| key | 数据键。 | 1541| defaultValue | 默认返回值。 | 1542 1543### OH_CommonEvent_GetBoolArrayFromParameters 1544 1545```cpp 1546int32_t OH_CommonEvent_GetBoolArrayFromParameters(const CommonEvent_Parameters* para, const char* key, bool** array) 1547``` 1548 1549**描述** 1550 1551获取公共事件附加信息中键为key的布尔数组数据。 1552 1553**起始版本：** 12 1554 1555**参数:** 1556 1557| 名称 | 描述 | 1558| -------- | -------- | 1559| para | 公共事件附加信息。 | 1560| key | 数据键。 | 1561| array | 接收数据的long数组。 | 1562 1563**返回：** 1564 1565返回数组长度。 1566 1567### OH_CommonEvent_GetCharFromParameters 1568 1569```cpp 1570char OH_CommonEvent_GetCharFromParameters(const CommonEvent_Parameters* para, const char* key, const char defaultValue) 1571``` 1572 1573**描述** 1574 1575获取公共事件附加信息中键为key的字符类型数据。 1576 1577**起始版本：** 12 1578 1579**参数:** 1580 1581| 名称 | 描述 | 1582| -------- | -------- | 1583| para | 公共事件附加信息。 | 1584| key | 数据键。 | 1585| defaultValue | 默认返回值。 | 1586 1587### OH_CommonEvent_GetCharArrayFromParameters 1588 1589```cpp 1590int32_t OH_CommonEvent_GetCharArrayFromParameters(const CommonEvent_Parameters* para, const char* key, char** array) 1591``` 1592 1593**描述** 1594 1595获取公共事件附加信息中键为key的字符数组数据。 1596 1597**起始版本：** 12 1598 1599**参数:** 1600 1601| 名称 | 描述 | 1602| -------- | -------- | 1603| para | 公共事件附加信息。 | 1604| key | 数据键。 | 1605| array | 接收数据的字符数组。 | 1606 1607**返回：** 1608 1609返回数组长度。 1610 1611### OH_CommonEvent_GetDoubleFromParameters 1612 1613```cpp 1614double OH_CommonEvent_GetDoubleFromParameters(const CommonEvent_Parameters* para, const char* key, const double defaultValue) 1615``` 1616 1617**描述** 1618 1619获取公共事件附加信息中键为key的double类型数据。 1620 1621**起始版本：** 12 1622 1623**参数:** 1624 1625| 名称 | 描述 | 1626| -------- | -------- | 1627| para | 公共事件附加信息。 | 1628| key | 数据键。 | 1629| defaultValue | 默认返回值。 | 1630 1631### OH_CommonEvent_GetDoubleArrayFromParameters 1632 1633```cpp 1634int32_t OH_CommonEvent_GetDoubleArrayFromParameters(const CommonEvent_Parameters* para, const char* key, double** array) 1635``` 1636 1637**描述** 1638 1639获取公共事件附加信息中键为key的double数组数据。 1640 1641**起始版本：** 12 1642 1643**参数:** 1644 1645| 名称 | 描述 | 1646| -------- | -------- | 1647| para | 公共事件附加信息。 | 1648| key | 数据键。 | 1649| array | 接收数据的字符数组。 | 1650 1651**返回：** 1652 1653返回数组长度。默认为0。 1654 1655### OH_CommonEvent_CreateParameters 1656 1657```cpp 1658CommonEvent_Parameters* OH_CommonEvent_CreateParameters() 1659``` 1660 1661**描述** 1662 1663创建公共事件附加信息对象。 1664 1665**起始版本：** 18 1666 1667**参数：** 1668 1669无。 1670 1671**返回：** 1672 1673返回公共事件附加信息，创建失败时，返回null。 1674 1675### OH_CommonEvent_DestroyParameters 1676 1677```cpp 1678void OH_CommonEvent_DestroyParameters(CommonEvent_Parameters* param) 1679``` 1680 1681**描述** 1682 1683销毁公共事件附加信息对象。 1684 1685**起始版本：** 18 1686 1687**参数：** 1688 1689| 名称 | 描述 | 1690| -------- | -------- | 1691| param | 公共事件附加信息。| 1692 1693**返回：** 1694 1695无。 1696 1697### OH_CommonEvent_SetIntToParameters 1698 1699```cpp 1700CommonEvent_ErrCode OH_CommonEvent_SetIntToParameters(CommonEvent_Parameters* param, const char* key, int value) 1701``` 1702 1703**描述** 1704 1705设置公共事件附加信息的int类型内容。 1706 1707**起始版本：** 18 1708 1709**参数：** 1710 1711| 名称 | 描述 | 1712| -------- | -------- | 1713| param | 公共事件附加信息。| 1714| key | 数据键。| 1715| value | 设置的int类型内容。| 1716 1717**返回：** 1718 1719返回COMMONEVENT_ERR_OK表示成功。 1720 1721返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。 1722 1723### OH_CommonEvent_SetIntArrayToParameters 1724 1725```cpp 1726CommonEvent_ErrCode OH_CommonEvent_SetIntArrayToParameters(CommonEvent_Parameters* param, const char* key, const int* value, size_t num) 1727``` 1728 1729**描述** 1730 1731设置公共事件附加信息的int数组内容。 1732 1733**起始版本：** 18 1734 1735**参数：** 1736 1737| 名称 | 描述 | 1738| -------- | -------- | 1739| param | 公共事件附加信息。| 1740| key | 数据键。| 1741| value | 设置的int数组内容。| 1742| num | 设置的int数组内容中元素的个数。| 1743 1744**返回：** 1745 1746返回COMMONEVENT_ERR_OK表示成功。 1747 1748返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。 1749 1750返回COMMONEVENT_ERR_ALLOC_MEMORY_FAILED表示内存分配失败。 1751 1752### OH_CommonEvent_SetLongToParameters 1753 1754```cpp 1755CommonEvent_ErrCode OH_CommonEvent_SetLongToParameters(CommonEvent_Parameters* param, const char* key, long value) 1756``` 1757 1758**描述** 1759 1760设置公共事件附加信息的long类型内容。 1761 1762**起始版本：** 18 1763 1764**参数：** 1765 1766| 名称 | 描述 | 1767| -------- | -------- | 1768| param | 公共事件附加信息。| 1769| key | 数据键。| 1770| value | 设置的long类型内容。| 1771 1772**返回：** 1773 1774返回COMMONEVENT_ERR_OK表示成功。 1775 1776返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。 1777 1778### OH_CommonEvent_SetLongArrayToParameters 1779 1780```cpp 1781CommonEvent_ErrCode OH_CommonEvent_SetLongArrayToParameters(CommonEvent_Parameters* param, const char* key, const long* value, size_t num) 1782``` 1783 1784**描述** 1785 1786设置公共事件附加信息的long数组内容。 1787 1788**起始版本：** 18 1789 1790**参数：** 1791 1792| 名称 | 描述 | 1793| -------- | -------- | 1794| param | 公共事件附加信息。| 1795| key | 数据键。| 1796| value | 设置的long数组内容。| 1797| num | 设置的long数组内容中元素的个数。| 1798 1799**返回：** 1800 1801返回COMMONEVENT_ERR_OK表示成功。 1802 1803返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。 1804 1805返回COMMONEVENT_ERR_ALLOC_MEMORY_FAILED表示内存分配失败。 1806 1807### OH_CommonEvent_SetDoubleToParameters 1808 1809```cpp 1810CommonEvent_ErrCode OH_CommonEvent_SetDoubleToParameters(CommonEvent_Parameters* param, const char* key, double value) 1811``` 1812 1813**描述** 1814 1815设置公共事件附加信息的double类型内容。 1816 1817**起始版本：** 18 1818 1819**参数：** 1820 1821| 名称 | 描述 | 1822| -------- | -------- | 1823| param | 公共事件附加信息。| 1824| key | 数据键。| 1825| value | 设置的double类型内容。| 1826 1827**返回：** 1828 1829返回COMMONEVENT_ERR_OK表示成功。 1830 1831返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。 1832 1833### OH_CommonEvent_SetDoubleArrayToParameters 1834 1835```cpp 1836CommonEvent_ErrCode OH_CommonEvent_SetDoubleArrayToParameters(CommonEvent_Parameters* param, const char* key, const double* value, size_t num) 1837``` 1838 1839**描述** 1840 1841设置公共事件附加信息的double数组内容。 1842 1843**起始版本：** 18 1844 1845**参数：** 1846 1847| 名称 | 描述 | 1848| -------- | -------- | 1849| param | 公共事件附加信息。| 1850| key | 数据键。| 1851| value | 设置的double数组内容。| 1852| num | 设置的double数组内容中元素的个数。| 1853 1854**返回：** 1855 1856返回COMMONEVENT_ERR_OK表示成功。 1857 1858返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。 1859 1860返回COMMONEVENT_ERR_ALLOC_MEMORY_FAILED表示内存分配失败。 1861 1862### OH_CommonEvent_SetBoolToParameters 1863 1864```cpp 1865CommonEvent_ErrCode OH_CommonEvent_SetBoolToParameters(CommonEvent_Parameters* param, const char* key, bool value) 1866``` 1867 1868**描述** 1869 1870设置公共事件附加信息的布尔类型内容。 1871 1872**起始版本：** 18 1873 1874**参数：** 1875 1876| 名称 | 描述 | 1877| -------- | -------- | 1878| param | 公共事件附加信息。| 1879| key | 数据键。| 1880| value | 设置的布尔类型内容。| 1881 1882**返回：** 1883 1884返回COMMONEVENT_ERR_OK表示成功。 1885 1886返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。 1887 1888### OH_CommonEvent_SetBoolArrayToParameters 1889 1890```cpp 1891CommonEvent_ErrCode OH_CommonEvent_SetBoolArrayToParameters(CommonEvent_Parameters* param, const char* key, const bool* value, size_t num) 1892``` 1893 1894**描述** 1895 1896设置公共事件附加信息的布尔数组内容。 1897 1898**起始版本：** 18 1899 1900**参数：** 1901 1902| 名称 | 描述 | 1903| -------- | -------- | 1904| param | 公共事件附加信息。| 1905| key | 数据键。| 1906| value | 设置的布尔数组内容。| 1907| num | 设置的布尔数组内容中元素的个数。| 1908 1909**返回：** 1910 1911返回COMMONEVENT_ERR_OK表示成功。 1912 1913返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。 1914 1915返回COMMONEVENT_ERR_ALLOC_MEMORY_FAILED表示内存分配失败。 1916 1917### OH_CommonEvent_SetCharToParameters 1918 1919```cpp 1920CommonEvent_ErrCode OH_CommonEvent_SetCharToParameters(CommonEvent_Parameters* param, const char* key, char value) 1921``` 1922 1923**描述** 1924 1925设置公共事件附加信息的字符类型内容。 1926 1927**起始版本：** 18 1928 1929**参数：** 1930 1931| 名称 | 描述 | 1932| -------- | -------- | 1933| param | 公共事件附加信息。| 1934| key | 数据键。| 1935| value | 设置的字符类型内容。| 1936 1937**返回：** 1938 1939返回COMMONEVENT_ERR_OK表示成功。 1940 1941返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。 1942 1943### OH_CommonEvent_SetCharArrayToParameters 1944 1945```cpp 1946CommonEvent_ErrCode OH_CommonEvent_SetCharArrayToParameters(CommonEvent_Parameters* param, const char* key, const char* value, size_t num) 1947``` 1948 1949**描述** 1950 1951设置公共事件附加信息的字符数组内容。 1952 1953**起始版本：** 18 1954 1955**参数：** 1956 1957| 名称 | 描述 | 1958| -------- | -------- | 1959| param | 公共事件附加信息。| 1960| key | 数据键。| 1961| value | 设置的字符数组内容。| 1962| num | 设置的字符数组内容中元素的个数。| 1963 1964**返回：** 1965 1966返回COMMONEVENT_ERR_OK表示成功。 1967 1968返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。 1969 1970返回COMMONEVENT_ERR_ALLOC_MEMORY_FAILED表示内存分配失败。 1971 1972### OH_CommonEvent_CreatePublishInfo 1973 1974```cpp 1975CommonEvent_PublishInfo* OH_CommonEvent_CreatePublishInfo(bool ordered) 1976``` 1977 1978**描述** 1979 1980创建公共事件属性对象。 1981 1982**起始版本：** 18 1983 1984**参数：** 1985 1986| 名称 | 描述 | 1987| -------- | -------- | 1988| ordered | 是否为有序公共事件。<br/>true：有序公共事件。false：无序公共事件。| 1989 1990**返回：** 1991 1992创建的公共事件属性对象，创建失败时，返回null。 1993 1994### OH_CommonEvent_DestroyPublishInfo 1995 1996```cpp 1997void OH_CommonEvent_DestroyPublishInfo(CommonEvent_PublishInfo* info) 1998``` 1999 2000**描述** 2001 2002销毁公共事件属性对象。 2003 2004**起始版本：** 18 2005 2006**参数：** 2007 2008| 名称 | 描述 | 2009| -------- | -------- | 2010| info | 要销毁的公共事件属性对象。| 2011 2012**返回：** 2013 2014无。 2015 2016### OH_CommonEvent_SetPublishInfoBundleName 2017 2018```cpp 2019CommonEvent_ErrCode OH_CommonEvent_SetPublishInfoBundleName(CommonEvent_PublishInfo* info, const char* bundleName) 2020``` 2021 2022**描述** 2023 2024设置公共事件包名称。 2025 2026**起始版本：** 18 2027 2028**参数：** 2029 2030| 名称 | 描述 | 2031| -------- | -------- | 2032| info | 公共事件属性对象。| 2033| bundleName | 设置的包名称。| 2034 2035**返回：** 2036 2037返回COMMONEVENT_ERR_OK表示成功。 2038 2039返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。 2040 2041### OH_CommonEvent_SetPublishInfoPermissions 2042 2043```cpp 2044CommonEvent_ErrCode OH_CommonEvent_SetPublishInfoPermissions(CommonEvent_PublishInfo* info，const char* permissions[], int32_t num) 2045``` 2046 2047**描述** 2048 2049设置公共事件权限。 2050 2051**起始版本：** 18 2052 2053**参数：** 2054 2055| 名称 | 描述 | 2056| -------- | -------- | 2057| info | 公共事件属性对象。| 2058| permissions | 权限名称数组。| 2059| num | 权限的数量。| 2060 2061**返回：** 2062 2063返回COMMONEVENT_ERR_OK表示成功。 2064 2065返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。 2066 2067### OH_CommonEvent_SetPublishInfoCode 2068 2069```cpp 2070CommonEvent_ErrCode OH_CommonEvent_SetPublishInfoCode(CommonEvent_PublishInfo* info, int32_t code) 2071``` 2072 2073**描述** 2074 2075设置公共事件结果码。 2076 2077**起始版本：** 18 2078 2079**参数：** 2080 2081| 名称 | 描述 | 2082| -------- | -------- | 2083| info | 公共事件属性对象。| 2084| code | 设置的结果码。| 2085 2086**返回：** 2087 2088返回COMMONEVENT_ERR_OK表示成功。 2089 2090返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。 2091 2092### OH_CommonEvent_SetPublishInfoData 2093 2094```cpp 2095CommonEvent_ErrCode OH_CommonEvent_SetPublishInfoData(CommonEvent_PublishInfo* info, const char* data, size_t length) 2096``` 2097 2098**描述** 2099 2100设置公共事件的发布信息结果数据。 2101 2102**起始版本：** 18 2103 2104**参数：** 2105 2106| 名称 | 描述 | 2107| -------- | -------- | 2108| info | 公共事件属性对象。| 2109| data | 设置的结果数据。| 2110| length | 结果数据的长度。| 2111 2112**返回：** 2113 2114返回COMMONEVENT_ERR_OK表示成功。 2115 2116返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。 2117 2118### OH_CommonEvent_SetPublishInfoParameters 2119 2120```cpp 2121CommonEvent_ErrCode OH_CommonEvent_SetPublishInfoParameters(CommonEvent_PublishInfo* info, CommonEvent_Parameters* param) 2122``` 2123 2124**描述** 2125 2126设置公共事件附加信息。 2127 2128**起始版本：** 18 2129 2130**参数：** 2131 2132| 名称 | 描述 | 2133| -------- | -------- | 2134| info | 公共事件属性对象。| 2135| param | 设置的附加信息。| 2136 2137**返回：** 2138 2139返回COMMONEVENT_ERR_OK表示成功。 2140 2141返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。 2142 2143### OH_CommonEvent_Publish 2144 2145```cpp 2146CommonEvent_ErrCode OH_CommonEvent_Publish(const char* event) 2147``` 2148 2149**描述** 2150 2151发布自定义公共事件。 2152 2153**起始版本：** 18 2154 2155**参数：** 2156 2157| 名称 | 描述 | 2158| -------- | -------- | 2159| event | 公共事件名称。| 2160 2161**返回：** 2162 2163返回COMMONEVENT_ERR_OK表示成功。 2164 2165返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。 2166 2167返回COMMONEVENT_ERR_SENDING_REQUEST_FAILED表示IPC发送失败。 2168 2169返回COMMONEVENT_ERR_INIT_UNDONE表示公共事件服务未初始化。 2170 2171### OH_CommonEvent_PublishWithInfo 2172 2173```cpp 2174CommonEvent_ErrCode OH_CommonEvent_PublishWithInfo(const char* event, const CommonEvent_PublishInfo* info) 2175``` 2176 2177**描述** 2178 2179发布带有指定属性的自定义公共事件。 2180 2181**起始版本：** 18 2182 2183**参数：** 2184 2185| 名称 | 描述 | 2186| -------- | -------- | 2187| event | 公共事件名称。| 2188| info | 设置的公共事件属性。| 2189 2190**返回：** 2191 2192返回COMMONEVENT_ERR_OK表示成功。 2193 2194返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。 2195 2196返回COMMONEVENT_ERR_SENDING_REQUEST_FAILED表示IPC发送失败。 2197 2198返回COMMONEVENT_ERR_INIT_UNDONE表示公共事件服务未初始化。 2199 2200### OH_CommonEvent_IsOrderedCommonEvent 2201 2202```cpp 2203bool OH_CommonEvent_IsOrderedCommonEvent(const CommonEvent_Subscriber* subscriber) 2204``` 2205 2206**描述** 2207 2208查询当前公共事件是否为有序公共事件。 2209 2210**起始版本：** 18 2211 2212**参数：** 2213 2214| 名称 | 描述 | 2215| -------- | -------- | 2216| subscriber | 公共事件的订阅者对象。| 2217 2218**返回：** 2219 2220返回true表示有序公共事件。 2221 2222返回false表示无序公共事件。 2223 2224### OH_CommonEvent_FinishCommonEvent 2225 2226```cpp 2227bool OH_CommonEvent_FinishCommonEvent(CommonEvent_Subscriber* subscriber) 2228``` 2229 2230**描述** 2231 2232用于订阅者结束对当前有序公共事件的处理。 2233 2234**起始版本：** 18 2235 2236**参数：** 2237 2238| 名称 | 描述 | 2239| -------- | -------- | 2240| subscriber | 公共事件的订阅者对象。| 2241 2242**返回：** 2243 2244返回true表示操作成功。 2245 2246返回false表示操作失败。 2247 2248### OH_CommonEvent_GetAbortCommonEvent 2249 2250```cpp 2251bool OH_CommonEvent_GetAbortCommonEvent(const CommonEvent_Subscriber* subscriber) 2252``` 2253 2254**描述** 2255 2256获取当前有序公共事件是否处于中止状态。 2257 2258**起始版本：** 18 2259 2260**参数：** 2261 2262| 名称 | 描述 | 2263| -------- | -------- | 2264| subscriber | 公共事件的订阅者对象。| 2265 2266**返回：** 2267 2268返回true表示当前有序公共事件处于中止状态。 2269 2270返回false表示当前有序公共事件没有处于中止状态。 2271 2272### OH_CommonEvent_AbortCommonEvent 2273 2274```cpp 2275bool OH_CommonEvent_AbortCommonEvent(CommonEvent_Subscriber* subscriber) 2276``` 2277 2278**描述** 2279 2280该接口与OH_CommonEvent_FinishCommonEvent配合使用，可以中止当前的有序公共事件，使该公共事件不再向下一个订阅者传递。 2281 2282**起始版本：** 18 2283 2284**参数：** 2285 2286| 名称 | 描述 | 2287| -------- | -------- | 2288| subscriber | 公共事件的订阅者对象。| 2289 2290**返回：** 2291 2292返回true表示操作成功。 2293 2294返回false表示操作失败。 2295 2296### OH_CommonEvent_ClearAbortCommonEvent 2297 2298```cpp 2299bool OH_CommonEvent_ClearAbortCommonEvent(CommonEvent_Subscriber* subscriber) 2300``` 2301 2302**描述** 2303 2304该接口与OH_CommonEvent_FinishCommonEvent配合使用，可以取消当前有序公共事件的中止状态，使该公共事件继续向下一个订阅者传递。 2305 2306**起始版本：** 18 2307 2308**参数：** 2309 2310| 名称 | 描述 | 2311| -------- | -------- | 2312| subscriber | 公共事件的订阅者对象。| 2313 2314**返回：** 2315 2316返回true表示操作成功。 2317 2318返回false表示操作失败。 2319 2320### OH_CommonEvent_GetCodeFromSubscriber 2321 2322```cpp 2323int32_t OH_CommonEvent_GetCodeFromSubscriber(const CommonEvent_Subscriber* subscriber) 2324``` 2325 2326**描述** 2327 2328获取有序公共事件代码。 2329 2330**起始版本：** 18 2331 2332**参数：** 2333 2334| 名称 | 描述 | 2335| -------- | -------- | 2336| subscriber | 公共事件的订阅者对象。| 2337 2338**返回：** 2339 2340返回有序公共事件的代码，无法获取时返回0。 2341 2342### OH_CommonEvent_GetDataFromSubscriber 2343 2344```cpp 2345const char* OH_CommonEvent_GetDataFromSubscriber(const CommonEvent_Subscriber* subscriber) 2346``` 2347 2348**描述** 2349 2350获取有序公共事件的数据。 2351 2352**起始版本：** 18 2353 2354**参数：** 2355 2356| 名称 | 描述 | 2357| -------- | -------- | 2358| subscriber | 公共事件的订阅者对象。| 2359 2360**返回：** 2361 2362返回有序公共事件的数据，无法获取时返回null。 2363 2364### OH_CommonEvent_SetCodeToSubscriber 2365 2366```cpp 2367bool OH_CommonEvent_SetCodeToSubscriber(CommonEvent_Subscriber* subscriber, int32_t code) 2368``` 2369 2370**描述** 2371 2372设置有序公共事件的代码。 2373 2374**起始版本：** 18 2375 2376**参数：** 2377 2378| 名称 | 描述 | 2379| -------- | -------- | 2380| subscriber | 公共事件的订阅者对象。| 2381| code | 公共事件的代码。| 2382 2383**返回：** 2384 2385返回true表示操作成功。 2386 2387返回false表示操作失败。 2388 2389### OH_CommonEvent_SetDataToSubscriber 2390 2391```cpp 2392bool OH_CommonEvent_SetDataToSubscriber(CommonEvent_Subscriber* subscriber, const char* data, size_t length) 2393``` 2394 2395**描述** 2396 2397设置有序公共事件的数据。 2398 2399**起始版本：** 18 2400 2401**参数：** 2402 2403| 名称 | 描述 | 2404| -------- | -------- | 2405| subscriber | 公共事件的订阅者对象。| 2406| data | 公共事件的数据。| 2407| length | 数据的长度。| 2408 2409**返回：** 2410 2411返回true表示操作成功。 2412 2413返回false表示操作失败。