harmony 鸿蒙CommonEvent
CommonEvent
概述
描述CommonEvent向应用提供公共事件的能力。
系统能力： SystemCapability.Notification.CommonEvent
起始版本： 12
汇总
文件
| 名称 | 描述 |
|---|---|
| oh_commonevent.h | 声明公共事件相关的API，包含订阅公共事件与退订公共事件。 引用文件：<BasicServicesKit/oh_commonevent.h> 库：libohcommonevent.so |
| oh_commonevent_support.h | 提供系统定义的公共事件常量。 引用文件：<BasicServicesKit/oh_commonevent_support.h> 库：libohcommonevent.so |
类型定义
| 名称 | 描述 |
|---|---|
| CommonEvent_SubscribeInfo | 订阅者信息。 |
| CommonEvent_Subscriber | 订阅者。 |
| CommonEvent_RcvData | 公共事件的回调数据。 |
| CommonEvent_Parameters | 公共事件的回调附加信息。 |
| CommonEvent_ReceiveCallback | 公共事件的回调函数。 |
| CommonEvent_PublishInfo | 公共事件属性对象。 |
枚举
| 名称 | 描述 |
|---|---|
| CommonEvent_ErrCode | 枚举错误码。 |
函数
常量
| 名称 | 描述 |
|---|---|
| static const char* const COMMON_EVENT_SHUTDOWN = “usual.event.SHUTDOWN” | 表示设备正在关闭并将继续直至最终关闭的公共事件。 |
| static const char* const COMMON_EVENT_BATTERY_CHANGED = “usual.event.BATTERY_CHANGED” | 表示电池充电状态、电平和其他信息发生变化的公共事件。 |
| static const char* const COMMON_EVENT_BATTERY_LOW = “usual.event.BATTERY_LOW” | 表示电池电量低的公共事件。 |
| static const char* const COMMON_EVENT_BATTERY_OKAY = “usual.event.BATTERY_OKAY” | 表示电池退出低电平状态的公共事件。 |
| static const char* const COMMON_EVENT_POWER_CONNECTED = “usual.event.POWER_CONNECTED” | 表示设备连接到外部电源的公共事件。 |
| static const char* const COMMON_EVENT_POWER_DISCONNECTED = “usual.event.POWER_DISCONNECTED” | 表示设备与外部电源断开的公共事件。 |
| static const char* const COMMON_EVENT_SCREEN_OFF = “usual.event.SCREEN_OFF” | 表示设备屏幕关闭且设备处于睡眠状态的公共事件。 |
| static const char* const COMMON_EVENT_SCREEN_ON = “usual.event.SCREEN_ON” | 表示设备屏幕打开且设备处于交互状态的公共事件。 |
| static const char* const COMMON_EVENT_THERMAL_LEVEL_CHANGED = “usual.event.THERMAL_LEVEL_CHANGED” | 表示设备热状态的公共事件。 |
| static const char* const COMMON_EVENT_TIME_TICK = “usual.event.TIME_TICK” | 表示系统时间随时间流逝而发生变化的公共事件。 |
| static const char* const COMMON_EVENT_TIME_CHANGED = “usual.event.TIME_CHANGED” | 表示系统时间被重新设置的公共事件。 |
| static const char* const COMMON_EVENT_TIMEZONE_CHANGED = “usual.event.TIMEZONE_CHANGED” | 表示系统时区更改的公共事件。 |
| static const char* const COMMON_EVENT_PACKAGE_ADDED = “usual.event.PACKAGE_ADDED” | 表示设备上已安装新应用包的公共事件。 |
| static const char* const COMMON_EVENT_PACKAGE_REMOVED = “usual.event.PACKAGE_REMOVED” | 表示已安装的应用程序从设备中卸载，但应用程序数据保留的公共事件。 |
| static const char* const COMMON_EVENT_BUNDLE_REMOVED = “usual.event.BUNDLE_REMOVED” | 表示从设备中卸载已安装应用程序的附加包，但应用程序数据仍保留的公共事件。 |
| static const char* const COMMON_EVENT_PACKAGE_FULLY_REMOVED = “usual.event.PACKAGE_FULLY_REMOVED” | 表示已从设备中完全卸载已安装的应用程序（包括应用程序数据和代码）的公共事件。 |
| static const char* const COMMON_EVENT_PACKAGE_CHANGED = “usual.event.PACKAGE_CHANGED” | 表示应用包已更改的公共事件（例如，包中的组件已启用或禁用）。 |
| static const char* const COMMON_EVENT_PACKAGE_RESTARTED = “usual.event.PACKAGE_RESTARTED” | 表示用户重启应用包并杀死其所有进程的公共事件。 |
| static const char* const COMMON_EVENT_PACKAGE_DATA_CLEARED = “usual.event.PACKAGE_DATA_CLEARED” | 表示用户清除应用包数据的公共事件。 |
| static const char* const COMMON_EVENT_PACKAGE_CACHE_CLEARED = “usual.event.PACKAGE_CACHE_CLEARED” | 表示用户清除应用包缓存数据的公共事件。 |
| static const char* const COMMON_EVENT_PACKAGES_SUSPENDED = “usual.event.PACKAGES_SUSPENDED” | 表示应用包已挂起的公共事件。 |
| static const char* const COMMON_EVENT_MY_PACKAGE_SUSPENDED = “usual.event.MY_PACKAGE_SUSPENDED” | 表示应用程序包已被挂起的公共事件，该事件可以发送到被挂起的应用程序包。 |
| static const char* const COMMON_EVENT_MY_PACKAGE_UNSUSPENDED = “usual.event.MY_PACKAGE_UNSUSPENDED” | 表示应用包未挂起的公共事件。 |
| static const char* const COMMON_EVENT_LOCALE_CHANGED = “usual.event.LOCALE_CHANGED” | 表示设备区域设置已更改的公共事件。 |
| static const char* const COMMON_EVENT_MANAGE_PACKAGE_STORAGE = “usual.event.MANAGE_PACKAGE_STORAGE” | 设备存储空间不足的公共事件。 |
| static const char* const COMMON_EVENT_USER_UNLOCKED = “usual.event.USER_UNLOCKED” | 表示设备重启后解锁时，当前用户的凭据加密存储已解锁的公共事件。 |
| static const char* const COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOUT = “common.event.DISTRIBUTED_ACCOUNT_LOGOUT” | 表示分布式账号登出成功的公共事件。 |
| static const char* const COMMON_EVENT_DISTRIBUTED_ACCOUNT_TOKEN_INVALID = “common.event.DISTRIBUTED_ACCOUNT_TOKEN_INVALID” | 表示分布式账号token令牌无效的公共事件。 |
| static const char* const COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOFF = “common.event.DISTRIBUTED_ACCOUNT_LOGOFF” | 表示分布式账号注销的公共事件。 |
| static const char* const COMMON_EVENT_WIFI_POWER_STATE = “usual.event.wifi.POWER_STATE” | 表示Wi-Fi状态公共事件，如启用和禁用。 |
| static const char* const COMMON_EVENT_WIFI_SCAN_FINISHED = “usual.event.wifi.SCAN_FINISHED” | 表示Wi-Fi接入点已被扫描并证明可用的公共事件。 |
| static const char* const COMMON_EVENT_WIFI_RSSI_VALUE = “usual.event.wifi.RSSI_VALUE” | 表示Wi-Fi信号强度（RSSI）改变的公共事件。 |
| static const char* const COMMON_EVENT_WIFI_CONN_STATE = “usual.event.wifi.CONN_STATE” | 表示Wi-Fi连接状态发生改变的公共事件。 |
| static const char* const COMMON_EVENT_WIFI_HOTSPOT_STATE = “usual.event.wifi.HOTSPOT_STATE” | 表示Wi-Fi热点状态的公共事件，如启用或禁用。 |
| static const char* const COMMON_EVENT_WIFI_AP_STA_JOIN = “usual.event.wifi.WIFI_HS_STA_JOIN” | 表示客户端加入当前设备Wi-Fi热点的公共事件。 |
| static const char* const COMMON_EVENT_WIFI_AP_STA_LEAVE = “usual.event.wifi.WIFI_HS_STA_LEAVE” | 表示客户端已断开与当前设备Wi-Fi热点的连接的公共事件。 |
| static const char* const COMMON_EVENT_WIFI_MPLINK_STATE_CHANGE = “usual.event.wifi.mplink.STATE_CHANGE” | 表示MPLink（增强Wi-Fi功能）状态已更改的公共事件。 |
| static const char* const COMMON_EVENT_WIFI_P2P_CONN_STATE = “usual.event.wifi.p2p.CONN_STATE_CHANGE” | 表示Wi-Fi P2P连接状态改变的公共事件。 |
| static const char* const COMMON_EVENT_WIFI_P2P_STATE_CHANGED = “usual.event.wifi.p2p.STATE_CHANGE” | 表示Wi-Fi P2P状态公共事件，如启用和禁用。 |
| static const char* const COMMON_EVENT_WIFI_P2P_PEERS_STATE_CHANGED = “usual.event.wifi.p2p.DEVICES_CHANGE” | 表示Wi-Fi P2P对等体状态变化的公共事件。 |
| static const char* const COMMON_EVENT_WIFI_P2P_PEERS_DISCOVERY_STATE_CHANGED = “usual.event.wifi.p2p.PEER_DISCOVERY_STATE_CHANGE” | 表示Wi-Fi P2P发现状态变化的公共事件。 |
| static const char* const COMMON_EVENT_WIFI_P2P_CURRENT_DEVICE_STATE_CHANGED = “usual.event.wifi.p2p.CURRENT_DEVICE_CHANGE” | 表示Wi-Fi P2P当前设备状态变化的公共事件。 |
| static const char* const COMMON_EVENT_WIFI_P2P_GROUP_STATE_CHANGED = “usual.event.wifi.p2p.GROUP_STATE_CHANGED” | 表示Wi-Fi P2P群组信息已更改的公共事件。 |
| static const char* const COMMON_EVENT_NFC_ACTION_ADAPTER_STATE_CHANGED = “usual.event.nfc.action.ADAPTER_STATE_CHANGED” | 表示设备NFC状态已更改的公共事件。 |
| static const char* const COMMON_EVENT_NFC_ACTION_RF_FIELD_ON_DETECTED = “usual.event.nfc.action.RF_FIELD_ON_DETECTED” | 表示检测到NFC场强进入的公共事件。 |
| static const char* const COMMON_EVENT_NFC_ACTION_RF_FIELD_OFF_DETECTED = “usual.event.nfc.action.RF_FIELD_OFF_DETECTED” | 表示检测到NFC场强离开的公共事件。 |
| static const char* const COMMON_EVENT_DISCHARGING = “usual.event.DISCHARGING” | 表示系统停止为电池充电的公共事件。 |
| static const char* const COMMON_EVENT_CHARGING = “usual.event.CHARGING” | 表示系统开始为电池充电的公共事件。 |
| static const char* const COMMON_EVENT_DEVICE_IDLE_MODE_CHANGED = “usual.event.DEVICE_IDLE_MODE_CHANGED” | 表示系统待机空闲模式已更改的公共事件。 |
| static const char* const COMMON_EVENT_CHARGE_IDLE_MODE_CHANGED = “usual.event.CHARGE_IDLE_MODE_CHANGED” | 表示设备进入充电空闲模式的公共事件。 |
| static const char* const COMMON_EVENT_POWER_SAVE_MODE_CHANGED = “usual.event.POWER_SAVE_MODE_CHANGED” | 表示系统节能模式更改的公共事件。 |
| static const char* const COMMON_EVENT_USB_STATE = “usual.event.hardware.usb.action.USB_STATE” | 表示USB设备状态发生变化的公共事件。 |
| static const char* const COMMON_EVENT_USB_PORT_CHANGED = “usual.event.hardware.usb.action.USB_PORT_CHANGED” | 表示用户设备的USB端口状态发生改变的公共事件。 |
| static const char* const COMMON_EVENT_USB_DEVICE_ATTACHED = “usual.event.hardware.usb.action.USB_DEVICE_ATTACHED” | 当用户设备作为USB主机时，USB设备已挂载的公共事件。 |
| static const char* const COMMON_EVENT_USB_DEVICE_DETACHED = “usual.event.hardware.usb.action.USB_DEVICE_DETACHED” | 当用户设备作为USB主机时，USB设备被卸载的公共事件。 |
| static const char* const COMMON_EVENT_AIRPLANE_MODE_CHANGED = “usual.event.AIRPLANE_MODE” | 表示设备飞行模式已更改的公共事件。 |
| static const char* const COMMON_EVENT_SPLIT_SCREEN = “common.event.SPLIT_SCREEN” | 表示分屏的公共事件。 |
| static const char* const COMMON_EVENT_QUICK_FIX_APPLY_RESULT = “usual.event.QUICK_FIX_APPLY_RESULT” | 表示快速修复应用的公共事件。 |
| static const char* const COMMON_EVENT_QUICK_FIX_REVOKE_RESULT = “usual.event.QUICK_FIX_REVOKE_RESULT” | 表示撤销快速修复的公共事件。 |
| static const char* const COMMON_EVENT_USER_INFO_UPDATED = “usual.event.USER_INFO_UPDATED” | 表示用户信息已更新的公共事件。 |
| static const char* const COMMON_EVENT_SIM_STATE_CHANGED = “usual.event.SIM_STATE_CHANGED” | 表示SIM卡状态更新的公共事件。 |
| static const char* const COMMON_EVENT_CALL_STATE_CHANGED = “usual.event.CALL_STATE_CHANGED” | 表示呼叫状态更新的公共事件。 |
| static const char* const COMMON_EVENT_NETWORK_STATE_CHANGED = “usual.event.NETWORK_STATE_CHANGED” | 表示网络状态更新的公共事件。 |
| static const char* const COMMON_EVENT_SIGNAL_INFO_CHANGED = “usual.event.SIGNAL_INFO_CHANGED” | 表示信号信息更新的公共事件。 |
| static const char* const COMMON_EVENT_SCREEN_UNLOCKED = “usual.event.SCREEN_UNLOCKED” | 表示屏幕解锁的公共事件。 |
| static const char* const COMMON_EVENT_SCREEN_LOCKED = “usual.event.SCREEN_LOCKED” | 表示屏幕锁定的公共事件。 |
| static const char* const COMMON_EVENT_HTTP_PROXY_CHANGE = “usual.event.HTTP_PROXY_CHANGE” | 表示HTTP代理的配置信息发生变化的公共事件。 |
| static const char* const COMMON_EVENT_CONNECTIVITY_CHANGE = “usual.event.CONNECTIVITY_CHANGE” | 表示网络连接状态变化的公共事件。 |
| static const char* const COMMON_EVENT_MINORSMODE_ON = “usual.event.MINORSMODE_ON” | 表示未成年人模式开启的公共事件。 |
| static const char* const COMMON_EVENT_MINORSMODE_OFF = “usual.event.MINORSMODE_OFF” | 表示未成年人模式关闭的公共事件。 |
类型定义说明
CommonEvent_SubscribeInfo
typedef struct CommonEvent_SubscribeInfo CommonEvent_SubscribeInfo
描述
订阅者信息。
起始版本： 12
CommonEvent_Subscriber
typedef void CommonEvent_Subscriber
描述
订阅者。
起始版本： 12
CommonEvent_RcvData
typedef struct CommonEvent_RcvData CommonEvent_RcvData
描述
公共事件的回调数据。
起始版本： 12
CommonEvent_Parameters
typedef void CommonEvent_Parameters
描述
公共事件的回调附加信息。
起始版本： 12
CommonEvent_ReceiveCallback
typedef void (*CommonEvent_ReceiveCallback)(const CommonEvent_RcvData *data)
描述
公共事件的回调函数。
起始版本： 12
CommonEvent_PublishInfo
typedef struct CommonEvent_PublishInfo CommonEvent_PublishInfo
描述
发布自定义公共事件时使用的公共事件属性对象。
起始版本： 18
枚举类型说明
CommonEvent_ErrCode
描述
表示错误码信息。
起始版本： 12
| 枚举值 | 描述 |
|---|---|
| COMMONEVENT_ERR_OK = 0 | 执行成功。 |
| COMMONEVENT_ERR_PERMISSION_ERROR = 201 | 没有权限。 |
| COMMONEVENT_ERR_INVALID_PARAMETER = 401 | 无效的参数。 |
| COMMONEVENT_ERR_NOT_SYSTEM_SERVICE = 1500004 | 当前应用无法发送系统公共事件。 |
| COMMONEVENT_ERR_SENDING_REQUEST_FAILED = 1500007 | 发送IPC请求失败。 |
| COMMONEVENT_ERR_INIT_UNDONE = 1500008 | 服务未初始化。 |
| COMMONEVENT_ERR_SUBSCRIBER_NUM_EXCEEDED = 1500010 | 订阅者数量超过200个。 |
| COMMONEVENT_ERR_ALLOC_MEMORY_FAILED = 1500011 | 系统分配内存失败。 |
常量说明
COMMON_EVENT_SHUTDOWN
static const char* const COMMON_EVENT_SHUTDOWN = "usual.event.SHUTDOWN"
描述
表示设备正在关闭并将继续直至最终关闭的公共事件。
起始版本： 12
COMMON_EVENT_BATTERY_CHANGED
static const char* const COMMON_EVENT_BATTERY_CHANGED = "usual.event.BATTERY_CHANGED"
描述
表示电池充电状态、电平和其他信息发生变化的公共事件。
起始版本： 12
COMMON_EVENT_BATTERY_LOW
static const char* const COMMON_EVENT_BATTERY_LOW = "usual.event.BATTERY_LOW"
描述
表示电池电量低的公共事件。
起始版本： 12
COMMON_EVENT_BATTERY_OKAY
static const char* const COMMON_EVENT_BATTERY_OKAY = "usual.event.BATTERY_OKAY"
描述
表示电池退出低电平状态的公共事件。
起始版本： 12
COMMON_EVENT_POWER_CONNECTED
static const char* const COMMON_EVENT_POWER_CONNECTED = "usual.event.POWER_CONNECTED"
描述
表示设备连接到外部电源的公共事件。
起始版本： 12
COMMON_EVENT_POWER_DISCONNECTED
static const char* const COMMON_EVENT_POWER_DISCONNECTED = "usual.event.POWER_DISCONNECTED"
描述
表示设备与外部电源断开的公共事件。
起始版本： 12
COMMON_EVENT_SCREEN_OFF
static const char* const COMMON_EVENT_SCREEN_OFF = "usual.event.SCREEN_OFF"
描述
表示设备屏幕关闭且设备处于睡眠状态的公共事件。
起始版本： 12
COMMON_EVENT_SCREEN_ON
static const char* const COMMON_EVENT_SCREEN_ON = "usual.event.SCREEN_ON"
描述
表示设备屏幕打开且设备处于交互状态的公共事件。
起始版本： 12
COMMON_EVENT_THERMAL_LEVEL_CHANGED
static const char* const COMMON_EVENT_THERMAL_LEVEL_CHANGED = "usual.event.THERMAL_LEVEL_CHANGED"
描述
表示设备热状态的公共事件。
起始版本： 12
COMMON_EVENT_TIME_TICK
static const char* const COMMON_EVENT_TIME_TICK = "usual.event.TIME_TICK"
描述
表示系统时间随时间流逝而发生变化的公共事件。
起始版本： 12
COMMON_EVENT_TIME_CHANGED
static const char* const COMMON_EVENT_TIME_CHANGED = "usual.event.TIME_CHANGED"
描述
表示系统时间被重新设置的公共事件。
起始版本： 12
COMMON_EVENT_TIMEZONE_CHANGED
static const char* const COMMON_EVENT_TIMEZONE_CHANGED = "usual.event.TIMEZONE_CHANGED"
描述
表示系统时区更改的公共事件。
起始版本： 12
COMMON_EVENT_PACKAGE_ADDED
static const char* const COMMON_EVENT_PACKAGE_ADDED = "usual.event.PACKAGE_ADDED"
描述
表示设备上已安装新应用包的公共事件。
起始版本： 12
COMMON_EVENT_PACKAGE_REMOVED
static const char* const COMMON_EVENT_PACKAGE_REMOVED = "usual.event.PACKAGE_REMOVED"
描述
表示已从设备卸载已安装的应用程序，但应用程序数据保留的公共事件。
起始版本： 12
COMMON_EVENT_BUNDLE_REMOVED
static const char* const COMMON_EVENT_BUNDLE_REMOVED = "usual.event.BUNDLE_REMOVED"
描述
表示已从设备中卸载已安装的捆绑包，但应用程序数据仍保留的公共事件。
起始版本： 12
COMMON_EVENT_PACKAGE_FULLY_REMOVED
static const char* const COMMON_EVENT_PACKAGE_FULLY_REMOVED = "usual.event.PACKAGE_FULLY_REMOVED"
描述
表示已从设备中完全卸载已安装的应用程序（包括应用程序数据和代码）的公共事件。
起始版本： 12
COMMON_EVENT_PACKAGE_CHANGED
static const char* const COMMON_EVENT_PACKAGE_CHANGED = "usual.event.PACKAGE_CHANGED"
描述
表示应用包已更改的公共事件（例如，包中的组件已启用或禁用）。
起始版本： 12
COMMON_EVENT_PACKAGE_RESTARTED
static const char* const COMMON_EVENT_PACKAGE_RESTARTED = "usual.event.PACKAGE_RESTARTED"
描述
表示用户重启应用包并杀死其所有进程的公共事件。
起始版本： 12
COMMON_EVENT_PACKAGE_DATA_CLEARED
static const char* const COMMON_EVENT_PACKAGE_DATA_CLEARED = "usual.event.PACKAGE_DATA_CLEARED"
描述
表示用户清除应用包数据的公共事件。
起始版本： 12
COMMON_EVENT_PACKAGE_CACHE_CLEARED
static const char* const COMMON_EVENT_PACKAGE_CACHE_CLEARED = "usual.event.PACKAGE_CACHE_CLEARED"
描述
表示用户清除应用包缓存数据的公共事件。
起始版本： 12
COMMON_EVENT_PACKAGES_SUSPENDED
static const char* const COMMON_EVENT_PACKAGES_SUSPENDED = "usual.event.PACKAGES_SUSPENDED"
描述
表示应用包已挂起的公共事件。
起始版本： 12
COMMON_EVENT_MY_PACKAGE_SUSPENDED
static const char* const COMMON_EVENT_MY_PACKAGE_SUSPENDED = "usual.event.MY_PACKAGE_SUSPENDED"
描述
表示应用程序包已被挂起的公共事件，该事件可以发送到被挂起的应用程序包。
起始版本： 12
COMMON_EVENT_MY_PACKAGE_UNSUSPENDED
static const char* const COMMON_EVENT_MY_PACKAGE_UNSUSPENDED = "usual.event.MY_PACKAGE_UNSUSPENDED"
描述
表示应用包未挂起的公共事件。
起始版本： 12
COMMON_EVENT_LOCALE_CHANGED
static const char* const COMMON_EVENT_LOCALE_CHANGED = "usual.event.LOCALE_CHANGED"
描述
表示设备区域设置已更改的公共事件。
起始版本： 12
COMMON_EVENT_MANAGE_PACKAGE_STORAGE
static const char* const COMMON_EVENT_MANAGE_PACKAGE_STORAGE = "usual.event.MANAGE_PACKAGE_STORAGE"
描述
表示设备存储空间不足的公共事件。
起始版本： 12
COMMON_EVENT_USER_UNLOCKED
static const char* const COMMON_EVENT_USER_UNLOCKED = "usual.event.USER_UNLOCKED"
描述
表示设备重启后解锁时，当前用户的凭据加密存储已解锁的公共事件。
起始版本： 12
COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOUT
static const char* const COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOUT = "common.event.DISTRIBUTED_ACCOUNT_LOGOUT"
描述
表示分布式账号登出成功的公共事件。
起始版本： 12
COMMON_EVENT_DISTRIBUTED_ACCOUNT_TOKEN_INVALID
static const char* const COMMON_EVENT_DISTRIBUTED_ACCOUNT_TOKEN_INVALID = "common.event.DISTRIBUTED_ACCOUNT_TOKEN_INVALID"
描述
表示分布式账号token令牌无效的公共事件。
起始版本： 12
COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOFF
static const char* const COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOFF = "common.event.DISTRIBUTED_ACCOUNT_LOGOFF"
描述
表示分布式账号注销的公共事件。
起始版本： 12
COMMON_EVENT_WIFI_POWER_STATE
static const char* const COMMON_EVENT_WIFI_POWER_STATE = "usual.event.wifi.POWER_STATE"
描述
表示Wi-Fi状态公共事件，如启用和禁用。
起始版本： 12
COMMON_EVENT_WIFI_SCAN_FINISHED
static const char* const COMMON_EVENT_WIFI_SCAN_FINISHED = "usual.event.wifi.SCAN_FINISHED"
描述
表示Wi-Fi接入点已被扫描并证明可用的公共事件。
起始版本： 12
COMMON_EVENT_WIFI_RSSI_VALUE
static const char* const COMMON_EVENT_WIFI_RSSI_VALUE = "usual.event.wifi.RSSI_VALUE"
描述
表示Wi-Fi信号强度（RSSI）改变的公共事件。
起始版本： 12
COMMON_EVENT_WIFI_CONN_STATE
static const char* const COMMON_EVENT_WIFI_CONN_STATE = "usual.event.wifi.CONN_STATE"
描述
表示Wi-Fi连接状态发生改变的公共事件。
起始版本： 12
COMMON_EVENT_WIFI_HOTSPOT_STATE
static const char* const COMMON_EVENT_WIFI_HOTSPOT_STATE = "usual.event.wifi.HOTSPOT_STATE"
描述
表示Wi-Fi热点状态的公共事件。
起始版本： 12
COMMON_EVENT_WIFI_AP_STA_JOIN
static const char* const COMMON_EVENT_WIFI_AP_STA_JOIN = "usual.event.wifi.WIFI_HS_STA_JOIN"
描述
表示客户端加入当前设备Wi-Fi热点的公共事件。
起始版本： 12
COMMON_EVENT_WIFI_AP_STA_LEAVE
static const char* const COMMON_EVENT_WIFI_AP_STA_LEAVE = "usual.event.wifi.WIFI_HS_STA_LEAVE"
描述
表示客户端已断开与当前设备Wi-Fi热点的连接的公共事件。
起始版本： 12
COMMON_EVENT_WIFI_MPLINK_STATE_CHANGE
static const char* const COMMON_EVENT_WIFI_MPLINK_STATE_CHANGE = "usual.event.wifi.mplink.STATE_CHANGE"
描述
表示MPLink（增强Wi-Fi功能）状态已更改的公共事件。
起始版本： 12
COMMON_EVENT_WIFI_P2P_CONN_STATE
static const char* const COMMON_EVENT_WIFI_P2P_CONN_STATE = "usual.event.wifi.p2p.CONN_STATE_CHANGE"
描述
表示Wi-Fi P2P连接状态改变的公共事件。
起始版本： 12
COMMON_EVENT_WIFI_P2P_STATE_CHANGED
static const char* const COMMON_EVENT_WIFI_P2P_STATE_CHANGED = "usual.event.wifi.p2p.STATE_CHANGE"
描述
表示Wi-Fi P2P状态公共事件，如启用和禁用。
COMMON_EVENT_WIFI_P2P_PEERS_STATE_CHANGED
static const char* const COMMON_EVENT_WIFI_P2P_PEERS_STATE_CHANGED = "usual.event.wifi.p2p.DEVICES_CHANGE"
描述
表示Wi-Fi P2P对等体状态变化的公共事件。
起始版本： 12
COMMON_EVENT_WIFI_P2P_PEERS_DISCOVERY_STATE_CHANGED
static const char* const COMMON_EVENT_WIFI_P2P_PEERS_DISCOVERY_STATE_CHANGED = "usual.event.wifi.p2p.PEER_DISCOVERY_STATE_CHANGE"
描述
表示Wi-Fi P2P发现状态变化的公共事件。
起始版本： 12
COMMON_EVENT_WIFI_P2P_CURRENT_DEVICE_STATE_CHANGED
static const char* const COMMON_EVENT_WIFI_P2P_CURRENT_DEVICE_STATE_CHANGED = "usual.event.wifi.p2p.CURRENT_DEVICE_CHANGE"
描述
表示Wi-Fi P2P当前设备状态变化的公共事件。
起始版本： 12
COMMON_EVENT_WIFI_P2P_GROUP_STATE_CHANGED
static const char* const COMMON_EVENT_WIFI_P2P_GROUP_STATE_CHANGED = "usual.event.wifi.p2p.GROUP_STATE_CHANGED"
描述
表示Wi-Fi P2P群组信息已更改的公共事件。
起始版本： 12
COMMON_EVENT_NFC_ACTION_ADAPTER_STATE_CHANGED
static const char* const COMMON_EVENT_NFC_ACTION_ADAPTER_STATE_CHANGED = "usual.event.nfc.action.ADAPTER_STATE_CHANGED"
描述
表示设备NFC状态已更改的公共事件。
起始版本： 12
COMMON_EVENT_NFC_ACTION_RF_FIELD_ON_DETECTED
static const char* const COMMON_EVENT_NFC_ACTION_RF_FIELD_ON_DETECTED = "usual.event.nfc.action.RF_FIELD_ON_DETECTED"
描述
表示检测到NFC场强进入的公共事件。
起始版本： 12
COMMON_EVENT_NFC_ACTION_RF_FIELD_OFF_DETECTED
static const char* const COMMON_EVENT_NFC_ACTION_RF_FIELD_OFF_DETECTED = "usual.event.nfc.action.RF_FIELD_OFF_DETECTED"
描述
表示检测到NFC场强离开的公共事件。
起始版本： 12
COMMON_EVENT_DISCHARGING
static const char* const COMMON_EVENT_DISCHARGING = "usual.event.DISCHARGING"
描述
表示系统停止为电池充电的公共事件。
起始版本： 12
COMMON_EVENT_CHARGING
static const char* const COMMON_EVENT_CHARGING = "usual.event.CHARGING"
描述
表示系统开始为电池充电的公共事件。
COMMON_EVENT_DEVICE_IDLE_MODE_CHANGED
static const char* const COMMON_EVENT_DEVICE_IDLE_MODE_CHANGED = "usual.event.DEVICE_IDLE_MODE_CHANGED"
描述
表示系统待机空闲模式已更改的公共事件。
起始版本： 12
COMMON_EVENT_CHARGE_IDLE_MODE_CHANGED
static const char* const COMMON_EVENT_CHARGE_IDLE_MODE_CHANGED = "usual.event.CHARGE_IDLE_MODE_CHANGED"
描述
表示设备进入充电空闲模式的公共事件。
起始版本： 12
COMMON_EVENT_POWER_SAVE_MODE_CHANGED
static const char* const COMMON_EVENT_POWER_SAVE_MODE_CHANGED = "usual.event.POWER_SAVE_MODE_CHANGED"
描述
表示系统节能模式更改的公共事件。
起始版本： 12
COMMON_EVENT_USB_STATE
static const char* const COMMON_EVENT_USB_STATE = "usual.event.hardware.usb.action.USB_STATE"
描述
表示USB设备状态发生变化的公共事件。
起始版本： 12
COMMON_EVENT_USB_PORT_CHANGED
static const char* const COMMON_EVENT_USB_PORT_CHANGED = "usual.event.hardware.usb.action.USB_PORT_CHANGED"
描述
表示用户设备的USB端口状态发生改变的公共事件。
起始版本： 12
COMMON_EVENT_USB_DEVICE_ATTACHED
static const char* const COMMON_EVENT_USB_DEVICE_ATTACHED = "usual.event.hardware.usb.action.USB_DEVICE_ATTACHED"
描述
当用户设备作为USB主机时，USB设备已挂载的公共事件。
起始版本： 12
COMMON_EVENT_USB_DEVICE_DETACHED
static const char* const COMMON_EVENT_USB_DEVICE_DETACHED = "usual.event.hardware.usb.action.USB_DEVICE_DETACHED"
描述
当用户设备作为USB主机时，USB设备被卸载的公共事件。
起始版本： 12
COMMON_EVENT_AIRPLANE_MODE_CHANGED
static const char* const COMMON_EVENT_AIRPLANE_MODE_CHANGED = "usual.event.AIRPLANE_MODE"
描述
表示设备飞行模式已更改的公共事件。
起始版本： 12
COMMON_EVENT_SPLIT_SCREEN
static const char* const COMMON_EVENT_SPLIT_SCREEN = "common.event.SPLIT_SCREEN"
描述
表示分屏的公共事件。
起始版本： 12
COMMON_EVENT_QUICK_FIX_APPLY_RESULT
static const char* const COMMON_EVENT_QUICK_FIX_APPLY_RESULT = "usual.event.QUICK_FIX_APPLY_RESULT"
描述
表示快速修复应用的公共事件。
起始版本： 12
COMMON_EVENT_QUICK_FIX_REVOKE_RESULT
static const char* const COMMON_EVENT_QUICK_FIX_REVOKE_RESULT = "usual.event.QUICK_FIX_REVOKE_RESULT"
描述
表示撤销快速修复的公共事件。
起始版本： 12
COMMON_EVENT_USER_INFO_UPDATED
static const char* const COMMON_EVENT_USER_INFO_UPDATED = "usual.event.USER_INFO_UPDATED"
描述
表示用户信息已更新的公共事件。
起始版本： 12
COMMON_EVENT_SIM_STATE_CHANGED
static const char* const COMMON_EVENT_SIM_STATE_CHANGED = "usual.event.SIM_STATE_CHANGED"
描述
表示SIM卡状态更新的公共事件。
起始版本： 12
COMMON_EVENT_CALL_STATE_CHANGED
static const char* const COMMON_EVENT_CALL_STATE_CHANGED = "usual.event.CALL_STATE_CHANGED"
描述
表示呼叫状态更新的公共事件。
起始版本： 12
COMMON_EVENT_NETWORK_STATE_CHANGED
static const char* const COMMON_EVENT_NETWORK_STATE_CHANGED = "usual.event.NETWORK_STATE_CHANGED"
描述
表示网络状态更新的公共事件。
起始版本： 12
COMMON_EVENT_SIGNAL_INFO_CHANGED
static const char* const COMMON_EVENT_SIGNAL_INFO_CHANGED = "usual.event.SIGNAL_INFO_CHANGED"
描述
表示信号信息更新的公共事件。
起始版本： 12
COMMON_EVENT_SCREEN_UNLOCKED
static const char* const COMMON_EVENT_SCREEN_UNLOCKED = "usual.event.SCREEN_UNLOCKED"
描述
表示屏幕解锁的公共事件。
起始版本： 12
COMMON_EVENT_SCREEN_LOCKED
static const char* const COMMON_EVENT_SCREEN_LOCKED = "usual.event.SCREEN_LOCKED"
描述
表示屏幕锁定的公共事件。
起始版本： 12
COMMON_EVENT_HTTP_PROXY_CHANGE
static const char* const COMMON_EVENT_HTTP_PROXY_CHANGE = "usual.event.HTTP_PROXY_CHANGE"
描述
表示HTTP代理的配置信息发生变化的公共事件。
起始版本： 12
COMMON_EVENT_CONNECTIVITY_CHANGE
static const char* const COMMON_EVENT_CONNECTIVITY_CHANGE = "usual.event.CONNECTIVITY_CHANGE"
描述
表示网络连接状态变化的公共事件。
起始版本： 12
COMMON_EVENT_MINORSMODE_ON
static const char* const COMMON_EVENT_MINORSMODE_ON = "usual.event.MINORSMODE_ON"
描述
表示未成年人模式开启的公共事件。
起始版本： 12
COMMON_EVENT_MINORSMODE_OFF
static const char* const COMMON_EVENT_MINORSMODE_OFF = "usual.event.MINORSMODE_OFF"
描述
表示未成年人模式关闭的公共事件。
起始版本： 12
函数说明
OH_CommonEvent_CreateSubscribeInfo
CommonEvent_SubscribeInfo* OH_CommonEvent_CreateSubscribeInfo(const char* events[], int32_t eventsNum)
描述
创建订阅者信息。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| events | 订阅的事件。 |
| eventsNum | 事件数量。 |
返回：
返回订阅者信息。
OH_CommonEvent_SetPublisherPermission
CommonEvent_ErrCode OH_CommonEvent_SetPublisherPermission(CommonEvent_SubscribeInfo* info, const char* permission)
描述
设置订阅者权限。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| info | 订阅者信息。 |
| permission | 权限名称。 |
返回：
返回COMMONEVENT_ERR_OK表示成功。
返回COMMONEVENT_ERR_INVALID_PARAMETER表示info为空指针。
OH_CommonEvent_SetPublisherBundleName
CommonEvent_ErrCode OH_CommonEvent_SetPublisherBundleName(CommonEvent_SubscribeInfo* info, const char* bundleName)
描述
设置订阅者包名称。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| info | 订阅者信息。 |
| bundleName | 包名称。 |
返回：
返回COMMONEVENT_ERR_OK表示成功。
返回COMMONEVENT_ERR_INVALID_PARAMETER表示info为空指针。
OH_CommonEvent_DestroySubscribeInfo
void OH_CommonEvent_DestroySubscribeInfo(CommonEvent_SubscribeInfo* info)
描述
销毁订阅者信息。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| info | 订阅者信息。 |
OH_CommonEvent_CreateSubscriber
CommonEvent_Subscriber* OH_CommonEvent_CreateSubscriber(const CommonEvent_SubscribeInfo* info, CommonEvent_ReceiveCallback callback)
描述
创建订阅者。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| info | 订阅者信息。 |
| callback | 事件回调函数。 |
返回：
返回订阅者。
OH_CommonEvent_DestroySubscriber
void OH_CommonEvent_DestroySubscriber(CommonEvent_Subscriber* subscriber)
描述
销毁订阅者。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| subscriber | 订阅者。 |
OH_CommonEvent_Subscribe
CommonEvent_ErrCode OH_CommonEvent_Subscribe(const CommonEvent_Subscriber* subscriber)
描述
订阅公共事件。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| subscriber | 订阅者。 |
返回：
返回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表示系统分配内存失败。
OH_CommonEvent_UnSubscribe
CommonEvent_ErrCode OH_CommonEvent_UnSubscribe(const CommonEvent_Subscriber* subscriber)
描述
退订公共事件。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| subscriber | 订阅者。 |
返回：
返回COMMONEVENT_ERR_OK表示成功。
返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数subscriber为空。
返回COMMONEVENT_ERR_SENDING_REQUEST_FAILED表示IPC发送失败。
返回COMMONEVENT_ERR_INIT_UNDONE表示公共事件服务未初始化。
OH_CommonEvent_GetEventFromRcvData
const char* OH_CommonEvent_GetEventFromRcvData(const CommonEvent_RcvData* rcvData)
描述
获取回调公共事件名称。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| rcvData | 公共事件回调数据。 |
返回：
返回公共事件名称。
OH_CommonEvent_GetCodeFromRcvData
int32_t OH_CommonEvent_GetCodeFromRcvData(const CommonEvent_RcvData* rcvData)
描述
获取回调公共事件结果代码。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| rcvData | 公共事件回调数据。 |
返回：
返回公共事件结果代码。默认为0。
OH_CommonEvent_GetDataStrFromRcvData
const char* OH_CommonEvent_GetDataStrFromRcvData(const CommonEvent_RcvData* rcvData)
描述
获取回调公共事件自定义结果数据。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| rcvData | 公共事件回调数据。 |
返回：
返回公共事件自定义结果数据。默认为null。
OH_CommonEvent_GetBundleNameFromRcvData
const char* OH_CommonEvent_GetBundleNameFromRcvData(const CommonEvent_RcvData* rcvData)
描述
获取回调公共事件包名称。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| rcvData | 公共事件回调数据。 |
返回：
返回公共事件包名称。默认为null。
OH_CommonEvent_GetParametersFromRcvData
const CommonEvent_Parameters* OH_CommonEvent_GetParametersFromRcvData(const CommonEvent_RcvData* rcvData)
描述
获取回调公共事件附件信息。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| rcvData | 公共事件回调数据。 |
返回：
返回公共事件附加信息。默认为null。
OH_CommonEvent_HasKeyInParameters
bool OH_CommonEvent_HasKeyInParameters(const CommonEvent_Parameters* para, const char* key)
描述
查询公共事件附加信息中是否存在该键值对信息。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| para | 公共事件附加信息。 |
| key | 数据键。 |
返回：
返回true表示存在该键值对信息。
返回false表示不存在该键值对信息。
OH_CommonEvent_GetIntFromParameters
int OH_CommonEvent_GetIntFromParameters(const CommonEvent_Parameters* para, const char* key, const int defaultValue)
描述
获取公共事件附加信息中键为key的int类型数据。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| para | 公共事件附加信息。 |
| key | 数据键。 |
| defaultValue | 默认返回值。 |
OH_CommonEvent_GetIntArrayFromParameters
int32_t OH_CommonEvent_GetIntArrayFromParameters(const CommonEvent_Parameters* para, const char* key, int** array)
描述
获取公共事件附加信息中键为key的int数组数据。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| para | 公共事件附加信息。 |
| key | 数据键。 |
| array | 接收数据的int数组。 |
返回：
返回数组长度。
OH_CommonEvent_GetLongFromParameters
long OH_CommonEvent_GetLongFromParameters(const CommonEvent_Parameters* para, const char* key, const long defaultValue)
描述
获取公共事件附加信息中键为key的long类型数据。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| para | 公共事件附加信息。 |
| key | 数据键。 |
| defaultValue | 默认返回值。 |
OH_CommonEvent_GetLongArrayFromParameters
int32_t OH_CommonEvent_GetLongArrayFromParameters(const CommonEvent_Parameters* para, const char* key, long** array)
描述
获取公共事件附加信息中键为key的long数组数据。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| para | 公共事件附加信息。 |
| key | 数据键。 |
| array | 接收数据的long数组。 |
返回：
返回数组长度。
OH_CommonEvent_GetBoolFromParameters
bool OH_CommonEvent_GetBoolFromParameters(const CommonEvent_Parameters* para, const char* key, const bool defaultValue)
描述
获取公共事件附加信息中键为key的布尔类型数据。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| para | 公共事件附加信息。 |
| key | 数据键。 |
| defaultValue | 默认返回值。 |
OH_CommonEvent_GetBoolArrayFromParameters
int32_t OH_CommonEvent_GetBoolArrayFromParameters(const CommonEvent_Parameters* para, const char* key, bool** array)
描述
获取公共事件附加信息中键为key的布尔数组数据。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| para | 公共事件附加信息。 |
| key | 数据键。 |
| array | 接收数据的long数组。 |
返回：
返回数组长度。
OH_CommonEvent_GetCharFromParameters
char OH_CommonEvent_GetCharFromParameters(const CommonEvent_Parameters* para, const char* key, const char defaultValue)
描述
获取公共事件附加信息中键为key的字符类型数据。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| para | 公共事件附加信息。 |
| key | 数据键。 |
| defaultValue | 默认返回值。 |
OH_CommonEvent_GetCharArrayFromParameters
int32_t OH_CommonEvent_GetCharArrayFromParameters(const CommonEvent_Parameters* para, const char* key, char** array)
描述
获取公共事件附加信息中键为key的字符数组数据。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| para | 公共事件附加信息。 |
| key | 数据键。 |
| array | 接收数据的字符数组。 |
返回：
返回数组长度。
OH_CommonEvent_GetDoubleFromParameters
double OH_CommonEvent_GetDoubleFromParameters(const CommonEvent_Parameters* para, const char* key, const double defaultValue)
描述
获取公共事件附加信息中键为key的double类型数据。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| para | 公共事件附加信息。 |
| key | 数据键。 |
| defaultValue | 默认返回值。 |
OH_CommonEvent_GetDoubleArrayFromParameters
int32_t OH_CommonEvent_GetDoubleArrayFromParameters(const CommonEvent_Parameters* para, const char* key, double** array)
描述
获取公共事件附加信息中键为key的double数组数据。
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| para | 公共事件附加信息。 |
| key | 数据键。 |
| array | 接收数据的字符数组。 |
返回：
返回数组长度。默认为0。
OH_CommonEvent_CreateParameters
CommonEvent_Parameters* OH_CommonEvent_CreateParameters()
描述
创建公共事件附加信息对象。
起始版本： 18
参数：
无。
返回：
返回公共事件附加信息，创建失败时，返回null。
OH_CommonEvent_DestroyParameters
void OH_CommonEvent_DestroyParameters(CommonEvent_Parameters* param)
描述
销毁公共事件附加信息对象。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| param | 公共事件附加信息。 |
返回：
无。
OH_CommonEvent_SetIntToParameters
CommonEvent_ErrCode OH_CommonEvent_SetIntToParameters(CommonEvent_Parameters* param, const char* key, int value)
描述
设置公共事件附加信息的int类型内容。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| param | 公共事件附加信息。 |
| key | 数据键。 |
| value | 设置的int类型内容。 |
返回：
返回COMMONEVENT_ERR_OK表示成功。
返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。
OH_CommonEvent_SetIntArrayToParameters
CommonEvent_ErrCode OH_CommonEvent_SetIntArrayToParameters(CommonEvent_Parameters* param, const char* key, const int* value, size_t num)
描述
设置公共事件附加信息的int数组内容。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| param | 公共事件附加信息。 |
| key | 数据键。 |
| value | 设置的int数组内容。 |
| num | 设置的int数组内容中元素的个数。 |
返回：
返回COMMONEVENT_ERR_OK表示成功。
返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。
返回COMMONEVENT_ERR_ALLOC_MEMORY_FAILED表示内存分配失败。
OH_CommonEvent_SetLongToParameters
CommonEvent_ErrCode OH_CommonEvent_SetLongToParameters(CommonEvent_Parameters* param, const char* key, long value)
描述
设置公共事件附加信息的long类型内容。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| param | 公共事件附加信息。 |
| key | 数据键。 |
| value | 设置的long类型内容。 |
返回：
返回COMMONEVENT_ERR_OK表示成功。
返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。
OH_CommonEvent_SetLongArrayToParameters
CommonEvent_ErrCode OH_CommonEvent_SetLongArrayToParameters(CommonEvent_Parameters* param, const char* key, const long* value, size_t num)
描述
设置公共事件附加信息的long数组内容。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| param | 公共事件附加信息。 |
| key | 数据键。 |
| value | 设置的long数组内容。 |
| num | 设置的long数组内容中元素的个数。 |
返回：
返回COMMONEVENT_ERR_OK表示成功。
返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。
返回COMMONEVENT_ERR_ALLOC_MEMORY_FAILED表示内存分配失败。
OH_CommonEvent_SetDoubleToParameters
CommonEvent_ErrCode OH_CommonEvent_SetDoubleToParameters(CommonEvent_Parameters* param, const char* key, double value)
描述
设置公共事件附加信息的double类型内容。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| param | 公共事件附加信息。 |
| key | 数据键。 |
| value | 设置的double类型内容。 |
返回：
返回COMMONEVENT_ERR_OK表示成功。
返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。
OH_CommonEvent_SetDoubleArrayToParameters
CommonEvent_ErrCode OH_CommonEvent_SetDoubleArrayToParameters(CommonEvent_Parameters* param, const char* key, const double* value, size_t num)
描述
设置公共事件附加信息的double数组内容。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| param | 公共事件附加信息。 |
| key | 数据键。 |
| value | 设置的double数组内容。 |
| num | 设置的double数组内容中元素的个数。 |
返回：
返回COMMONEVENT_ERR_OK表示成功。
返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。
返回COMMONEVENT_ERR_ALLOC_MEMORY_FAILED表示内存分配失败。
OH_CommonEvent_SetBoolToParameters
CommonEvent_ErrCode OH_CommonEvent_SetBoolToParameters(CommonEvent_Parameters* param, const char* key, bool value)
描述
设置公共事件附加信息的布尔类型内容。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| param | 公共事件附加信息。 |
| key | 数据键。 |
| value | 设置的布尔类型内容。 |
返回：
返回COMMONEVENT_ERR_OK表示成功。
返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。
OH_CommonEvent_SetBoolArrayToParameters
CommonEvent_ErrCode OH_CommonEvent_SetBoolArrayToParameters(CommonEvent_Parameters* param, const char* key, const bool* value, size_t num)
描述
设置公共事件附加信息的布尔数组内容。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| param | 公共事件附加信息。 |
| key | 数据键。 |
| value | 设置的布尔数组内容。 |
| num | 设置的布尔数组内容中元素的个数。 |
返回：
返回COMMONEVENT_ERR_OK表示成功。
返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。
返回COMMONEVENT_ERR_ALLOC_MEMORY_FAILED表示内存分配失败。
OH_CommonEvent_SetCharToParameters
CommonEvent_ErrCode OH_CommonEvent_SetCharToParameters(CommonEvent_Parameters* param, const char* key, char value)
描述
设置公共事件附加信息的字符类型内容。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| param | 公共事件附加信息。 |
| key | 数据键。 |
| value | 设置的字符类型内容。 |
返回：
返回COMMONEVENT_ERR_OK表示成功。
返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。
OH_CommonEvent_SetCharArrayToParameters
CommonEvent_ErrCode OH_CommonEvent_SetCharArrayToParameters(CommonEvent_Parameters* param, const char* key, const char* value, size_t num)
描述
设置公共事件附加信息的字符数组内容。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| param | 公共事件附加信息。 |
| key | 数据键。 |
| value | 设置的字符数组内容。 |
| num | 设置的字符数组内容中元素的个数。 |
返回：
返回COMMONEVENT_ERR_OK表示成功。
返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。
返回COMMONEVENT_ERR_ALLOC_MEMORY_FAILED表示内存分配失败。
OH_CommonEvent_CreatePublishInfo
CommonEvent_PublishInfo* OH_CommonEvent_CreatePublishInfo(bool ordered)
描述
创建公共事件属性对象。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| ordered | 是否为有序公共事件。 true：有序公共事件。false：无序公共事件。 |
返回：
创建的公共事件属性对象，创建失败时，返回null。
OH_CommonEvent_DestroyPublishInfo
void OH_CommonEvent_DestroyPublishInfo(CommonEvent_PublishInfo* info)
描述
销毁公共事件属性对象。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| info | 要销毁的公共事件属性对象。 |
返回：
无。
OH_CommonEvent_SetPublishInfoBundleName
CommonEvent_ErrCode OH_CommonEvent_SetPublishInfoBundleName(CommonEvent_PublishInfo* info, const char* bundleName)
描述
设置公共事件包名称。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| info | 公共事件属性对象。 |
| bundleName | 设置的包名称。 |
返回：
返回COMMONEVENT_ERR_OK表示成功。
返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。
OH_CommonEvent_SetPublishInfoPermissions
CommonEvent_ErrCode OH_CommonEvent_SetPublishInfoPermissions(CommonEvent_PublishInfo* info，const char* permissions[], int32_t num)
描述
设置公共事件权限。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| info | 公共事件属性对象。 |
| permissions | 权限名称数组。 |
| num | 权限的数量。 |
返回：
返回COMMONEVENT_ERR_OK表示成功。
返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。
OH_CommonEvent_SetPublishInfoCode
CommonEvent_ErrCode OH_CommonEvent_SetPublishInfoCode(CommonEvent_PublishInfo* info, int32_t code)
描述
设置公共事件结果码。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| info | 公共事件属性对象。 |
| code | 设置的结果码。 |
返回：
返回COMMONEVENT_ERR_OK表示成功。
返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。
OH_CommonEvent_SetPublishInfoData
CommonEvent_ErrCode OH_CommonEvent_SetPublishInfoData(CommonEvent_PublishInfo* info, const char* data, size_t length)
描述
设置公共事件的发布信息结果数据。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| info | 公共事件属性对象。 |
| data | 设置的结果数据。 |
| length | 结果数据的长度。 |
返回：
返回COMMONEVENT_ERR_OK表示成功。
返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。
OH_CommonEvent_SetPublishInfoParameters
CommonEvent_ErrCode OH_CommonEvent_SetPublishInfoParameters(CommonEvent_PublishInfo* info, CommonEvent_Parameters* param)
描述
设置公共事件附加信息。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| info | 公共事件属性对象。 |
| param | 设置的附加信息。 |
返回：
返回COMMONEVENT_ERR_OK表示成功。
返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。
OH_CommonEvent_Publish
CommonEvent_ErrCode OH_CommonEvent_Publish(const char* event)
描述
发布自定义公共事件。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| event | 公共事件名称。 |
返回：
返回COMMONEVENT_ERR_OK表示成功。
返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。
返回COMMONEVENT_ERR_SENDING_REQUEST_FAILED表示IPC发送失败。
返回COMMONEVENT_ERR_INIT_UNDONE表示公共事件服务未初始化。
OH_CommonEvent_PublishWithInfo
CommonEvent_ErrCode OH_CommonEvent_PublishWithInfo(const char* event, const CommonEvent_PublishInfo* info)
描述
发布带有指定属性的自定义公共事件。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| event | 公共事件名称。 |
| info | 设置的公共事件属性。 |
返回：
返回COMMONEVENT_ERR_OK表示成功。
返回COMMONEVENT_ERR_INVALID_PARAMETER表示参数无效。
返回COMMONEVENT_ERR_SENDING_REQUEST_FAILED表示IPC发送失败。
返回COMMONEVENT_ERR_INIT_UNDONE表示公共事件服务未初始化。
OH_CommonEvent_IsOrderedCommonEvent
bool OH_CommonEvent_IsOrderedCommonEvent(const CommonEvent_Subscriber* subscriber)
描述
查询当前公共事件是否为有序公共事件。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| subscriber | 公共事件的订阅者对象。 |
返回：
返回true表示有序公共事件。
返回false表示无序公共事件。
OH_CommonEvent_FinishCommonEvent
bool OH_CommonEvent_FinishCommonEvent(CommonEvent_Subscriber* subscriber)
描述
用于订阅者结束对当前有序公共事件的处理。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| subscriber | 公共事件的订阅者对象。 |
返回：
返回true表示操作成功。
返回false表示操作失败。
OH_CommonEvent_GetAbortCommonEvent
bool OH_CommonEvent_GetAbortCommonEvent(const CommonEvent_Subscriber* subscriber)
描述
获取当前有序公共事件是否处于中止状态。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| subscriber | 公共事件的订阅者对象。 |
返回：
返回true表示当前有序公共事件处于中止状态。
返回false表示当前有序公共事件没有处于中止状态。
OH_CommonEvent_AbortCommonEvent
bool OH_CommonEvent_AbortCommonEvent(CommonEvent_Subscriber* subscriber)
描述
该接口与OH_CommonEvent_FinishCommonEvent配合使用，可以中止当前的有序公共事件，使该公共事件不再向下一个订阅者传递。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| subscriber | 公共事件的订阅者对象。 |
返回：
返回true表示操作成功。
返回false表示操作失败。
OH_CommonEvent_ClearAbortCommonEvent
bool OH_CommonEvent_ClearAbortCommonEvent(CommonEvent_Subscriber* subscriber)
描述
该接口与OH_CommonEvent_FinishCommonEvent配合使用，可以取消当前有序公共事件的中止状态，使该公共事件继续向下一个订阅者传递。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| subscriber | 公共事件的订阅者对象。 |
返回：
返回true表示操作成功。
返回false表示操作失败。
OH_CommonEvent_GetCodeFromSubscriber
int32_t OH_CommonEvent_GetCodeFromSubscriber(const CommonEvent_Subscriber* subscriber)
描述
获取有序公共事件代码。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| subscriber | 公共事件的订阅者对象。 |
返回：
返回有序公共事件的代码，无法获取时返回0。
OH_CommonEvent_GetDataFromSubscriber
const char* OH_CommonEvent_GetDataFromSubscriber(const CommonEvent_Subscriber* subscriber)
描述
获取有序公共事件的数据。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| subscriber | 公共事件的订阅者对象。 |
返回：
返回有序公共事件的数据，无法获取时返回null。
OH_CommonEvent_SetCodeToSubscriber
bool OH_CommonEvent_SetCodeToSubscriber(CommonEvent_Subscriber* subscriber, int32_t code)
描述
设置有序公共事件的代码。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| subscriber | 公共事件的订阅者对象。 |
| code | 公共事件的代码。 |
返回：
返回true表示操作成功。
返回false表示操作失败。
OH_CommonEvent_SetDataToSubscriber
bool OH_CommonEvent_SetDataToSubscriber(CommonEvent_Subscriber* subscriber, const char* data, size_t length)
描述
设置有序公共事件的数据。
起始版本： 18
参数：
| 名称 | 描述 |
|---|---|
| subscriber | 公共事件的订阅者对象。 |
| data | 公共事件的数据。 |
| length | 数据的长度。 |
返回：
返回true表示操作成功。
返回false表示操作失败。
你可能感兴趣的鸿蒙文章
harmony 鸿蒙Basic Services Kit（基础服务）
harmony 鸿蒙Print_PrintAttributes
0
赞
- 所属分类： 后端技术
- 本文标签：
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
8、 golang
-
9、 openharmony
-
10、 Vue中input框自动聚焦