hiappevent.h
概述
HiAppEvent模块的应用事件打点函数定义。
在执行应用事件打点之前,您必须先构造一个参数列表对象来存储输入的事件参数,并指定事件领域、事件名称和事件类型。
事件领域:用于标识事件打点的领域的字符串。
事件名称:用于标识事件打点的名称的字符串。
事件类型:故障、统计、安全、行为。
参数列表:用于存储事件参数的链表,每个参数由参数名和参数值组成。
示例代码:
-
引入头文件:
#include "hiappevent/hiappevent.h"
-
创建一个参数列表指针:
ParamList list = OH_HiAppEvent_CreateParamList();
-
添加参数到参数列表中:
bool boolean = true; OH_HiAppEvent_AddBoolParam(list, "bool_key", boolean); int32_t nums[] = {1, 2, 3}; OH_HiAppEvent_AddInt32ArrayParam(list, "int32_arr_key", nums, sizeof(nums) / sizeof(nums[0]));
-
执行事件打点:
int res = OH_HiAppEvent_Write("test_domain", "test_event", BEHAVIOR, list);
-
销毁参数列表指针,释放其分配内存:
OH_HiAppEvent_DestroyParamList(list);
起始版本: 8
相关模块:HiAppEvent
汇总
类型定义
名称 | 描述 |
---|---|
typedef struct ParamListNode * ParamList | 事件参数列表节点。 |
枚举
名称 | 描述 |
---|---|
EventType { FAULT = 1, STATISTIC = 2, SECURITY = 3, BEHAVIOR = 4 } | 事件类型。 |
函数
名称 | 描述 |
---|---|
ParamList OH_HiAppEvent_CreateParamList (void) | 创建一个指向参数列表对象的指针。 |
void OH_HiAppEvent_DestroyParamList (ParamList list) | 销毁一个指向参数列表对象的指针,释放其分配内存。 |
ParamList OH_HiAppEvent_AddBoolParam (ParamList list, const char *name, bool boolean) | 添加一个布尔参数到参数列表中。 |
ParamList OH_HiAppEvent_AddBoolArrayParam (ParamList list, const char *name, const bool *booleans, int arrSize) | 添加一个布尔数组参数到参数列表中。 |
ParamList OH_HiAppEvent_AddInt8Param (ParamList list, const char *name, int8_t num) | 添加一个int8_t参数到参数列表中。 |
ParamList OH_HiAppEvent_AddInt8ArrayParam (ParamList list, const char *name, const int8_t *nums, int arrSize) | 添加一个int8_t数组参数到参数列表中。 |
ParamList OH_HiAppEvent_AddInt16Param (ParamList list, const char *name, int16_t num) | 添加一个int16_t参数到参数列表中。 |
ParamList OH_HiAppEvent_AddInt16ArrayParam (ParamList list, const char *name, const int16_t *nums, int arrSize) | 添加一个int16_t数组参数到参数列表中。 |
ParamList OH_HiAppEvent_AddInt32Param (ParamList list, const char *name, int32_t num) | 添加一个int32_t参数到参数列表中。 |
ParamList OH_HiAppEvent_AddInt32ArrayParam (ParamList list, const char *name, const int32_t *nums, int arrSize) | 添加一个int32_t数组参数到参数列表中。 |
ParamList OH_HiAppEvent_AddInt64Param (ParamList list, const char *name, int64_t num) | 添加一个int64_t参数到参数列表中。 |
ParamList OH_HiAppEvent_AddInt64ArrayParam (ParamList list, const char *name, const int64_t *nums, int arrSize) | 添加一个int64_t数组参数到参数列表中。 |
ParamList OH_HiAppEvent_AddFloatParam (ParamList list, const char *name, float num) | 添加一个float参数到参数列表中。 |
ParamList OH_HiAppEvent_AddFloatArrayParam (ParamList list, const char *name, const float *nums, int arrSize) | 添加一个float数组参数到参数列表中。 |
ParamList OH_HiAppEvent_AddDoubleParam (ParamList list, const char *name, double num) | 添加一个double参数到参数列表中。 |
ParamList OH_HiAppEvent_AddDoubleArrayParam (ParamList list, const char *name, const double *nums, int arrSize) | 添加一个double数组参数到参数列表中。 |
ParamList OH_HiAppEvent_AddStringParam (ParamList list, const char *name, const char *str) | 添加一个字符串参数到参数列表中。 |
ParamList OH_HiAppEvent_AddStringArrayParam (ParamList list, const char *name, const char *const *strs, int arrSize) | 添加一个字符串数组参数到参数列表中。 |
int OH_HiAppEvent_Write (const char *domain, const char *name, enum EventType type, const ParamList list) | 实现对参数为列表类型的应用事件打点。 |
bool OH_HiAppEvent_Configure (const char *name, const char *value) | 实现应用事件打点的配置功能。 |