harmony 鸿蒙oh_commonevent.h

2025-06-12
浏览 (4)

oh_commonevent.h

Overview

Defines the APIs for subscribing to and unsubscribing from common events.

Library: libohcommonevent.so

System capability: SystemCapability.Notification.CommonEvent

Since: 12

Related module: CommonEvent

Summary

Types

Name	Description
typedef struct CommonEvent_SubscribeInfo CommonEvent_SubscribeInfo	Defines a struct for the subscriber information.
typedef void CommonEvent_Subscriber	Defines a subscriber.
typedef struct CommonEvent_RcvData CommonEvent_RcvData	Defines a struct for the common event data.
typedef void CommonEvent_Parameters	Defines the additional information about a common event.
typedef void (CommonEvent_ReceiveCallback)(const CommonEvent_RcvData data)	Defines the callback function of a common event.
typedef struct CommonEvent_PublishInfo CommonEvent_PublishInfo	Defines a struct for an attribute object used for publishing a custom common event.

Enums

Name	Description
typedef enum CommonEvent_ErrCode { 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, COMMONEVENT_ERR_INIT_UNDONE = 1500008, COMMONEVENT_ERR_SUBSCRIBER_NUM_EXCEEDED = 1500010, COMMONEVENT_ERR_ALLOC_MEMORY_FAILED = 1500011 }	Enumerates the error codes.

Functions

Name	Description
CommonEvent_SubscribeInfo* OH_CommonEvent_CreateSubscribeInfo(const char* events[], int32_t eventsNum);	Creates the subscriber information.
CommonEvent_ErrCode OH_CommonEvent_SetPublisherPermission(CommonEvent_SubscribeInfo* info, const char* permission);	Sets the subscriber permission.
CommonEvent_ErrCode OH_CommonEvent_SetPublisherBundleName(CommonEvent_SubscribeInfo* info, const char* bundleName);	Sets a bundle name of the subscriber.
void OH_CommonEvent_DestroySubscribeInfo(CommonEvent_SubscribeInfo* info);	Destroys the subscriber information.
CommonEvent_Subscriber* OH_CommonEvent_CreateSubscriber(const CommonEvent_SubscribeInfo* info, CommonEvent_ReceiveCallback callback);	Creates a subscriber.
void OH_CommonEvent_DestroySubscriber(CommonEvent_Subscriber* subscriber);	Destroys a subscriber.
CommonEvent_ErrCode OH_CommonEvent_Subscribe(const CommonEvent_Subscriber* subscriber);	Subscribes to a common event.
CommonEvent_ErrCode OH_CommonEvent_UnSubscribe(const CommonEvent_Subscriber* subscriber);	Unsubscribes from a common event.
const char* OH_CommonEvent_GetEventFromRcvData(const CommonEvent_RcvData* rcvData);	Obtains the name of a common event.
int32_t OH_CommonEvent_GetCodeFromRcvData(const CommonEvent_RcvData* rcvData);	Obtains the result code of a common event.
const char* OH_CommonEvent_GetDataStrFromRcvData(const CommonEvent_RcvData* rcvData);	Obtains the custom result data of a common event.
const char* OH_CommonEvent_GetBundleNameFromRcvData(const CommonEvent_RcvData* rcvData);	Obtains the bundle name of a common event.
const CommonEvent_Parameters* OH_CommonEvent_GetParametersFromRcvData(const CommonEvent_RcvData* rcvData);	Obtains the additional information about a common event.
bool OH_CommonEvent_HasKeyInParameters(const CommonEvent_Parameters* para, const char* key);	Checks whether the additional information of a common event contains a key-value pair.
int OH_CommonEvent_GetIntFromParameters(const CommonEvent_Parameters* para, const char* key, const int defaultValue);	Obtains the int data from the additional information of a common event.
int32_t OH_CommonEvent_GetIntArrayFromParameters(const CommonEvent_Parameters* para, const char* key, int** array);	Obtains the int array from the additional information of a common event.
long OH_CommonEvent_GetLongFromParameters(const CommonEvent_Parameters* para, const char* key, const long defaultValue);	Obtains the long data from the additional information of a common event.
int32_t OH_CommonEvent_GetLongArrayFromParameters(const CommonEvent_Parameters* para, const char* key, long** array);	Obtains the long array from the additional information of a common event.
bool OH_CommonEvent_GetBoolFromParameters(const CommonEvent_Parameters* para, const char* key, const bool defaultValue);	Obtains the Boolean data from the additional information of a common event.
int32_t OH_CommonEvent_GetBoolArrayFromParameters(const CommonEvent_Parameters* para, const char* key, bool** array);	Obtains the Boolean array from the additional information of a common event.
char OH_CommonEvent_GetCharFromParameters(const CommonEvent_Parameters* para, const char* key, const char defaultValue);	Obtains the character data from the additional information of a common event.
int32_t OH_CommonEvent_GetCharArrayFromParameters(const CommonEvent_Parameters* para, const char* key, char** array);	Obtains the character array from the additional information of a common event.
double OH_CommonEvent_GetDoubleFromParameters(const CommonEvent_Parameters* para, const char* key, const double defaultValue);	Obtains the double data from the additional information of a common event.
int32_t OH_CommonEvent_GetDoubleArrayFromParameters(const CommonEvent_Parameters* para, const char* key, double** array);	Obtains the double array from the additional information of a common event.
CommonEvent_Parameters* OH_CommonEvent_CreateParameters();	Creates an additional information object of a common event.
void OH_CommonEvent_DestroyParameters(CommonEvent_Parameters* param);	Destroys an additional information object of a common event.
CommonEvent_ErrCode OH_CommonEvent_SetIntToParameters(CommonEvent_Parameters* param, const char* key, const int value);	Sets the additional information of a common event. The value is the content of the int type.
CommonEvent_ErrCode OH_CommonEvent_SetIntArrayToParameters(CommonEvent_Parameters* param, const char* key, const int* value, const size_t num);	Sets the additional information of a common event. The value is the content of the int array type.
CommonEvent_ErrCode OH_CommonEvent_SetLongToParameters(CommonEvent_Parameters* param, const char* key, const long value);	Sets the additional information of a common event. The value is the content of the long type.
CommonEvent_ErrCode OH_CommonEvent_SetLongArrayToParameters(CommonEvent_Parameters* param, const char* key, const long* value, const size_t num);	Sets the additional information of a common event. The value is the content of the long array type.
CommonEvent_ErrCode OH_CommonEvent_SetDoubleToParameters(CommonEvent_Parameters* param, const char* key, const double value);	Sets the additional information of a common event. The value is the content of the double type.
CommonEvent_ErrCode OH_CommonEvent_SetDoubleArrayToParameters(CommonEvent_Parameters* param, const char* key, const double* value, const size_t num);	Sets the additional information of a common event. The value is the content of the double array type.
CommonEvent_ErrCode OH_CommonEvent_SetBoolToParameters(CommonEvent_Parameters* param, const char* key, const bool value);	Sets the additional information of a common event. The value is the content of the Boolean type.
CommonEvent_ErrCode OH_CommonEvent_SetBoolArrayToParameters(CommonEvent_Parameters* param, const char* key, const bool* value, const size_t num);	Sets the additional information of a common event. The value is the content of the Boolean array type.
CommonEvent_ErrCode OH_CommonEvent_SetCharToParameters(CommonEvent_Parameters* param, const char* key, const char value);	Sets the additional information of a common event. The value is the content of the character type.
CommonEvent_ErrCode OH_CommonEvent_SetCharArrayToParameters(CommonEvent_Parameters* param, const char* key, const char* value, const size_t num);	Sets the additional information of a common event. The value is the content of the character array type.
CommonEvent_PublishInfo* OH_CommonEvent_CreatePublishInfo(const bool ordered);	Creates an attribute object of a common event.
void OH_CommonEvent_DestroyPublishInfo(CommonEvent_PublishInfo* info);	Destroys an attribute object of a common event.
CommonEvent_ErrCode OH_CommonEvent_SetPublishInfoBundleName(CommonEvent_PublishInfo* info, const char* bundleName);	Sets the bundle name of a common event.
CommonEvent_ErrCode OH_CommonEvent_SetPublishInfoPermissions(CommonEvent_PublishInfo* info, const char* permissions[], const int32_t num);	Sets the common event permissions.
CommonEvent_ErrCode OH_CommonEvent_SetPublishInfoCode(CommonEvent_PublishInfo* info, const int32_t code);	Sets the result code of a common event.
CommonEvent_ErrCode OH_CommonEvent_SetPublishInfoData(CommonEvent_PublishInfo* info, const char* data, const size_t length);	Sets the result data of a common event.
CommonEvent_ErrCode OH_CommonEvent_SetPublishInfoParameters(CommonEvent_PublishInfo* info, CommonEvent_Parameters* param);	Sets the additional information of a common event.
CommonEvent_ErrCode OH_CommonEvent_Publish(const char* event);	Publishes a custom common event.
CommonEvent_ErrCode OH_CommonEvent_PublishWithInfo(const char* event, const CommonEvent_PublishInfo* info);	Publishes a custom common event with specified attributes.
bool OH_CommonEvent_IsOrderedCommonEvent(const CommonEvent_Subscriber* subscriber);	Checks whether a common event is an ordered common event.
bool OH_CommonEvent_FinishCommonEvent(CommonEvent_Subscriber* subscriber);	Finishes an ordered common event.
bool OH_CommonEvent_GetAbortCommonEvent(const CommonEvent_Subscriber* subscriber);	Checks whether an ordered common event is aborted.
bool OH_CommonEvent_AbortCommonEvent(CommonEvent_Subscriber* subscriber);	Aborts an ordered common event.
bool OH_CommonEvent_ClearAbortCommonEvent(CommonEvent_Subscriber* subscriber);	Clears the aborted state of an ordered common event.
int32_t OH_CommonEvent_GetCodeFromSubscriber(const CommonEvent_Subscriber* subscriber);	Obtains the result code of an ordered common event.
int32_t OH_CommonEvent_GetDataFromSubscriber(const CommonEvent_Subscriber* subscriber);	Obtains the result data of an ordered common event.
int32_t OH_CommonEvent_SetCodeToSubscriber(CommonEvent_Subscriber* subscriber, const int32_t code);	Sets the result code of an ordered common event.
int32_t OH_CommonEvent_SetDataToSubscriber(CommonEvent_Subscriber* subscriber, const char* data, const size_t length);	Sets the result data of an ordered common event.