diff --git "a/zh-cn/application-dev/js-reference/\345\272\224\347\224\250\346\211\223\347\202\271.md" "b/zh-cn/application-dev/js-reference/\345\272\224\347\224\250\346\211\223\347\202\271.md" index 782ebf384fe02f2559e29ae4ffbce0bd1ff5cfc6..52630f590347deb085498d6388a176e99d6ec24b 100644 --- "a/zh-cn/application-dev/js-reference/\345\272\224\347\224\250\346\211\223\347\202\271.md" +++ "b/zh-cn/application-dev/js-reference/\345\272\224\347\224\250\346\211\223\347\202\271.md" @@ -2,11 +2,13 @@ - [导入模块](#zh-cn_topic_0000001150092213_s56d19203690d4782bfc74069abb6bd71) - [权限](#zh-cn_topic_0000001150092213_section11257113618419) -- [方法](#zh-cn_topic_0000001150092213_section125675489541) -- [write(eventName: string, eventType: EventType, keyValues: object, callback: AsyncCallback\): void](#zh-cn_topic_0000001150092213_section570630172512) -- [write(eventName: string, eventType: EventType, keyValues: object): Promise](#zh-cn_topic_0000001150092213_section0857164934517) -- [枚举](#zh-cn_topic_0000001150092213_section1978842154715) +- [hiAppEvent.write](#zh-cn_topic_0000001150092213_section570630172512) +- [hiAppEvent.write](#zh-cn_topic_0000001150092213_section0857164934517) +- [hiAppEvent.configure](#hiAppEvent.configure) +- [ConfigOption](#ConfigOption) - [EventType](#zh-cn_topic_0000001150092213_section099619567453) +- [Event](#Event) +- [Param](#Param) ## 导入模块 @@ -18,9 +20,9 @@ import hiAppEvent from '@ohos.hiAppEvent'; 无 -## 方法 +## hiAppEvent.write -## write(eventName: string, eventType: EventType, keyValues: object, callback: AsyncCallback\): void +write(eventName: string, eventType: EventType, keyValues: object, callback: AsyncCallback\): void 应用事件打点，将事件信息写入到当天的事件文件中，可接收类型为JSON对象的事件参数，使用callback方式作为异步方法。 @@ -55,7 +57,7 @@ import hiAppEvent from '@ohos.hiAppEvent';

应用事件类型。

-

jsonParam

+

keyValues

object

@@ -77,7 +79,6 @@ import hiAppEvent from '@ohos.hiAppEvent'; - **示例：** ``` @@ -93,7 +94,9 @@ hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str }); ``` -## write(eventName: string, eventType: EventType, keyValues: object): Promise +## hiAppEvent.write + +write(eventName: string, eventType: EventType, keyValues: object): Promise 应用事件打点，将事件信息写入到当天的事件文件中，可接收类型为JSON对象的事件参数，使用promise方式作为异步方法。 @@ -129,7 +132,7 @@ hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str

应用事件类型。

-

jsonParam

+

keyValues

object

@@ -141,6 +144,7 @@ hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str + **返回值：** @@ -172,7 +176,46 @@ hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str }); ``` -## 枚举 +## 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 @@ -217,3 +260,26 @@ hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str +## 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。 |