From f18ae9f28326457f90e143b78ea14e5df0f58e9e Mon Sep 17 00:00:00 2001 From: lyj_love_code Date: Fri, 17 Sep 2021 17:52:02 +0800 Subject: [PATCH 1/3] change HiAppEvent.md Signed-off-by: lyj_love_code --- ...24\347\224\250\346\211\223\347\202\271.md" | 179 ++---------------- 1 file changed, 15 insertions(+), 164 deletions(-) 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 08258f16922..782ebf384fe 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" @@ -3,17 +3,15 @@ - [导入模块](#zh-cn_topic_0000001150092213_s56d19203690d4782bfc74069abb6bd71) - [权限](#zh-cn_topic_0000001150092213_section11257113618419) - [方法](#zh-cn_topic_0000001150092213_section125675489541) -- [write\(string, EventType, any..., AsyncCallback\)](#zh-cn_topic_0000001150092213_section192192415554) -- [write\(string, EventType, any...\)](#zh-cn_topic_0000001150092213_section1696563334210) -- [writeJson\(string, EventType, object, AsyncCallback\)](#zh-cn_topic_0000001150092213_section570630172512) -- [writeJson\(string, EventType, object\)](#zh-cn_topic_0000001150092213_section0857164934517) +- [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) - [EventType](#zh-cn_topic_0000001150092213_section099619567453) ## 导入模块 ``` -import hiappevent from '@ohos.hiappevent'; +import hiAppEvent from '@ohos.hiAppEvent'; ``` ## 权限 @@ -22,156 +20,7 @@ import hiappevent from '@ohos.hiappevent'; ## 方法 -## write\(string, EventType, any..., AsyncCallback\) - -应用事件打点，将事件信息写入到当天的事件文件中，可接收类型为不定参数的事件参数，使用callback方式作为异步方法。 - -**参数：** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

eventName

-

string

-

是

-

应用事件名称。

-

eventType

-

EventType

-

是

-

应用事件类型。

-

params

-

any...

-

否

-

应用事件的参数，按顺序输入事件的参数名与参数值。参数名的类型只能为string类型，参数值的类型只能为string、number、boolean、Array（数组数据类型只能为string、number、boolean）。

-

callback

-

AsyncCallback<number>

-

否

-

回调函数，可以在回调函数中处理接口返回值。

-
  • 返回值为0表示事件参数校验成功，事件正常异步写入事件文件；
  • 大于0表示事件存在异常参数，事件在忽略异常参数后再异步写入事件文件；
  • 小于0表示事件校验失败，不执行事件异步打点操作。
-
- -**示例：** - -``` -hiappevent.write("testEvent", hiappevent.EventType.FAULT, "intData", 100, "strData", "strValue", (err, value) => { - if (err) { - // 事件写入异常：事件存在异常参数或者事件校验失败不执行写入 - console.error(`failed to write event because ${err}`); - return; - } - - // 事件写入正常 - console.log(`success to write event: ${value}`); -}); -``` - -## write\(string, EventType, any...\) - -应用事件打点，将事件信息写入到当天的事件文件中，可接收类型为不定参数的事件参数，使用promise方式作为异步方法。 - -**参数：** - - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

eventName

-

string

-

是

-

应用事件名称。

-

eventType

-

EventType

-

是

-

应用事件类型。

-

params

-

any...

-

否

-

应用事件的参数，按顺序输入事件的参数名与参数值。参数名的类型只能为string类型，参数值的类型只能为string、number、boolean、Array（数组数据类型只能为string、number、boolean）。

-
- -**返回值：** - - - - - - - - - - -

类型

-

说明

-

Promise<void>

-

Promise函数

-
- -**示例：** - -``` -hiappevent.write("testEvent", hiappevent.EventType.FAULT, "intData", 100, "strData", "strValue") - .then((value) => { - // 事件写入正常 - console.log(`success to write event: ${value}`); - }).catch((err) => { - // 事件写入异常：事件存在异常参数或者事件校验失败不执行写入 - console.error(`failed to write event because ${err}`); - }); -``` - -## writeJson\(string, EventType, object, AsyncCallback\) +## write(eventName: string, eventType: EventType, keyValues: object, callback: AsyncCallback\): void 应用事件打点，将事件信息写入到当天的事件文件中，可接收类型为JSON对象的事件参数，使用callback方式作为异步方法。 @@ -217,24 +66,25 @@ hiappevent.write("testEvent", hiappevent.EventType.FAULT, "intData", 100, "strDa

callback

-

AsyncCallback<number>

+

AsyncCallback<void>

否

回调函数，可以在回调函数中处理接口返回值。

-
  • 返回值为0表示事件参数校验成功，事件正常异步写入事件文件；
  • 大于0表示事件存在异常参数，事件在忽略异常参数后再异步写入事件文件；
  • 小于0表示事件校验失败，不执行事件异步打点操作。
+
  • 返回值为0表示事件参数校验成功，事件正常异步写入事件文件；
  • 大于0表示事件校验存在异常参数，事件在忽略异常参数后将事件异步写入事件文件；
  • 小于0表示事件校验失败，不将事件写入事件文件。
+ **示例：** ``` -hiappevent.writeJson("testEvent", hiappevent.EventType.FAULT, {"intData":100, "strData":"strValue"}, (err, value) => { +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}`); + console.error(`failed to write event because ${err.code}`); return; } @@ -243,13 +93,14 @@ hiappevent.writeJson("testEvent", hiappevent.EventType.FAULT, {"intData":100, "s }); ``` -## writeJson\(string, EventType, object\) +## write(eventName: string, eventType: EventType, keyValues: object): Promise 应用事件打点，将事件信息写入到当天的事件文件中，可接收类型为JSON对象的事件参数，使用promise方式作为异步方法。 **参数：** + -

参数名

类型

@@ -301,22 +152,23 @@ hiappevent.writeJson("testEvent", hiappevent.EventType.FAULT, {"intData":100, "s

Promise<void>

Promise函数

+

Promise实例，可以在其then()、catch()方法中分别对事件写入成功、写入异常的情况进行回调处理。
+ **示例：** ``` -hiappevent.writeJson("testEvent", hiappevent.EventType.FAULT, {"intData":100, "strData":"strValue"}) +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}`); + console.error(`failed to write event because ${err.code}`); }); ``` @@ -365,4 +217,3 @@ hiappevent.writeJson("testEvent", hiappevent.EventType.FAULT, {"intData":100, "s - -- Gitee From 9eb0629990931b93f7dc52dbaffb33b6795f0710 Mon Sep 17 00:00:00 2001 From: lyj_love_code Date: Sat, 18 Sep 2021 17:47:43 +0800 Subject: [PATCH 2/3] add content to HiAppEvent doc Signed-off-by: lyj_love_code --- ...24\347\224\250\346\211\223\347\202\271.md" | 88 ++++++++++++++++--- 1 file changed, 77 insertions(+), 11 deletions(-) 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 782ebf384fe..52630f59034 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。 | -- Gitee From 580d8c561e532222d51d626a9502bb5d4421ee8e Mon Sep 17 00:00:00 2001 From: lyj_love_code Date: Wed, 22 Sep 2021 10:34:38 +0800 Subject: [PATCH 3/3] fix the content of HiAppEvent doc Signed-off-by: lyj_love_code --- .../\345\272\224\347\224\250\346\211\223\347\202\271.md" | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 52630f59034..430945d7b11 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" @@ -144,7 +144,6 @@ write(eventName: string, eventType: EventType, keyValues: object): Promise - **返回值：** @@ -260,6 +259,7 @@ hiAppEvent.configure({ + ## Event 此接口提供了所有预定义事件的事件名称常量。 -- Gitee