# hiappevent.h ## Overview Defines the application event logging functions of the HiAppEvent module. Before performing application event logging, you must construct a parameter list object to store the input event parameters and specify the event domain, event name, and event type.

Event domain: domain associated with the application event.

Event name: name of the application event.

Event type: fault, statistics, security, or behavior.

Parameter list: a linked list used to store event parameters. Each parameter consists of a parameter name and a parameter value. **File to include**: **Library**: libhiappevent_ndk.z.so **System capability**: SystemCapability.HiviewDFX.HiAppEvent **Since**: 8 **Related Module**: [HiAppEvent](capi-hiappevent.md) ## Summary ### Structs | Name| typedef Keyword| Description| | -- | -- | -- | | [HiAppEvent_AppEventInfo](capi-hiappevent-hiappevent-appeventinfo.md) | HiAppEvent_AppEventInfo | Defines the information about a single event, including the event domain, event name, event type, and custom parameter list in JSON string format.| | [HiAppEvent_AppEventGroup](capi-hiappevent-hiappevent-appeventgroup.md) | HiAppEvent_AppEventGroup | Defines the information about an event group, including its name, the array of event information grouped by name, and the length of the event array.| | [ParamListNode*](capi-hiappevent-paramlistnode8h.md) | ParamList | Defines a struct for the event parameter list node.| | [HiAppEvent_Watcher](capi-hiappevent-hiappevent-watcher.md) | HiAppEvent_Watcher | Defines a struct for the watcher for application events.| | [HiAppEvent_Processor](capi-hiappevent-hiappevent-processor.md) | HiAppEvent_Processor | Defines a struct for the processor for application events.| | [HiAppEvent_Config](capi-hiappevent-hiappevent-config.md) | HiAppEvent_Config | Defines a struct for the configuration object used to set the conditions for triggering system events.| ### Enums | Name| typedef Keyword| Description| | -- | -- | -- | | [HiAppEvent_ErrorCode](#hiappevent_errorcode) | HiAppEvent_ErrorCode | Enumerates the error codes used in the HiAppEvent module.| | [EventType](#eventtype) | - | Enumerates the event types. You are advised to select different event types based on application scenarios.| ### Functions | Name| typedef Keyword| Description| | -- | -- | -- | | [typedef void (\*OH_HiAppEvent_OnReceive)(const char* domain, const struct HiAppEvent_AppEventGroup* appEventGroups, uint32_t groupLen)](#oh_hiappevent_onreceive) | OH_HiAppEvent_OnReceive | Invoked to pass event content to the caller. **Note**: The lifecycle of the object pointed by the pointer in the callback is limited to the callback function. Do not use the pointer outside of the callback function. If the information needs to be cached, perform a deep copy of the content pointed by the pointer.| | [typedef void (\*OH_HiAppEvent_OnTrigger)(int row, int size)](#oh_hiappevent_ontrigger) | OH_HiAppEvent_OnTrigger | Invoked if the event received by the watcher meets the conditions specified by **OH_HiAppEvent_SetTriggerCondition**. When the **OH_HiAppEvent_OnReceive** callback is not set in the watcher, the event received by the watcher will be saved.
After the callback is complete, if a newly saved event meets the specified condition, the callback is invoked again.| | [typedef void (\*OH_HiAppEvent_OnTake)(const char* const *events, uint32_t eventLen)](#oh_hiappevent_ontake) | OH_HiAppEvent_OnTake | Invoked to pass the events received by the watcher to the caller when **OH_HiAppEvent_TakeWatcherData** is used to obtain the events. Note: The lifecycle of the object pointed by the pointer in the callback is limited to the callback function. Do not use the pointer outside of the callback function. If the information needs to be cached, perform a deep copy of the content pointed by the pointer.| | [ParamList OH_HiAppEvent_CreateParamList(void)](#oh_hiappevent_createparamlist) | - | Creates a pointer to a parameter list object.| | [void OH_HiAppEvent_DestroyParamList(ParamList list)](#oh_hiappevent_destroyparamlist) | - | Destroys a pointer to a parameter list object and releases its allocated memory.| | [ParamList OH_HiAppEvent_AddBoolParam(ParamList list, const char* name, bool boolean)](#oh_hiappevent_addboolparam) | - | Adds an event parameter of the Boolean type to the parameter list.| | [ParamList OH_HiAppEvent_AddBoolArrayParam(ParamList list, const char* name, const bool* booleans, int arrSize)](#oh_hiappevent_addboolarrayparam) | - | Adds an event parameter of the Boolean array type to the parameter list.| | [ParamList OH_HiAppEvent_AddInt8Param(ParamList list, const char* name, int8_t num)](#oh_hiappevent_addint8param) | - | Adds an event parameter of the int8_t type to the parameter list.| | [ParamList OH_HiAppEvent_AddInt8ArrayParam(ParamList list, const char* name, const int8_t* nums, int arrSize)](#oh_hiappevent_addint8arrayparam) | - | Adds an event parameter of the int8_t array type to the parameter list.| | [ParamList OH_HiAppEvent_AddInt16Param(ParamList list, const char* name, int16_t num)](#oh_hiappevent_addint16param) | - | Adds an event parameter of the int16_t type to the parameter list.| | [ParamList OH_HiAppEvent_AddInt16ArrayParam(ParamList list, const char* name, const int16_t* nums, int arrSize)](#oh_hiappevent_addint16arrayparam) | - | Adds an event parameter of the int16_t array type to the parameter list.| | [ParamList OH_HiAppEvent_AddInt32Param(ParamList list, const char* name, int32_t num)](#oh_hiappevent_addint32param) | - | Adds an event parameter of the int32_t type to the parameter list.| | [ParamList OH_HiAppEvent_AddInt32ArrayParam(ParamList list, const char* name, const int32_t* nums, int arrSize)](#oh_hiappevent_addint32arrayparam) | - | Adds an event parameter of the int32_t array type to the parameter list.| | [ParamList OH_HiAppEvent_AddInt64Param(ParamList list, const char* name, int64_t num)](#oh_hiappevent_addint64param) | - | Adds an event parameter of the int64_t type to the parameter list.| | [ParamList OH_HiAppEvent_AddInt64ArrayParam(ParamList list, const char* name, const int64_t* nums, int arrSize)](#oh_hiappevent_addint64arrayparam) | - | Adds an event parameter of the int64_t array type to the parameter list.| | [ParamList OH_HiAppEvent_AddFloatParam(ParamList list, const char* name, float num)](#oh_hiappevent_addfloatparam) | - | Adds an event parameter of the float type to the parameter list.| | [ParamList OH_HiAppEvent_AddFloatArrayParam(ParamList list, const char* name, const float* nums, int arrSize)](#oh_hiappevent_addfloatarrayparam) | - | Adds an event parameter of the float array type to the parameter list.| | [ParamList OH_HiAppEvent_AddDoubleParam(ParamList list, const char* name, double num)](#oh_hiappevent_adddoubleparam) | - | Adds an event parameter of the Double type to the parameter list.| | [ParamList OH_HiAppEvent_AddDoubleArrayParam(ParamList list, const char* name, const double* nums, int arrSize)](#oh_hiappevent_adddoublearrayparam) | - | Adds an event parameter of the double array type to the parameter list.| | [ParamList OH_HiAppEvent_AddStringParam(ParamList list, const char* name, const char* str)](#oh_hiappevent_addstringparam) | - | Adds a parameter of the string type to the parameter list.| | [ParamList OH_HiAppEvent_AddStringArrayParam(ParamList list, const char* name, const char * const *strs, int arrSize)](#oh_hiappevent_addstringarrayparam) | - | Adds a parameter of the string array type to the parameter list.| | [int OH_HiAppEvent_Write(const char* domain, const char* name, enum EventType type, const ParamList list)](#oh_hiappevent_write) | - | Logs application events whose parameters are of the list type. Before application event logging, use this API to verify parameters of the events. If the verification is successful, the API writes the events to the event file.| | [bool OH_HiAppEvent_Configure(const char* name, const char* value)](#oh_hiappevent_configure) | - | Configures the application event logging function. This function is used to configure the event logging function and the storage quota of the event file directory.| | [HiAppEvent_Watcher* OH_HiAppEvent_CreateWatcher(const char* name)](#oh_hiappevent_createwatcher) | - | Creates a watcher for application events. Note: If a created watcher is no longer used, you are required to destroy it by calling OH_HiAppEvent_DestroyWatcher.| | [void OH_HiAppEvent_DestroyWatcher(HiAppEvent_Watcher* watcher)](#oh_hiappevent_destroywatcher) | - | Destroys a created watcher. Note: If a created watcher is no longer used, destroy it to release memory to prevent memory leaks. After the watcher is destroyed, set its pointer to null.| | [int OH_HiAppEvent_SetTriggerCondition(HiAppEvent_Watcher* watcher, int row, int size, int timeOut)](#oh_hiappevent_settriggercondition) | - | Sets the trigger condition of the **OH_HiAppEvent_OnTrigger** callback.
You can set the trigger condition by the number and size of new events received by the watcher, and **onTrigger** timeout interval. Ensure that at least one of the trigger conditions is set on the caller side.| | [int OH_HiAppEvent_SetAppEventFilter(HiAppEvent_Watcher* watcher, const char* domain, uint8_t eventTypes,const char* const *names, int namesLen)](#oh_hiappevent_setappeventfilter) | - | Sets the type of events to listen for. This function can be called repeatedly. You can add multiple filtering conditions instead of replacing them. The watcher will receive notifications of events that meet any of the filtering conditions.| | [int OH_HiAppEvent_SetWatcherOnTrigger(HiAppEvent_Watcher* watcher, OH_HiAppEvent_OnTrigger onTrigger)](#oh_hiappevent_setwatcherontrigger) | - | Sets the **onTrigger** callback.
If **OnReceive** is not set or is set to **nullptr**, the application events received by the watcher will be saved. If the saved application events meet the trigger conditions of the **onTrigger** callback, the **onTrigger** callback will be called.| | [int OH_HiAppEvent_SetWatcherOnReceive(HiAppEvent_Watcher* watcher, OH_HiAppEvent_OnReceive onReceive)](#oh_hiappevent_setwatcheronreceive) | - | Sets the **onReceive** callback. When the listener detects the corresponding event, the onReceive callback is called.| | [int OH_HiAppEvent_TakeWatcherData(HiAppEvent_Watcher* watcher, uint32_t eventNum, OH_HiAppEvent_OnTake onTake)](#oh_hiappevent_takewatcherdata) | - | Obtains the event saved by the watcher.| | [int OH_HiAppEvent_AddWatcher(HiAppEvent_Watcher* watcher)](#oh_hiappevent_addwatcher) | - | Adds a watcher. Once a watcher is added, it starts to listen for system messages.| | [int OH_HiAppEvent_RemoveWatcher(HiAppEvent_Watcher* watcher)](#oh_hiappevent_removewatcher) | - | Removes a watcher. Once a watcher is removed, it stops listening for system messages. Note: This API only enables the watcher to stop listening for system messages. It does not destroy the watcher. The watcher still resides in the memory until the OH_HiAppEvent_DestroyWatcher API is called.| | [void OH_HiAppEvent_ClearData()](#oh_hiappevent_cleardata) | - | Clears the events saved by all watchers.| | [HiAppEvent_Processor* OH_HiAppEvent_CreateProcessor(const char* name)](#oh_hiappevent_createprocessor) | - | Creates a processor for application events. Note: If a processor is no longer used, call **OH_HiAppEvent_DestroyProcessor** to destroy it.| | [int OH_HiAppEvent_SetReportRoute(HiAppEvent_Processor* processor, const char* appId, const char* routeInfo)](#oh_hiappevent_setreportroute) | - | Sets the report route for the processor.| | [int OH_HiAppEvent_SetReportPolicy(HiAppEvent_Processor* processor, int periodReport, int batchReport,bool onStartReport, bool onBackgroundReport)](#oh_hiappevent_setreportpolicy) | - | Sets the report policy for the processor.| | [int OH_HiAppEvent_SetReportEvent(HiAppEvent_Processor* processor, const char* domain, const char* name,bool isRealTime)](#oh_hiappevent_setreportevent) | - | Sets the report event for the processor.| | [int OH_HiAppEvent_SetCustomConfig(HiAppEvent_Processor* processor, const char* key, const char* value)](#oh_hiappevent_setcustomconfig) | - | Sets the custom extension parameters of the processor.| | [int OH_HiAppEvent_SetConfigId(HiAppEvent_Processor* processor, int configId)](#oh_hiappevent_setconfigid) | - | Sets the configuration ID of the processor.| | [int OH_HiAppEvent_SetConfigName(HiAppEvent_Processor* processor, const char* configName)](#oh_hiappevent_setconfigname) | - | Sets the configuration name of the processor.| | [int OH_HiAppEvent_SetReportUserId(HiAppEvent_Processor* processor, const char* const * userIdNames, int size)](#oh_hiappevent_setreportuserid) | - | Sets the report user ID of the processor.| | [int OH_HiAppEvent_SetReportUserProperty(HiAppEvent_Processor* processor, const char* const * userPropertyNames,int size)](#oh_hiappevent_setreportuserproperty) | - | Sets the report user property of the processor.| | [int64_t OH_HiAppEvent_AddProcessor(HiAppEvent_Processor* processor)](#oh_hiappevent_addprocessor) | - | Adds a processor. You can add a processor to migrate event data to the cloud. You can preset the implementation of the processor on the device and set its properties based on its constraints. Note that the configuration information of **Processor** must be provided by the data processor. Yet, as no data processor is preset in the device for interaction for the moment, migrating events to the cloud is unavailable.| | [void OH_HiAppEvent_DestroyProcessor(HiAppEvent_Processor* processor)](#oh_hiappevent_destroyprocessor) | - | Destroys a processor. Note: If a processor is no longer used, destroy it to release memory to prevent memory leaks. After the processor is destroyed, set its pointer to null.| | [int OH_HiAppEvent_RemoveProcessor(int64_t processorId)](#oh_hiappevent_removeprocessor) | - | Removes a processor. Once a processor is removed, it stops reporting events. Note: This API only stops the processor reporting events but does not destroy the processor. You can call **OH_HiAppEvent_DestroyProcessor** to destroy the processor and release the memory.| | [HiAppEvent_Config* OH_HiAppEvent_CreateConfig(void)](#oh_hiappevent_createconfig) | - | Creates a pointer to the configuration object that sets the conditions for triggering system events.| | [void OH_HiAppEvent_DestroyConfig(HiAppEvent_Config* config)](#oh_hiappevent_destroyconfig) | - | Destroys a configuration object. Note: If a configuration object is no longer used, destroy it to release memory to prevent memory leaks. After the object is destroyed, set its pointer to null.| | [int OH_HiAppEvent_SetConfigItem(HiAppEvent_Config* config, const char* itemName, const char* itemValue)](#oh_hiappevent_setconfigitem) | - | Sets the items in the configuration object.| | [int OH_HiAppEvent_SetEventConfig(const char* name, HiAppEvent_Config* config)](#oh_hiappevent_seteventconfig) | - | Sets the conditions for triggering system event subscription.| ## Enum Description ### HiAppEvent_ErrorCode ``` enum HiAppEvent_ErrorCode ``` **Description** Enumerates the error codes used in the HiAppEvent module. **Since**: 15 | Enum Item| Description | | -- |-------------------------| | HIAPPEVENT_SUCCESS = 0 | The operation is successful. | | HIAPPEVENT_INVALID_PARAM_VALUE_LENGTH = 4 | The parameter value length is invalid.
**Since**: 18| | HIAPPEVENT_PROCESSOR_IS_NULL = -7 | The processor is null.
**Since**: 18 | | HIAPPEVENT_PROCESSOR_NOT_FOUND = -8 | The processor is not found.
**Since**: 18 | | HIAPPEVENT_INVALID_PARAM_VALUE = -9 | The parameter value is invalid. | | HIAPPEVENT_EVENT_CONFIG_IS_NULL = -10 | The event configuration is null. | | HIAPPEVENT_OPERATE_FAILED = -100 | The operation failed.
**Since**: 18 | | HIAPPEVENT_INVALID_UID = -200 | The user ID is invalid.
**Since**: 18 | ### EventType ``` enum EventType ``` **Description** Enumerates the event types. You are advised to select different event types based on application scenarios. **Since**: 8 | Enum Item| Description| | -- | -- | | FAULT = 1 | Fault event.| | STATISTIC = 2 | Statistics event.| | SECURITY = 3 | Security event.| | BEHAVIOR = 4 | Behavior event.| ## Function Description ### OH_HiAppEvent_OnReceive() ``` typedef void (*OH_HiAppEvent_OnReceive)(const char* domain, const struct HiAppEvent_AppEventGroup* appEventGroups, uint32_t groupLen) ``` **Description** Defines a callback invoked to pass event content to the caller. Note: The lifecycle of the object pointed by the pointer in the callback is limited to the callback function. Do not use the pointer outside of the callback function. If the information needs to be cached, perform a deep copy of the content pointed by the pointer. **Since**: 12 **Parameters** | Name| Description| | -- | -- | | const char* domain | Domain of the received application event.| | [ const struct HiAppEvent_AppEventGroup](capi-hiappevent-hiappevent-appeventgroup.md)* appEventGroups | Event group array.| | uint32_t groupLen | Length of the event group array.| ### OH_HiAppEvent_OnTrigger() ``` typedef void (*OH_HiAppEvent_OnTrigger)(int row, int size) ``` **Description** Defines a callback invoked if the event received by the watcher meets the conditions specified by **OH_HiAppEvent_SetTriggerCondition**. When the **OH_HiAppEvent_OnReceive** callback is not set in the watcher, the event received by the watcher will be saved.
After the callback is complete, if a newly saved event meets the specified condition, the callback is invoked again. **Since**: 12 **Parameters** | Name| Description| | -- | -- | | int row | Number of events newly received by the watcher.| | int size | Total size of events newly received by the watcher. The size of a single event is the length of the JSON string converted from the event.| ### OH_HiAppEvent_OnTake() ``` typedef void (*OH_HiAppEvent_OnTake)(const char* const *events, uint32_t eventLen) ``` **Description** Invoked to pass the events received by the watcher to the caller when **OH_HiAppEvent_TakeWatcherData** is used to obtain the events. Note: The lifecycle of the object pointed by the pointer in the callback is limited to the callback function. Do not use the pointer outside of the callback function. If the information needs to be cached, perform a deep copy of the content pointed by the pointer. **Since**: 12 **Parameters** | Name| Description| | -- | -- | | const char* const *events | Event array in JSON string format.| | uint32_t eventLen | Size of the event array.| ### OH_HiAppEvent_CreateParamList() ``` ParamList OH_HiAppEvent_CreateParamList(void) ``` **Description** Creates a pointer to a parameter list object. **Since**: 8 **Returns** | Type| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) | Pointer to the parameter list object.| ### OH_HiAppEvent_DestroyParamList() ``` void OH_HiAppEvent_DestroyParamList(ParamList list) ``` **Description** Destroys a pointer to a parameter list object and releases its allocated memory. **Since**: 8 **Parameters** | Name| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) list | Pointer to the parameter list object.| ### OH_HiAppEvent_AddBoolParam() ``` ParamList OH_HiAppEvent_AddBoolParam(ParamList list, const char* name, bool boolean) ``` **Description** Adds an event parameter of the Boolean type to the parameter list. **Since**: 8 **Parameters** | Name| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) list | Pointer to the parameter list to which parameters need to be added.| | const char* name | Name of the parameter to be added.| | bool boolean | Value of the parameter to be added.| **Returns** | Type| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) | Pointer to the parameter list that contains the parameters added.| ### OH_HiAppEvent_AddBoolArrayParam() ``` ParamList OH_HiAppEvent_AddBoolArrayParam(ParamList list, const char* name, const bool* booleans, int arrSize) ``` **Description** Adds an event parameter of the Boolean array type to the parameter list. **Since**: 8 **Parameters** | Name| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) list | Pointer to the parameter list to which parameters need to be added.| | const char* name | Name of the parameter to be added.| | const bool* booleans | Value of the parameter to be added.| | int arrSize | Size of the parameter array to be added.| **Returns** | Type| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) | Pointer to the parameter list that contains the parameters added.| ### OH_HiAppEvent_AddInt8Param() ``` ParamList OH_HiAppEvent_AddInt8Param(ParamList list, const char* name, int8_t num) ``` **Description** Adds an event parameter of the int8_t type to the parameter list. **Since**: 8 **Parameters** | Name| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) list | Pointer to the parameter list to which parameters need to be added.| | const char* name | Name of the parameter to be added.| | int8_t num | Value of the parameter to be added.| **Returns** | Type| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) | Pointer to the parameter list that contains the parameters added.| ### OH_HiAppEvent_AddInt8ArrayParam() ``` ParamList OH_HiAppEvent_AddInt8ArrayParam(ParamList list, const char* name, const int8_t* nums, int arrSize) ``` **Description** Adds an event parameter of the int8_t array type to the parameter list. **Since**: 8 **Parameters** | Name| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) list | Pointer to the parameter list to which parameters need to be added.| | const char* name | Name of the parameter to be added.| | const int8_t* nums | Value of the parameter to be added.| | int arrSize | Size of the parameter array to be added.| **Returns** | Type| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) | Pointer to the parameter list that contains the parameters added.| ### OH_HiAppEvent_AddInt16Param() ``` ParamList OH_HiAppEvent_AddInt16Param(ParamList list, const char* name, int16_t num) ``` **Description** Adds an event parameter of the int16_t type to the parameter list. **Since**: 8 **Parameters** | Name| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) list | Pointer to the parameter list to which parameters need to be added.| | const char* name | Name of the parameter to be added.| | int16_t num | Value of the parameter to be added.| **Returns** | Type| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) | Pointer to the parameter list that contains the parameters added.| ### OH_HiAppEvent_AddInt16ArrayParam() ``` ParamList OH_HiAppEvent_AddInt16ArrayParam(ParamList list, const char* name, const int16_t* nums, int arrSize) ``` **Description** Adds an event parameter of the int16_t array type to the parameter list. **Since**: 8 **Parameters** | Name| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) list | Pointer to the parameter list to which parameters need to be added.| | const char* name | Name of the parameter to be added.| | const int16_t* nums | Value of the parameter to be added.| | int arrSize | Size of the parameter array to be added.| **Returns** | Type| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) | Pointer to the parameter list that contains the parameters added.| ### OH_HiAppEvent_AddInt32Param() ``` ParamList OH_HiAppEvent_AddInt32Param(ParamList list, const char* name, int32_t num) ``` **Description** Adds an event parameter of the int32_t type to the parameter list. **Since**: 8 **Parameters** | Name| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) list | Pointer to the parameter list to which parameters need to be added.| | const char* name | Name of the parameter to be added.| | int32_t num | Value of the parameter to be added.| **Returns** | Type| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) | Pointer to the parameter list that contains the parameters added.| ### OH_HiAppEvent_AddInt32ArrayParam() ``` ParamList OH_HiAppEvent_AddInt32ArrayParam(ParamList list, const char* name, const int32_t* nums, int arrSize) ``` **Description** Adds an event parameter of the int32_t array type to the parameter list. **Since**: 8 **Parameters** | Name| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) list | Pointer to the parameter list to which parameters need to be added.| | const char* name | Name of the parameter to be added.| | const int32_t* nums | Value of the parameter to be added.| | int arrSize | Size of the parameter array to be added.| **Returns** | Type| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) | Pointer to the parameter list that contains the parameters added.| ### OH_HiAppEvent_AddInt64Param() ``` ParamList OH_HiAppEvent_AddInt64Param(ParamList list, const char* name, int64_t num) ``` **Description** Adds an event parameter of the int64_t type to the parameter list. **Since**: 8 **Parameters** | Name| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) list | Pointer to the parameter list to which parameters need to be added.| | const char* name | Name of the parameter to be added.| | int64_t num | Value of the parameter to be added.| **Returns** | Type| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) | Pointer to the parameter list that contains the parameters added.| ### OH_HiAppEvent_AddInt64ArrayParam() ``` ParamList OH_HiAppEvent_AddInt64ArrayParam(ParamList list, const char* name, const int64_t* nums, int arrSize) ``` **Description** Adds an event parameter of the int64_t array type to the parameter list. **Since**: 8 **Parameters** | Name| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) list | Pointer to the parameter list to which parameters need to be added.| | const char* name | Name of the parameter to be added.| | const int64_t* nums | Value of the parameter to be added.| | int arrSize | Size of the parameter array to be added.| **Returns** | Type| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) | Pointer to the parameter list that contains the parameters added.| ### OH_HiAppEvent_AddFloatParam() ``` ParamList OH_HiAppEvent_AddFloatParam(ParamList list, const char* name, float num) ``` **Description** Adds an event parameter of the float type to the parameter list. **Since**: 8 **Parameters** | Name| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) list | Pointer to the parameter list to which parameters need to be added.| | const char* name | Name of the parameter to be added.| | float num | Value of the parameter to be added.| **Returns** | Type| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) | Pointer to the parameter list that contains the parameters added.| ### OH_HiAppEvent_AddFloatArrayParam() ``` ParamList OH_HiAppEvent_AddFloatArrayParam(ParamList list, const char* name, const float* nums, int arrSize) ``` **Description** Adds an event parameter of the float array type to the parameter list. **Since**: 8 **Parameters** | Name| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) list | Pointer to the parameter list to which parameters need to be added.| | const char* name | Name of the parameter to be added.| | const float* nums | Value of the parameter to be added.| | int arrSize | Size of the parameter array to be added.| **Returns** | Type| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) | Pointer to the parameter list that contains the parameters added.| ### OH_HiAppEvent_AddDoubleParam() ``` ParamList OH_HiAppEvent_AddDoubleParam(ParamList list, const char* name, double num) ``` **Description** Adds an event parameter of the Double type to the parameter list. **Since**: 8 **Parameters** | Name| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) list | Pointer to the parameter list to which parameters need to be added.| | const char* name | Name of the parameter to be added.| | double num | Value of the parameter to be added.| **Returns** | Type| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) | Pointer to the parameter list that contains the parameters added.| ### OH_HiAppEvent_AddDoubleArrayParam() ``` ParamList OH_HiAppEvent_AddDoubleArrayParam(ParamList list, const char* name, const double* nums, int arrSize) ``` **Description** Adds an event parameter of the double array type to the parameter list. **Since**: 8 **Parameters** | Name| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) list | Pointer to the parameter list to which parameters need to be added.| | const char* name | Name of the parameter to be added.| | const double* nums | Value of the parameter to be added.| | int arrSize | Size of the parameter array to be added.| **Returns** | Type| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) | Pointer to the parameter list that contains the parameters added.| ### OH_HiAppEvent_AddStringParam() ``` ParamList OH_HiAppEvent_AddStringParam(ParamList list, const char* name, const char* str) ``` **Description** Adds a parameter of the string type to the parameter list. **Since**: 8 **Parameters** | Name| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) list | Pointer to the parameter list to which parameters need to be added.| | const char* name | Name of the parameter to be added.| | const char* str | Value of the parameter to be added.| **Returns** | Type| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) | Pointer to the parameter list that contains the parameters added.| ### OH_HiAppEvent_AddStringArrayParam() ``` ParamList OH_HiAppEvent_AddStringArrayParam(ParamList list, const char* name, const char * const *strs, int arrSize) ``` **Description** Adds a parameter of the string array type to the parameter list. **Since**: 8 **Parameters** | Name| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) list | Pointer to the parameter list to which parameters need to be added.| | const char* name | Name of the parameter to be added.| | const char * const *strs | Value of the parameter to be added.| | int arrSize | Size of the parameter array to be added.| **Returns** | Type| Description| | -- | -- | | [ParamList](capi-hiappevent-paramlistnode8h.md) | Pointer to the parameter list that contains the parameters added.| ### OH_HiAppEvent_Write() ``` int OH_HiAppEvent_Write(const char* domain, const char* name, enum EventType type, const ParamList list) ``` **Description** Logs application events whose parameters are of the list type. Before application event logging, use this API to verify parameters of the events. If the verification is successful, the API writes the events to the event file. **Since**: 8 **Parameters** | Name| Description| | -- | -- | | const char* domain | Event domain. You can customize event domains as required.
The value is a string that contains a maximum of 32 characters, including digits (0 to 9), letters (a to z), and underscore (\_). It must start with a letter and cannot end with an underscore (\_).| | const char* name | Event name. You can customize event names as required.
The value is a string that contains a maximum of 48 characters, including digits (0 to 9), letters (a to z), underscore (\_), and dollar sign (`$`). It must start with a letter or dollar sign (`$`) and end with a digit or letter.| | enum [EventType](capi-hiappevent-h.md#eventtype) type | Event type. For details, see [EventType](capi-hiappevent-h.md#eventtype).| | [const ParamList](capi-hiappevent-paramlistnode8h.md) list | List of event parameters, each of which consists of a parameter name and a parameter value. The specifications are as follows:
1.
The value is a string that contains a maximum of 32 characters, including digits (0 to 9), letters (a to z), underscore (_), and dollar sign (`$`). It must start with a letter or dollar sign (`$`) and end with a digit or letter.
2. The parameter value can be a string, number, Boolean, or array. The length of a string must be less than 8 × 1024 characters. If this limit is exceeded, excess characters will be truncated.
The element type of an array parameter can only be a string, number, or Boolean, and the number of elements must be less than 100. If this limit is exceeded, excess elements will be discarded.
3. The maximum number of parameters is 32. If this limit is exceeded, excess parameters will be discarded.| **Returns** | Type| Description| | -- | -- | | int | If the event parameters are successfully verified, **0** is returned and the event is written into the event file.
If an event contains invalid parameters, a positive value is returned. The event is written into the event file after the invalid parameters are discarded.
If the event parameter fails to be verified, a negative value is returned and the event is not written to the event file.
**0**: Parameter verification successful.
**-1**: Invalid event name.
**-4**: Invalid event domain name.
**-99**: Application event logging disabled.
**1**: Invalid event parameter name.
**4**: Invalid event parameter string length.
**5**: Invalid number of event parameters.
**6**: Invalid event parameter array length.
**8**: Duplicate event parameter name.| ### OH_HiAppEvent_Configure() ``` bool OH_HiAppEvent_Configure(const char* name, const char* value) ``` **Description** Configures the application event logging function. This function is used to configure the event logging function and the storage quota of the event file directory. **Since**: 8 **Parameters** | Name| Description| | -- | -- | | const char* name | Configuration item name The value can be [DISABLE](capi-hiappevent-cfg-h.md#disable) or [MAX_STORAGE](capi-hiappevent-cfg-h.md#max_storage).| | const char* value | Configuration item value. If the configuration item name is [DISABLE](capi-hiappevent-cfg-h.md#disable), the value can be **true** or **false**.
If the configuration item name is [MAX_STORAGE](capi-hiappevent-cfg-h.md#max_storage), the quota value can contain only digits and the unit character. The unit character can be **b**\|**k**\|**kb**\|**m**\|**mb**\|**g**\|**gb**\|**t**\|**tb**, which is case insensitive.
The quota value must start with a digit. You can determine whether to pass the unit. If the unit is left empty, **b** (that is, byte) is used by default.| **Returns** | Type| Description| | -- | -- | | bool | Configuration result. The value **true** indicates that the configuration is successful, and the value **false** indicates the opposite.| ### OH_HiAppEvent_CreateWatcher() ``` HiAppEvent_Watcher* OH_HiAppEvent_CreateWatcher(const char* name) ``` **Description** Creates a watcher for application events. Note: If a created watcher is no longer used, you are required to destroy it by calling OH_HiAppEvent_DestroyWatcher. **Since**: 12 **Parameters** | Name| Description| | -- | -- | | const char* name | Watcher name.| **Returns** | Type | Description| |-------------------------| -- | | [HiAppEvent_Watcher](capi-hiappevent-hiappevent-watcher.md)* | Pointer to the new watcher if the API is called successfully; **nullptr** if the **name** parameter is invalid.| ### OH_HiAppEvent_DestroyWatcher() ``` void OH_HiAppEvent_DestroyWatcher(HiAppEvent_Watcher* watcher) ``` **Description** Destroys a created watcher. Note: If a created watcher is no longer used, destroy it to release memory to prevent memory leaks. After the watcher is destroyed, set its pointer to null. **Since**: 12 **Parameters** | Name| Description| | -- | -- | | [HiAppEvent_Watcher](capi-hiappevent-hiappevent-watcher.md)* watcher | Pointer to the watcher (that is, the pointer returned by OH_HiAppEvent_CreateWatcher).| ### OH_HiAppEvent_SetTriggerCondition() ``` int OH_HiAppEvent_SetTriggerCondition(HiAppEvent_Watcher* watcher, int row, int size, int timeOut) ``` **Description** Sets the trigger condition of the **OH_HiAppEvent_OnTrigger** callback.
You can set the trigger condition by the number and size of new events received by the watcher, and **onTrigger** timeout interval. Ensure that at least one of the trigger conditions is set on the caller side. **Since**: 12 **Parameters** | Name| Description| | -- | -- | | [HiAppEvent_Watcher](capi-hiappevent-hiappevent-watcher.md)* watcher | Pointer to the watcher (that is, the pointer returned by OH_HiAppEvent_CreateWatcher).| | int row | Row count. If the input value is greater than 0 and the number of newly received events is greater than or equal to the value of this parameter, the configured **onTrigger** callback is called.
If the input value is less than or equal to 0, the number of received events is not used as the condition to trigger the **onTrigger** callback.| | int size | Size value. If the input value is greater than 0 and the size of the newly received event is greater than or equal to the value of this parameter, the configured **onTrigger** callback is called. The size of a single event is the length of the JSON string converted from the event.
If the input value is less than or equal to 0, the size of received events is not used as the condition to trigger the **onTrigger** callback.| | int timeOut | Timeout value, in seconds. If the input value is greater than 0, the system checks the watcher for newly received events based on the timeout interval. If there are any newly received events, the configured onTrigger callback is triggered.
After the callback is complete, the system checks the watcher for newly received events when the timeout value expires.
If the input value is less than or equal to 0, the timeout interval is not used as the condition to trigger the onTrigger callback.| **Returns** | Type| Description| | -- | -- | | int | **0** if the API is called successfully; **-5** if the pointer to an input parameter is null.| ### OH_HiAppEvent_SetAppEventFilter() ``` int OH_HiAppEvent_SetAppEventFilter(HiAppEvent_Watcher* watcher, const char* domain, uint8_t eventTypes,const char* const *names, int namesLen) ``` **Description** Sets the type of events to listen for. This function can be called repeatedly. You can add multiple filtering conditions instead of replacing them. The watcher will receive notifications of events that meet any of the filtering conditions. **Since**: 12 **Parameters** | Name| Description| | -- | -- | | [HiAppEvent_Watcher](capi-hiappevent-hiappevent-watcher.md)* watcher | Pointer to the watcher (that is, the pointer returned by OH_HiAppEvent_CreateWatcher).| | const char* domain | Domain of events to be listened for.| | uint8_t eventTypes | Types of events to be listened for. The bitwise AND matching mode is used. Multiple types of events can be listened for. If the first bit is **1** (the value is **1**), fault events can be listened for.
If the second bit is **1** (the value is **2**), statistics events can be listened for.
If the third bit is **1** (the value is **4**), security events can be listened for.
If the fourth digit is **1** (the value is **8**), events of the listening behavior type can be listened for.
If four digits are **1** (the value is **15**) or 0 (the value is **0**), events of all types can be listened for.| | const char* const *names | Array of the event names.| | int namesLen | Length of the event name array.| **Returns** | Type| Description| | -- | -- | | int | **0** if the API is called successfully; **-1** if the **names** parameter is invalid; **-4** if the **domain** parameter is invalid; **-5** if the pointer to an input parameter is null.| ### OH_HiAppEvent_SetWatcherOnTrigger() ``` int OH_HiAppEvent_SetWatcherOnTrigger(HiAppEvent_Watcher* watcher, OH_HiAppEvent_OnTrigger onTrigger) ``` **Description** Sets the **onTrigger** callback.
If **OnReceive** is not set or is set to **nullptr**, the application events received by the watcher will be saved. If the saved application events meet the trigger conditions of the **onTrigger** callback, the **onTrigger** callback will be called. **Since**: 12 **Parameters** | Name| Description| | -- | -- | | [HiAppEvent_Watcher](capi-hiappevent-hiappevent-watcher.md)* watcher | Pointer to the watcher (that is, the pointer returned by OH_HiAppEvent_CreateWatcher).| | [OH_HiAppEvent_OnTrigger](capi-hiappevent-h.md#oh_hiappevent_ontrigger) onTrigger | Callback to be set.| **Returns** | Type| Description| | -- | -- | | int | **0** if the API is called successfully; **-5** if the pointer to an input parameter is null.| ### OH_HiAppEvent_SetWatcherOnReceive() ``` int OH_HiAppEvent_SetWatcherOnReceive(HiAppEvent_Watcher* watcher, OH_HiAppEvent_OnReceive onReceive) ``` **Description** Sets the **onReceive** callback. When the listener detects the corresponding event, the onReceive callback is called. **Since**: 12 **Parameters** | Name| Description| | -- | -- | | [HiAppEvent_Watcher](capi-hiappevent-hiappevent-watcher.md)* watcher | Pointer to the watcher (that is, the pointer returned by OH_HiAppEvent_CreateWatcher).| | [OH_HiAppEvent_OnReceive](capi-hiappevent-h.md#oh_hiappevent_onreceive) onReceive | Pointer to the callback function.| **Returns** | Type| Description| | -- | -- | | int | **0** if the API is called successfully; **-5** if the pointer to an input parameter is null.| ### OH_HiAppEvent_TakeWatcherData() ``` int OH_HiAppEvent_TakeWatcherData(HiAppEvent_Watcher* watcher, uint32_t eventNum, OH_HiAppEvent_OnTake onTake) ``` **Description** Obtains the event saved by the watcher. **Since**: 12 **Parameters** | Name| Description| | -- | -- | | [HiAppEvent_Watcher](capi-hiappevent-hiappevent-watcher.md)* watcher | Pointer to the watcher (that is, the pointer returned by OH_HiAppEvent_CreateWatcher).| | uint32_t eventNum | If the input value is less than or equal to **0**, all saved events are obtained. If the input value is greater than **0**, events are sorted by time in descending order and a specified number of saved events are obtained.| | [OH_HiAppEvent_OnTake](capi-hiappevent-h.md#oh_hiappevent_ontake) onTake | Pointer to the callback. The event information is returned through this callback.| **Returns** | Type| Description| | -- | -- | | int | **0** if the API is called successfully; **-5** if the pointer to an input parameter is null; **-6** if **OH_HiAppEvent_AddWatcher** has not been called to add a watcher.| ### OH_HiAppEvent_AddWatcher() ``` int OH_HiAppEvent_AddWatcher(HiAppEvent_Watcher* watcher) ``` **Description** Adds a watcher. Once a watcher is added, it starts to listen for system messages. **Since**: 12 **Parameters** | Name| Description| | -- | -- | | [HiAppEvent_Watcher](capi-hiappevent-hiappevent-watcher.md)* watcher | Pointer to the watcher (that is, the pointer returned by OH_HiAppEvent_CreateWatcher).| **Returns** | Type| Description| | -- | -- | | int | **0** if the API is called successfully; **-5** if the pointer to an input parameter is null.| ### OH_HiAppEvent_RemoveWatcher() ``` int OH_HiAppEvent_RemoveWatcher(HiAppEvent_Watcher* watcher) ``` **Description** Removes a watcher. Once a watcher is removed, it stops listening for system messages. Note: This API only enables the watcher to stop listening for system messages. It does not destroy the watcher. The watcher still resides in the memory until the OH_HiAppEvent_DestroyWatcher API is called. **Since**: 12 **Parameters** | Name| Description| | -- | -- | | [HiAppEvent_Watcher](capi-hiappevent-hiappevent-watcher.md)* watcher | Pointer to the watcher (that is, the pointer returned by OH_HiAppEvent_CreateWatcher).| **Returns** | Type| Description| | -- | -- | | int | **0** if the API is called successfully; **-5** if the pointer to an input parameter is null; **-6** if **OH_HiAppEvent_AddWatcher** has not been called to add a watcher.| ### OH_HiAppEvent_ClearData() ``` void OH_HiAppEvent_ClearData() ``` **Description** Clears the events saved by all watchers. **Since**: 12 ### OH_HiAppEvent_CreateProcessor() ``` HiAppEvent_Processor* OH_HiAppEvent_CreateProcessor(const char* name) ``` **Description** Creates a processor for application events. Note: If a processor is no longer used, call **OH_HiAppEvent_DestroyProcessor** to destroy it. **Since**: 18 **Parameters** | Name| Description| | -- | -- | | const char* name | Processor name, which can contain only letters, digits, underscores (_), and dollar signs ($). It cannot start with a digit and cannot exceed 256 characters.| **Returns** | Type | Description| |---------------------------| -- | | [HiAppEvent_Processor](capi-hiappevent-hiappevent-processor.md)* | Pointer to the new processor if the API is called successfully; **nullptr** if the **name** parameter is invalid.| ### OH_HiAppEvent_SetReportRoute() ``` int OH_HiAppEvent_SetReportRoute(HiAppEvent_Processor* processor, const char* appId, const char* routeInfo) ``` **Description** Sets the report route for the processor. **Since**: 18 **Parameters** | Name| Description| | -- | -- | | [HiAppEvent_Processor](capi-hiappevent-hiappevent-processor.md)* processor | Pointer to the processor, that is, the pointer returned by **OH_HiAppEvent_CreateProcessor**.| | const char* appId | Application ID of the processor.| | const char* routeInfo | Server location information. The default value is an empty string. The string length cannot exceed 8 KB. Otherwise, the default value is used.| **Returns** | Type| Description| | -- | -- | | int | [HIAPPEVENT_SUCCESS](capi-hiappevent-h.md#hiappevent_errorcode): Operation successful.
[HIAPPEVENT_PROCESSOR_IS_NULL](capi-hiappevent-h.md#hiappevent_errorcode): The **processor** parameter is empty.
[HIAPPEVENT_INVALID_PARAM_VALUE](capi-hiappevent-h.md#hiappevent_errorcode): Invalid parameter value.
[HIAPPEVENT_INVALID_UID](capi-hiappevent-h.md#hiappevent_errorcode): Invalid user ID.
[HIAPPEVENT_INVALID_PARAM_VALUE_LENGTH](capi-hiappevent-h.md#hiappevent_errorcode): Invalid parameter value length.
For details, see [HiAppEvent_ErrorCode](capi-hiappevent-h.md#hiappevent_errorcode).| ### OH_HiAppEvent_SetReportPolicy() ``` int OH_HiAppEvent_SetReportPolicy(HiAppEvent_Processor* processor, int periodReport, int batchReport,bool onStartReport, bool onBackgroundReport) ``` **Description** Sets the report policy for the processor. **Since**: 18 **Parameters** | Name| Description| | -- | -- | | [HiAppEvent_Processor](capi-hiappevent-hiappevent-processor.md)* processor | Pointer to the processor, that is, the pointer returned by **OH_HiAppEvent_CreateProcessor**.| | int periodReport | Period for reporting events, in seconds.| | int batchReport | Threshold for reporting events. When the number of events reaches the threshold, an event is reported.| | bool onStartReport | Whether to report an event when the processor is started. The default value is **false**.| | bool onBackgroundReport | Whether to report an event when an application enters the background. The default value is **false**.| **Returns** | Type| Description| | -- | -- | | int | [HIAPPEVENT_SUCCESS](capi-hiappevent-h.md#hiappevent_errorcode): Operation successful.
[HIAPPEVENT_PROCESSOR_IS_NULL](capi-hiappevent-h.md#hiappevent_errorcode): The **processor** parameter is empty.
[HIAPPEVENT_INVALID_PARAM_VALUE](capi-hiappevent-h.md#hiappevent_errorcode): Invalid parameter value.
[HIAPPEVENT_INVALID_UID](capi-hiappevent-h.md#hiappevent_errorcode): Invalid user ID.
For details, see [HiAppEvent_ErrorCode](capi-hiappevent-h.md#hiappevent_errorcode).| ### OH_HiAppEvent_SetReportEvent() ``` int OH_HiAppEvent_SetReportEvent(HiAppEvent_Processor* processor, const char* domain, const char* name,bool isRealTime) ``` **Description** Sets the report event for the processor. **Since**: 18 **Parameters** | Name| Description| | -- | -- | | [HiAppEvent_Processor](capi-hiappevent-hiappevent-processor.md)* processor | Pointer to the processor, that is, the pointer returned by **OH_HiAppEvent_CreateProcessor**.| | const char* domain | Domain of the report event.| | const char* name | Name of the report event.| | bool isRealTime | Whether to report events in real time.| **Returns** | Type| Description| | -- | -- | | int | [HIAPPEVENT_SUCCESS](capi-hiappevent-h.md#hiappevent_errorcode): Operation successful.
[HIAPPEVENT_PROCESSOR_IS_NULL](capi-hiappevent-h.md#hiappevent_errorcode): The **processor** parameter is empty.
[HIAPPEVENT_INVALID_PARAM_VALUE](capi-hiappevent-h.md#hiappevent_errorcode): Invalid parameter value.
[HIAPPEVENT_INVALID_UID](capi-hiappevent-h.md#hiappevent_errorcode): Invalid user ID.
For details, see [HiAppEvent_ErrorCode](capi-hiappevent-h.md#hiappevent_errorcode).| ### OH_HiAppEvent_SetCustomConfig() ``` int OH_HiAppEvent_SetCustomConfig(HiAppEvent_Processor* processor, const char* key, const char* value) ``` **Description** Sets the custom extension parameters of the processor. **Since**: 18 **Parameters** | Name| Description| | -- | -- | | [HiAppEvent_Processor](capi-hiappevent-hiappevent-processor.md)* processor | Pointer to the processor, that is, the pointer returned by **OH_HiAppEvent_CreateProcessor**.| | const char* key | Parameter name, which contains a maximum of 32 characters.| | const char* value | Parameter value, which contains a maximum of 1024 characters.| **Returns** | Type| Description| | -- | -- | | int | [HIAPPEVENT_SUCCESS](capi-hiappevent-h.md#hiappevent_errorcode): Operation successful.
[HIAPPEVENT_PROCESSOR_IS_NULL](capi-hiappevent-h.md#hiappevent_errorcode): The **processor** parameter is empty.
[HIAPPEVENT_INVALID_PARAM_VALUE](capi-hiappevent-h.md#hiappevent_errorcode): Invalid parameter value.
[HIAPPEVENT_INVALID_UID](capi-hiappevent-h.md#hiappevent_errorcode): Invalid user ID.
[HIAPPEVENT_INVALID_PARAM_VALUE_LENGTH](capi-hiappevent-h.md#hiappevent_errorcode): Invalid parameter value length.
For details, see [HiAppEvent_ErrorCode](capi-hiappevent-h.md#hiappevent_errorcode).| ### OH_HiAppEvent_SetConfigId() ``` int OH_HiAppEvent_SetConfigId(HiAppEvent_Processor* processor, int configId) ``` **Description** Sets the configuration ID of the processor. **Since**: 18 **Parameters** | Name| Description| | -- | -- | | [HiAppEvent_Processor](capi-hiappevent-hiappevent-processor.md)* processor | Pointer to the processor, that is, the pointer returned by **OH_HiAppEvent_CreateProcessor**.| | int configId | Configuration ID of the processor, which is a natural number.| **Returns** | Type| Description| | -- | -- | | int | [HIAPPEVENT_SUCCESS](capi-hiappevent-h.md#hiappevent_errorcode): Operation successful.
[HIAPPEVENT_PROCESSOR_IS_NULL](capi-hiappevent-h.md#hiappevent_errorcode): The **processor** parameter is empty.
[HIAPPEVENT_INVALID_PARAM_VALUE](capi-hiappevent-h.md#hiappevent_errorcode): Invalid parameter value.
[HIAPPEVENT_INVALID_UID](capi-hiappevent-h.md#hiappevent_errorcode): Invalid user ID.
For details, see [HiAppEvent_ErrorCode](capi-hiappevent-h.md#hiappevent_errorcode).| ### OH_HiAppEvent_SetConfigName() ``` int OH_HiAppEvent_SetConfigName(HiAppEvent_Processor* processor, const char* configName) ``` **Description** Sets the configuration name of the processor. **Since**: 20 **Parameters** | Name| Description| | -- | -- | | [HiAppEvent_Processor](capi-hiappevent-hiappevent-processor.md)* processor | Pointer to the processor, that is, the pointer returned by **OH_HiAppEvent_CreateProcessor**.| | const char* configName | Configuration name of the data processor. which can contain only letters, digits, underscores (_), and dollar signs ($). It cannot start with a digit and cannot exceed 256 characters.| **Returns** | Type| Description| | -- | -- | | int | [HIAPPEVENT_SUCCESS](capi-hiappevent-h.md#hiappevent_errorcode): Operation successful.
[HIAPPEVENT_PROCESSOR_IS_NULL](capi-hiappevent-h.md#hiappevent_errorcode): The **processor** parameter is empty.
[HIAPPEVENT_INVALID_PARAM_VALUE](capi-hiappevent-h.md#hiappevent_errorcode): Invalid parameter value.
[HIAPPEVENT_INVALID_UID](capi-hiappevent-h.md#hiappevent_errorcode): Invalid user ID.
[HIAPPEVENT_INVALID_PARAM_VALUE_LENGTH](capi-hiappevent-h.md#hiappevent_errorcode): Invalid parameter value length.
For details, see [HiAppEvent_ErrorCode](capi-hiappevent-h.md#hiappevent_errorcode).| ### OH_HiAppEvent_SetReportUserId() ``` int OH_HiAppEvent_SetReportUserId(HiAppEvent_Processor* processor, const char* const * userIdNames, int size) ``` **Description** Sets the report user ID of the processor. **Since**: 18 **Parameters** | Name| Description| | -- | -- | | [HiAppEvent_Processor](capi-hiappevent-hiappevent-processor.md)* processor | Pointer to the processor, that is, the pointer returned by **OH_HiAppEvent_CreateProcessor**.| | const char* const * userIdNames | Name array of user IDs that can be reported by the processor.| | int size | Length of the name array of user IDs.| **Returns** | Type| Description| | -- | -- | | int | [HIAPPEVENT_SUCCESS](capi-hiappevent-h.md#hiappevent_errorcode): Operation successful.
[HIAPPEVENT_PROCESSOR_IS_NULL](capi-hiappevent-h.md#hiappevent_errorcode): The **processor** parameter is empty.
[HIAPPEVENT_INVALID_PARAM_VALUE](capi-hiappevent-h.md#hiappevent_errorcode): Invalid parameter value.
[HIAPPEVENT_INVALID_UID](capi-hiappevent-h.md#hiappevent_errorcode): Invalid user ID.
[HIAPPEVENT_INVALID_PARAM_VALUE_LENGTH](capi-hiappevent-h.md#hiappevent_errorcode): Invalid parameter value length.
For details, see [HiAppEvent_ErrorCode](capi-hiappevent-h.md#hiappevent_errorcode).| ### OH_HiAppEvent_SetReportUserProperty() ``` int OH_HiAppEvent_SetReportUserProperty(HiAppEvent_Processor* processor, const char* const * userPropertyNames,int size) ``` **Description** Sets the report user property of the processor. **Since**: 18 **Parameters** | Name| Description| | -- | -- | | [HiAppEvent_Processor](capi-hiappevent-hiappevent-processor.md)* processor | Pointer to the processor, that is, the pointer returned by **OH_HiAppEvent_CreateProcessor**.| | const char* const * userPropertyNames | Name array of user properties that can be reported by the processor.| | int size | Length of the name array of user properties.| **Returns** | Type| Description| | -- | -- | | int | [HIAPPEVENT_SUCCESS](capi-hiappevent-h.md#hiappevent_errorcode): Operation successful.
[HIAPPEVENT_PROCESSOR_IS_NULL](capi-hiappevent-h.md#hiappevent_errorcode): The **processor** parameter is empty.
[HIAPPEVENT_INVALID_PARAM_VALUE](capi-hiappevent-h.md#hiappevent_errorcode): Invalid parameter value.
[HIAPPEVENT_INVALID_UID](capi-hiappevent-h.md#hiappevent_errorcode): Invalid user ID.
[HIAPPEVENT_INVALID_PARAM_VALUE_LENGTH](capi-hiappevent-h.md#hiappevent_errorcode): Invalid parameter value length.
For details, see [HiAppEvent_ErrorCode](capi-hiappevent-h.md#hiappevent_errorcode).| ### OH_HiAppEvent_AddProcessor() ``` int64_t OH_HiAppEvent_AddProcessor(HiAppEvent_Processor* processor) ``` **Description** Adds a processor. You can add a processor to migrate event data to the cloud. You can preset the implementation of the processor on the device and set its properties based on its constraints. Note that the configuration information of **Processor** must be provided by the data processor. Yet, as no data processor is preset in the device for interaction for the moment, migrating events to the cloud is unavailable. **Since**: 18 **Parameters** | Name| Description| | -- | -- | | [HiAppEvent_Processor](capi-hiappevent-hiappevent-processor.md)* processor | Pointer to the processor, that is, the pointer returned by **OH_HiAppEvent_CreateProcessor**.| **Returns** | Type| Description| | -- | -- | | int64_t | Unique ID of the processor is returned when the API is successfully called. The value is greater than 0.
[HIAPPEVENT_PROCESSOR_IS_NULL](capi-hiappevent-h.md#hiappevent_errorcode): The **processor** parameter is empty.
[HIAPPEVENT_INVALID_PARAM_VALUE](capi-hiappevent-h.md#hiappevent_errorcode): Invalid parameter value.
[HIAPPEVENT_OPERATE_FAILED](capi-hiappevent-h.md#hiappevent_errorcode): Failed to find or register the data processor name.
[HIAPPEVENT_INVALID_UID](capi-hiappevent-h.md#hiappevent_errorcode): Invalid user ID.
For details, see [HiAppEvent_ErrorCode](capi-hiappevent-h.md#hiappevent_errorcode).| ### OH_HiAppEvent_DestroyProcessor() ``` void OH_HiAppEvent_DestroyProcessor(HiAppEvent_Processor* processor) ``` **Description** Destroys a processor. Note: If a processor is no longer used, destroy it to release memory to prevent memory leaks. After the processor is destroyed, set its pointer to null. **Since**: 18 **Parameters** | Name| Description| | -- | -- | | [HiAppEvent_Processor](capi-hiappevent-hiappevent-processor.md)* processor | Pointer to the processor, that is, the pointer returned by **OH_HiAppEvent_CreateProcessor**.| ### OH_HiAppEvent_RemoveProcessor() ``` int OH_HiAppEvent_RemoveProcessor(int64_t processorId) ``` **Description** Removes a processor. Once a processor is removed, it stops reporting events. Note: This API only stops the processor reporting events but does not destroy the processor. You can call **OH_HiAppEvent_DestroyProcessor** to destroy the processor and release the memory. **Since**: 18 **Parameters** | Name| Description| | -- | -- | | int64_t processorId | Unique ID of a processor.| **Returns** | Type| Description| | -- | -- | | int | [HIAPPEVENT_SUCCESS](capi-hiappevent-h.md#hiappevent_errorcode): Operation successful.
[HIAPPEVENT_PROCESSOR_NOT_FOUND](capi-hiappevent-h.md#hiappevent_errorcode): Failed to find the processor.
[HIAPPEVENT_OPERATE_FAILED](capi-hiappevent-h.md#hiappevent_errorcode): Operation failed.
[HIAPPEVENT_INVALID_UID](capi-hiappevent-h.md#hiappevent_errorcode): Invalid user ID.
For details, see [HiAppEvent_ErrorCode](capi-hiappevent-h.md#hiappevent_errorcode).| ### OH_HiAppEvent_CreateConfig() ``` HiAppEvent_Config* OH_HiAppEvent_CreateConfig(void) ``` **Description** Creates a pointer to the configuration object that sets the conditions for triggering system events. **Since**: 15 **Returns** | Type | Description| |------------------------| -- | | [HiAppEvent_Config](capi-hiappevent-hiappevent-config.md)* | Pointer to the configuration object that sets the conditions for triggering system events.| ### OH_HiAppEvent_DestroyConfig() ``` void OH_HiAppEvent_DestroyConfig(HiAppEvent_Config* config) ``` **Description** Destroys a configuration object. Note: If a configuration object is no longer used, destroy it to release memory to prevent memory leaks. After the object is destroyed, set its pointer to null. **Since**: 15 **Parameters** | Name| Description| | -- | -- | | [HiAppEvent_Config](capi-hiappevent-hiappevent-config.md)* config | Pointer to the configuration object, that is, the pointer returned by the **OH_HiAppEvent_CreateConfig** API.| ### OH_HiAppEvent_SetConfigItem() ``` int OH_HiAppEvent_SetConfigItem(HiAppEvent_Config* config, const char* itemName, const char* itemValue) ``` **Description** Sets the items in the configuration object. **Since**: 15 **Parameters** | Name| Description| | -- | -- | | [HiAppEvent_Config](capi-hiappevent-hiappevent-config.md)* config | Pointer to the configuration object, that is, the pointer returned by the **OH_HiAppEvent_CreateConfig** API.| | const char* itemName | Name of the configuration item.| | const char* itemValue | Value of the configuration item.| **Returns** | Type| Description| | -- | -- | | int | [HIAPPEVENT_SUCCESS](capi-hiappevent-h.md#hiappevent_errorcode): Operation successful.
[HIAPPEVENT_EVENT_CONFIG_IS_NULL](capi-hiappevent-h.md#hiappevent_errorcode): The input pointer to the configuration object is null.
[HIAPPEVENT_INVALID_PARAM_VALUE](capi-hiappevent-h.md#hiappevent_errorcode): Invalid configuration item.
For details, see [HiAppEvent_ErrorCode](capi-hiappevent-h.md#hiappevent_errorcode).| ### OH_HiAppEvent_SetEventConfig() ``` int OH_HiAppEvent_SetEventConfig(const char* name, HiAppEvent_Config* config) ``` **Description** Sets the conditions for triggering system event subscription. **Since**: 15 **Parameters** | Name| Description| | -- | -- | | const char* name | Name of the system event.| | [HiAppEvent_Config](capi-hiappevent-hiappevent-config.md)* config | Pointer to the configuration object, that is, the pointer returned by the **OH_HiAppEvent_CreateConfig** API.| **Returns** | Type| Description| | -- | -- | | int | [HIAPPEVENT_SUCCESS](capi-hiappevent-h.md#hiappevent_errorcode): Operation successful.
[HIAPPEVENT_INVALID_PARAM_VALUE](capi-hiappevent-h.md#hiappevent_errorcode): Invalid parameter.
For details, see [HiAppEvent_ErrorCode](capi-hiappevent-h.md#hiappevent_errorcode).|