# 应用打点 - [导入模块](#zh-cn_topic_0000001163817362_s56d19203690d4782bfc74069abb6bd71) - [权限](#zh-cn_topic_0000001163817362_section11257113618419) - [hiAppEvent.write](#zh-cn_topic_0000001163817362_section570630172512) - [hiAppEvent.write](#zh-cn_topic_0000001163817362_section0857164934517) - [hiAppEvent.configure](#zh-cn_topic_0000001163817362_section5378143772018) - [ConfigOption](#zh-cn_topic_0000001163817362_section1877154515916) - [EventType](#zh-cn_topic_0000001163817362_section099619567453) - [Event](#zh-cn_topic_0000001163817362_section107763162597) - [属性](#zh-cn_topic_0000001163817362_section13128518134118) - [Param](#zh-cn_topic_0000001163817362_section382852073116) - [属性](#zh-cn_topic_0000001163817362_section0452193894112) >![](../../public_sys-resources/icon-note.gif) **说明：** >从 API Version 7 开始支持。 ## 导入模块 ``` import hiAppEvent from '@ohos.hiAppEvent'; ``` ## 权限无 ## hiAppEvent.write write$eventName: string, eventType: EventType, keyValues: object, callback: AsyncCallback$: void 应用事件打点方法，将事件写入到当天的事件文件中，可接收类型为Json对象的事件参数，使用callback方式作为异步回调。 - 参数：

参数名	类型	必填	说明
eventName	string	是	应用事件名称。
eventType	EventType	是	应用事件类型。
keyValues	object	是	应用事件的参数，key类型只能为string，value类型只能为string、number、boolean、Array（数组数据类型只能为string、number、boolean）。
callback	AsyncCallback<void>	否	回调函数，可以在回调函数中处理接口返回值。返回值为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 应用事件打点方法，将事件写入到当天的事件文件中，可接收类型为Json对象的事件参数，使用promise方式作为异步回调。 - 参数：

参数名	类型	必填	说明
eventName	string	是	应用事件名称。
eventType	EventType	是	应用事件类型。
keyValues	object	是	应用事件的参数，key类型只能为string，value类型只能为string、number、boolean、Array（数组数据类型只能为string、number、boolean）。

- 返回值：

类型	说明
Promise<void>	Promise实例，可以在其then()、catch()方法中分别对事件写入成功、写入异常的情况进行回调处理。

- 示例： ``` 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 应用事件打点配置方法，可用于配置打点开关、文件目录存储限额大小等功能。 - 参数：

参数名	类型	必填	说明
config	ConfigOption	是	应用事件打点配置项对象。

- 返回值：

类型	说明
boolean	配置结果，true 表示配置成功，false 表示配置失败。

- 示例： ``` // 配置应用事件打点功能开关 hiAppEvent.configure({ disable: true }); // 配置事件文件目录存储限额大小 hiAppEvent.configure({ maxStorage: '100M' }); ``` ## ConfigOption 此接口提供了应用打点的配置选项。

参数名	类型	必填	说明
disable	boolean	否	应用打点功能开关。配置值为true表示关闭打点功能，false表示不关闭打点功能。
maxStorage	string	否	打点数据本地存储文件所在目录的配额大小，默认限额为“10M”。所在目录大小超出限额后会对目录进行清理操作，会按从旧到新的顺序逐个删除打点数据文件，直到目录大小不超出限额时停止。

## EventType 事件类型枚举。

名称	默认值	说明
FAULT	1	故障类型事件。
STATISTIC	2	统计类型事件。
SECURITY	3	安全类型事件。
BEHAVIOR	4	行为类型事件。

## Event 此接口提供了所有预定义事件的事件名称常量。 ### 属性

名称	参数类型	可读	可写	说明
USER_LOGIN	string	是	否	用户登录事件。
USER_LOGOUT	string	是	否	用户登出事件。
DISTRIBUTED_SERVICE_START	string	是	否	分布式服务启动事件。

## Param 此接口提供了所有预定义参数的参数名称常量。 ### 属性

名称	参数类型	可读	可写	说明
USER_ID	string	是	否	用户自定义ID。
DISTRIBUTED_SERVICE_NAME	string	是	否	分布式服务名称。
DISTRIBUTED_SERVICE_INSTANCE_ID	string	是	否	分布式服务实例ID。