应用打点
说明: 从 API Version 7 开始支持。
导入模块
import hiAppEvent from '@ohos.hiAppEvent';
权限
无
hiAppEvent.write
write(eventName: string, eventType: EventType, keyValues: object, callback: AsyncCallback<void>): void
应用事件打点方法,将事件写入到当天的事件文件中,可接收类型为Json对象的事件参数,使用callback方式作为异步回调。
-
参数:
应用事件的参数,key类型只能为string,value类型只能为string、number、boolean、Array(数组数据类型只能为string、number、boolean)。
- 返回值为0表示事件校验成功,事件正常异步写入事件文件;
- 大于0表示事件校验存在异常参数,在忽略异常参数后将事件异步写入事件文件;
- 小于0表示事件校验失败,不将事件写入事件文件。
-
示例:
hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str_data":"strValue"}, (err, value) => { if (err) { // 事件写入异常:事件存在异常参数时忽略异常参数后继续写入,或者事件校验失败时不执行写入 console.error(`failed to write event because ${err.code}`); return; } // 事件写入正常 console.log(`success to write event: ${value}`); });
hiAppEvent.write
write(eventName: string, eventType: EventType, keyValues: object): Promise<void>
应用事件打点方法,将事件写入到当天的事件文件中,可接收类型为Json对象的事件参数,使用promise方式作为异步回调。
-
参数:
应用事件的参数,key类型只能为string,value类型只能为string、number、boolean、Array(数组数据类型只能为string、number、boolean)。
-
返回值:
-
示例:
hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str_data":"strValue"}) .then((value) => { // 事件写入正常 console.log(`success to write event: ${value}`); }).catch((err) => { // 事件写入异常:事件存在异常参数时忽略异常参数后继续写入,或者事件校验失败时不执行写入 console.error(`failed to write event because ${err.code}`); });
hiAppEvent.configure
configure(config: ConfigOption): boolean
应用事件打点配置方法,可用于配置打点开关、文件目录存储限额大小等功能。
-
参数:
-
返回值:
-
示例:
// 配置应用事件打点功能开关 hiAppEvent.configure({ disable: true }); // 配置事件文件目录存储限额大小 hiAppEvent.configure({ maxStorage: '100M' });
ConfigOption
此接口提供了应用打点的配置选项。
打点数据本地存储文件所在目录的配额大小,默认限额为“10M”。所在目录大小超出限额后会对目录进行清理操作,会按从旧到新的顺序逐个删除打点数据文件,直到目录大小不超出限额时停止。 |
EventType
事件类型枚举。
Event
此接口提供了所有预定义事件的事件名称常量。
Param
此接口提供了所有预定义参数的参数名称常量。