!2255 hiAppEvent相关资料结构调整

Merge pull request !2255 from zengyawen/master

!2255 hiAppEvent相关资料结构调整
Merge pull request !2255 from zengyawen/master
d2f16511 · openharmony_ci · Gitee · 33fc19e5 · ac4839e7 · d2f16511
2 changed file
--- a/zh-cn/application-dev/dfx/hiappevent-guidelines.md
+++ b/zh-cn/application-dev/dfx/hiappevent-guidelines.md
@@ -8,6 +8,8 @@

 应用事件JS打点接口由hiAppEvent模块提供。

+以下仅提供简单的接口介绍，API接口的具体使用说明（参数使用限制、具体取值范围等），请参考[应用事件打点API文档](../reference/apis/js-apis-hiappevent.md)。
+
 **打点接口功能介绍：**

 | 接口名                                                       | 返回值         | 描述                                                 |
@@ -15,25 +17,6 @@
 | write(string eventName, EventType type, object keyValues, AsyncCallback\<void> callback): void | void           | 应用事件异步打点方法，使用callback方式作为异步回调。 |
 | write(string eventName, EventType type, object keyValues): Promise\<void> | Promise\<void> | 应用事件异步打点方法，使用promise方式作为异步回调。  |

- 参数eventName：开发者自定义事件名称。事件名称在48个字符以内，有效的字符是0-9、a-z、下划线，只能以字母开头。
-
- 参数type：事件所属的类型，取值为枚举EventType，具体值如下表。
-
-  | 类型      | 描述           |
-  | --------- | -------------- |
-  | FAULT     | 故障类型事件。 |
-  | STATISTIC | 统计类型事件。 |
-  | SECURITY  | 安全类型事件。 |
-  | BEHAVIOR  | 行为类型事件。 |
-
- 参数keyValues：事件参数键值对，如果是变长参数类型，则依次输入事件的参数名与参数值。如果是Json对象类型，则Json对象的key是事件的参数名，value是事件的参数值。
-  - 参数名只支持string类型，参数值只支持boolean、number、string、Array（数组参数值为基本类型）。
-  - 事件的参数个数必须小于等于32。
-  - 参数名在16个字符以内，有效的字符是0-9、a-z、下划线，只能以字母开头，不能以下划线结尾。
-  - string类型参数值在8*1024个字符内。
-  - Array类型参数值的元素个数必须在100个以内，超出时会进行截断处理。
- 参数callback：回调函数，可以在回调函数中处理接口返回值。返回值为0表示事件参数校验成功，事件正常异步写入事件文件；大于0表示事件存在异常参数，事件在忽略异常参数后再异步写入事件文件；小于0表示事件校验失败，不执行事件异步打点操作。
-
 当采用callback作为异步回调时，可以在callback中进行下一步处理。当采用Promise对象返回时，可以在Promise对象中类似地处理接口返回值。具体结果码说明见[事件校验结果码](hiappevent-overview.md#事件校验结果码)。

 **打点配置接口功能介绍：**
@@ -42,29 +25,6 @@
 | ------------------------------ | ------- | ------------------------------------------------------------ |
 | configure(ConfigOption config) | boolean | 应用事件打点配置方法，可以对打点功能进行自定义配置。返回true表示配置成功，false表示配置失败。 |

- 参数config：应用事件打点配置项对象。应用打点配置选项ConfigOption如下表。
-
-  | 参数名     | 类型    | 必填 | 说明                                                         |
-  | ---------- | ------- | ---- | ------------------------------------------------------------ |
-  | disable    | boolean | 否   | 应用打点功能开关，例如配置值为true表示关闭打点功能。         |
-  | maxStorage | string  | 否   | 打点落盘文件存放目录的配额大小，默认限额为“10M”，超出限额后会对存放目录进行清理。 |
-
-
-**预定义事件名称常量接口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。 |
-
 ## 开发步骤

 在应用启动执行页面加载后，执行一个应用事件打点，用于记录应用的初始页面加载事件。
@@ -112,6 +72,4 @@
   }
   ```

-2. 运行项目，点击应用界面上的运行按钮。
-
-
+2. 运行项目，点击应用界面上的运行按钮。
\ No newline at end of file
--- a/zh-cn/application-dev/reference/apis/js-apis-hiappevent.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-hiappevent.md
@@ -21,12 +21,12 @@ write(eventName: string, eventType: EventType, keyValues: object, callback: Asyn

 **参数：**

-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| eventName | string | 是 | 应用事件名称。 |
-| eventType | [EventType](#eventtype) | 是 | 应用事件类型。 |
-| keyValues | object | 是 | 应用事件的参数，key类型只能为string，value类型只能为string、number、boolean、Array（数组数据类型只能为string、number、boolean）。 |
-| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数，可以在回调函数中处理接口返回值。<br/>-&nbsp;返回值为0表示事件校验成功，事件正常异步写入事件文件；<br/>-&nbsp;大于0表示事件校验存在异常参数，在忽略异常参数后将事件异步写入事件文件；<br/>-&nbsp;小于0表示事件校验失败，不将事件写入事件文件。 |
+| 参数名    | 类型                      | 必填 | 说明                                                         |
+| --------- | ------------------------- | ---- | ------------------------------------------------------------ |
+| eventName | string                    | 是   | 应用事件名称。<br/>由开发者自定义。事件名称在48个字符以内，有效的字符是0-9、a-z、下划线，只能以字母开头。 |
+| eventType | [EventType](#eventtype)   | 是   | 应用事件类型。                                               |
+| keyValues | object                    | 是   | 事件参数键值对，如果是变长参数类型，则依次输入事件的参数名与参数值。如果是Json对象类型，则Json对象的key是事件的参数名，value是事件的参数值。<br/>- key类型只能为string，value类型只能为string、number、boolean、Array（数组数据类型只能为string、number、boolean）。<br/>- 事件的参数个数必须小于等于32。<br/>- 参数名在16个字符以内，有效的字符是0-9、a-z、下划线，只能以字母开头，不能以下划线结尾。<br/>- string类型参数值在8*1024个字符内。<br/>- Array类型参数值的元素个数必须在100个以内，超出时会进行截断处理。 |
+| callback  | AsyncCallback&lt;void&gt; | 否   | 回调函数，可以在回调函数中处理接口返回值。<br/>-&nbsp;返回值为0表示事件校验成功，事件正常异步写入事件文件；<br/>-&nbsp;大于0表示事件校验存在异常参数，在忽略异常参数后将事件异步写入事件文件；<br/>-&nbsp;小于0表示事件校验失败，不将事件写入事件文件。 |

 **示例：**

@@ -54,16 +54,16 @@ write(eventName: string, eventType: EventType, keyValues: object): Promise&lt;vo

 **参数：**

-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| eventName | string | 是 | 应用事件名称。 |
-| eventType | [EventType](#eventtype) | 是 | 应用事件类型。 |
-| keyValues | object | 是 | 应用事件的参数，key类型只能为string，value类型只能为string、number、boolean、Array（数组数据类型只能为string、number、boolean）。 |
+| 参数名    | 类型                    | 必填 | 说明                                                         |
+| --------- | ----------------------- | ---- | ------------------------------------------------------------ |
+| eventName | string                  | 是   | 应用事件名称。<br/>由开发者自定义。事件名称在48个字符以内，有效的字符是0-9、a-z、下划线，只能以字母开头。 |
+| eventType | [EventType](#eventtype) | 是   | 应用事件类型。                                               |
+| keyValues | object                  | 是   | 事件参数键值对，如果是变长参数类型，则依次输入事件的参数名与参数值。如果是Json对象类型，则Json对象的key是事件的参数名，value是事件的参数值。<br/>- key类型只能为string，value类型只能为string、number、boolean、Array（数组数据类型只能为string、number、boolean）。<br/>- 事件的参数个数必须小于等于32。<br/>- 参数名在16个字符以内，有效的字符是0-9、a-z、下划线，只能以字母开头，不能以下划线结尾。<br/>- string类型参数值在8*1024个字符内。<br/>- Array类型参数值的元素个数必须在100个以内，超出时会进行截断处理。 |

 **返回值：**

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

 **示例：**
@@ -90,14 +90,14 @@ configure(config: ConfigOption): boolean

 **参数：**

-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| config | [ConfigOption](#configoption) | 是 | 应用事件打点配置项对象。 |
+| 参数名 | 类型                          | 必填 | 说明                     |
+| ------ | ----------------------------- | ---- | ------------------------ |
+| config | [ConfigOption](#configoption) | 是   | 应用事件打点配置项对象。 |

 **返回值：**

-| 类型 | 说明 |
-| -------- | -------- |
+| 类型    | 说明                                                        |
+| ------- | ----------------------------------------------------------- |
 | boolean | 配置结果，true&nbsp;表示配置成功，false&nbsp;表示配置失败。 |

 **示例：**
@@ -120,10 +120,10 @@ hiAppEvent.configure({

 **系统能力：** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。

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


 ## EventType
@@ -132,12 +132,12 @@ hiAppEvent.configure({

 **系统能力：** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。

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


 ## Event
@@ -146,11 +146,11 @@ hiAppEvent.configure({

 **系统能力：** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。

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


 ## Param
@@ -159,8 +159,8 @@ hiAppEvent.configure({

 **系统能力：** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。

-| 名称 | 参数类型 | 可读 | 可写 | 说明 |
-| -------- | -------- | -------- | -------- | -------- |
-| USER_ID | string | 是 | 否 | 用户自定义ID。 |
-| DISTRIBUTED_SERVICE_NAME | string | 是 | 否 | 分布式服务名称。 |
-| DISTRIBUTED_SERVICE_INSTANCE_ID | string | 是 | 否 | 分布式服务实例ID。 |
+| 名称                            | 参数类型 | 可读 | 可写 | 说明               |
+| ------------------------------- | -------- | ---- | ---- | ------------------ |
+| USER_ID                         | string   | 是   | 否   | 用户自定义ID。     |
+| DISTRIBUTED_SERVICE_NAME        | string   | 是   | 否   | 分布式服务名称。   |
+| DISTRIBUTED_SERVICE_INSTANCE_ID | string   | 是   | 否   | 分布式服务实例ID。 |
\ No newline at end of file