提交 9eb06299 编写于 作者: L lyj_love_code

add content to HiAppEvent doc

Signed-off-by: Nlyj_love_code <liangyujian2@huawei.com>
上级 f18ae9f2
......@@ -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\>\): void](#zh-cn_topic_0000001150092213_section570630172512)
- [write(eventName: string, eventType: EventType, keyValues: object): Promise<void\>](#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)
## 导入模块<a name="zh-cn_topic_0000001150092213_s56d19203690d4782bfc74069abb6bd71"></a>
......@@ -18,9 +20,9 @@ import hiAppEvent from '@ohos.hiAppEvent';
## 方法<a name="zh-cn_topic_0000001150092213_section125675489541"></a>
## hiAppEvent.write<a name="zh-cn_topic_0000001150092213_section570630172512"></a>
## write(eventName: string, eventType: EventType, keyValues: object, callback: AsyncCallback<void\>\): void<a name="zh-cn_topic_0000001150092213_section570630172512"></a>
write(eventName: string, eventType: EventType, keyValues: object, callback: AsyncCallback<void\>\): void
应用事件打点,将事件信息写入到当天的事件文件中,可接收类型为JSON对象的事件参数,使用callback方式作为异步方法。
......@@ -55,7 +57,7 @@ import hiAppEvent from '@ohos.hiAppEvent';
<td class="cellrowborder" valign="top" width="64.41%" headers="mcps1.1.5.1.4 "><p id="zh-cn_topic_0000001150092213_p754216544454"><a name="zh-cn_topic_0000001150092213_p754216544454"></a><a name="zh-cn_topic_0000001150092213_p754216544454"></a>应用事件类型。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001150092213_row354265418456"><td class="cellrowborder" valign="top" width="13.969999999999999%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001150092213_p1354215547452"><a name="zh-cn_topic_0000001150092213_p1354215547452"></a><a name="zh-cn_topic_0000001150092213_p1354215547452"></a>jsonParam</p>
<tr id="zh-cn_topic_0000001150092213_row354265418456"><td class="cellrowborder" valign="top" width="13.969999999999999%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001150092213_p1354215547452"><a name="zh-cn_topic_0000001150092213_p1354215547452"></a><a name="zh-cn_topic_0000001150092213_p1354215547452"></a>keyValues</p>
</td>
<td class="cellrowborder" valign="top" width="13.389999999999999%" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001150092213_p754225416456"><a name="zh-cn_topic_0000001150092213_p754225416456"></a><a name="zh-cn_topic_0000001150092213_p754225416456"></a>object</p>
</td>
......@@ -77,7 +79,6 @@ import hiAppEvent from '@ohos.hiAppEvent';
</tbody>
</table>
**示例:**
```
......@@ -93,7 +94,9 @@ hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str
});
```
## write(eventName: string, eventType: EventType, keyValues: object): Promise<void\><a name="zh-cn_topic_0000001150092213_section0857164934517"></a>
## hiAppEvent.write<a name="zh-cn_topic_0000001150092213_section0857164934517"></a>
write(eventName: string, eventType: EventType, keyValues: object): Promise<void\>
应用事件打点,将事件信息写入到当天的事件文件中,可接收类型为JSON对象的事件参数,使用promise方式作为异步方法。
......@@ -129,7 +132,7 @@ hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str
<td class="cellrowborder" valign="top" width="64.41%" headers="mcps1.1.5.1.4 "><p id="zh-cn_topic_0000001150092213_p198581349194515"><a name="zh-cn_topic_0000001150092213_p198581349194515"></a><a name="zh-cn_topic_0000001150092213_p198581349194515"></a>应用事件类型。</p>
</td>
</tr>
<tr id="zh-cn_topic_0000001150092213_row78580497453"><td class="cellrowborder" valign="top" width="13.969999999999999%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001150092213_p2085819494459"><a name="zh-cn_topic_0000001150092213_p2085819494459"></a><a name="zh-cn_topic_0000001150092213_p2085819494459"></a>jsonParam</p>
<tr id="zh-cn_topic_0000001150092213_row78580497453"><td class="cellrowborder" valign="top" width="13.969999999999999%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001150092213_p2085819494459"><a name="zh-cn_topic_0000001150092213_p2085819494459"></a><a name="zh-cn_topic_0000001150092213_p2085819494459"></a>keyValues</p>
</td>
<td class="cellrowborder" valign="top" width="13.389999999999999%" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001150092213_p8859749154519"><a name="zh-cn_topic_0000001150092213_p8859749154519"></a><a name="zh-cn_topic_0000001150092213_p8859749154519"></a>object</p>
</td>
......@@ -141,6 +144,7 @@ hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str
</tbody>
</table>
**返回值:**
<a name="zh-cn_topic_0000001150092213_table10811610134713"></a>
......@@ -172,7 +176,46 @@ hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str
});
```
## 枚举<a name="zh-cn_topic_0000001150092213_section1978842154715"></a>
## 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<a name="zh-cn_topic_0000001150092213_section099619567453"></a>
......@@ -217,3 +260,26 @@ hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str
</tr>
</tbody>
</table>
## 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。 |
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册