From ec08842c946f98b81ee342e5e79787cc896f1f9d Mon Sep 17 00:00:00 2001 From: lyj_love_code Date: Tue, 14 Mar 2023 15:56:48 +0800 Subject: [PATCH] add specifications to hiappevent doc Signed-off-by: lyj_love_code --- .../reference/apis/js-apis-hiappevent.md | 7 ++++--- .../reference/apis/js-apis-hiviewdfx-hiappevent.md | 12 ++++++------ .../reference/errorcodes/errorcode-hiappevent.md | 2 ++ 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-hiappevent.md b/zh-cn/application-dev/reference/apis/js-apis-hiappevent.md index 394a61c58f..5887ffaecd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-hiappevent.md +++ b/zh-cn/application-dev/reference/apis/js-apis-hiappevent.md @@ -31,9 +31,10 @@ import hiAppEvent from '@ohos.hiAppEvent'; 事件参数为object类型，key为事件的参数名称，value为事件的参数值，其规格定义如下： - 参数名为string类型，字符串非空且长度在16个字符以内，有效的字符是0-9、a-z、下划线，只能以小写字母开头，不能以下划线结尾； -- 参数值支持string、number、boolean、Array类型； -- 参数值为string类型时，其长度需在8*1024个字符以内，超出会做截断处理； -- 参数值为Array类型时，Array中的元素类型只能全为string、number、boolean中的一种，且元素个数需在100以内，超出会做丢弃处理； +- 参数值支持string、number、boolean、数组类型； +- 参数值为string类型时，其长度需在8*1024个字符以内，超出会做丢弃处理； +- 参数值为number类型时，其取值需在Number.MIN_SAFE_INTEGER~Number.MAX_SAFE_INTEGER范围内，超出可能会产生不确定值； +- 参数值为数组类型时，数组中的元素类型只能全为string、number、boolean中的一种，且元素个数需在100以内，超出会做丢弃处理； - 参数个数需在32以内，超出的参数会做丢弃处理。 **事件回调** diff --git a/zh-cn/application-dev/reference/apis/js-apis-hiviewdfx-hiappevent.md b/zh-cn/application-dev/reference/apis/js-apis-hiviewdfx-hiappevent.md index f8ce582776..2c41ccc039 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-hiviewdfx-hiappevent.md +++ b/zh-cn/application-dev/reference/apis/js-apis-hiviewdfx-hiappevent.md @@ -120,12 +120,12 @@ hiAppEvent.write({ **系统能力：** SystemCapability.HiviewDFX.HiAppEvent -| 名称 | 类型 | 必填 | 说明 | -| --------- | ----------------------- | ---- | ---------- | -| domain | string | 是 | 事件领域。 | -| name | string | 是 | 事件名称。 | -| eventType | [EventType](#eventtype) | 是 | 事件类型。 | -| params | object | 是 | 事件参数。 | +| 名称 | 类型 | 必填 | 说明 | +| --------- | ----------------------- | ---- | ------------------------------------------------------------ | +| domain | string | 是 | 事件领域。事件领域名称支持数字、小写字母、下划线字符，需要以小写字母开头且不能以下划线结尾，长度非空且不超过32个字符。 | +| name | string | 是 | 事件名称。事件名称支持数字、小写字母、下划线字符，需要以小写字母开头且不能以下划线结尾，长度非空且不超过48个字符。 | +| eventType | [EventType](#eventtype) | 是 | 事件类型。 | +| params | object | 是 | 事件参数对象，每个事件参数包括参数名和参数值，其规格定义如下：
- 参数名为string类型，只支持数字、小写字母、下划线字符，需要以小写字母开头且不能以下划线结尾，长度非空且不超过16个字符。
- 参数值支持string、number、boolean、数组类型，string类型参数长度需在8*1024个字符以内，超出会做丢弃处理；number类型参数取值需在Number.MIN_SAFE_INTEGER~Number.MAX_SAFE_INTEGER范围内，超出可能会产生不确定值；数组类型参数中的元素类型只能全为string、number、boolean中的一种，且元素个数需在100以内，超出会做丢弃处理。
- 参数个数需在32个以内，超出的参数会做丢弃处理。 | ## hiAppEvent.configure diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-hiappevent.md b/zh-cn/application-dev/reference/errorcodes/errorcode-hiappevent.md index 5166f78088..1e607fb627 100644 --- a/zh-cn/application-dev/reference/errorcodes/errorcode-hiappevent.md +++ b/zh-cn/application-dev/reference/errorcodes/errorcode-hiappevent.md @@ -15,6 +15,7 @@ Function is disabled. 应用事件打点功能被关闭了。 **处理步骤** + 调用配置接口开启打点功能。 ```js @@ -41,6 +42,7 @@ Invalid event domain. - 事件领域名称非空且长度不超过32个字符。 **处理步骤** + 传入合法的事件领域名称。 ## 11101002 非法的事件名称 -- GitLab