提交 11c80c82 编写于 作者: L lyj_love_code

feat: change the event name and event param verification specification

Signed-off-by: Nlyj_love_code <liangyujian2@huawei.com>
上级 e2c0abd4
......@@ -20,7 +20,7 @@ import hiAppEvent from '@ohos.hiAppEvent';
**事件名称**
事件名称为string类型,字符串非空且长度在48个字符以内,有效的字符是0-9、a-z、下划线,只能以小写字母开头,不能以下划线结尾。
事件名称为string类型,字符串非空且长度在48个字符以内,有效的字符是数字字符、字母字符、下划线字符,只能以字母字符或$字符开头,不能以下划线字符结尾。
**事件类型**
......@@ -30,7 +30,7 @@ import hiAppEvent from '@ohos.hiAppEvent';
事件参数为object类型,key为事件的参数名称,value为事件的参数值,其规格定义如下:
- 参数名为string类型,字符串非空且长度在16个字符以内,有效的字符是0-9、a-z、下划线,只能以小写字母开头,不能以下划线结尾;
- 参数名为string类型,字符串非空且长度在16个字符以内,有效的字符是数字字符、字母字符、下划线字符,只能以字母字符或$字符开头,不能以下划线字符结尾;
- 参数值支持string、number、boolean、数组类型;
- 参数值为string类型时,其长度需在8*1024个字符以内,超出会做丢弃处理;
- 参数值为number类型时,其取值需在Number.MIN_SAFE_INTEGER~Number.MAX_SAFE_INTEGER范围内,超出可能会产生不确定值;
......
......@@ -123,9 +123,9 @@ hiAppEvent.write({
| 名称 | 类型 | 必填 | 说明 |
| --------- | ----------------------- | ---- | ------------------------------------------------------------ |
| domain | string | 是 | 事件领域。事件领域名称支持数字、小写字母、下划线字符,需要以小写字母开头且不能以下划线结尾,长度非空且不超过32个字符。 |
| name | string | 是 | 事件名称。事件名称支持数字、小写字母、下划线字符,需要以小写字母开头且不能以下划线结尾,长度非空且不超过48个字符。 |
| name | string | 是 | 事件名称。事件名称支持数字字符、字母字符、下划线字符,需要以字母字符或$字符开头且不能以下划线字符结尾,长度非空且不超过48个字符。 |
| eventType | [EventType](#eventtype) | 是 | 事件类型。 |
| params | object | 是 | 事件参数对象,每个事件参数包括参数名和参数值,其规格定义如下:<br>- 参数名为string类型,只支持数字、小写字母、下划线字符,需要以小写字母开头且不能以下划线结尾,长度非空且不超过16个字符。<br>- 参数值支持string、number、boolean、数组类型,string类型参数长度需在8*1024个字符以内,超出会做丢弃处理;number类型参数取值需在Number.MIN_SAFE_INTEGER~Number.MAX_SAFE_INTEGER范围内,超出可能会产生不确定值;数组类型参数中的元素类型只能全为string、number、boolean中的一种,且元素个数需在100以内,超出会做丢弃处理。<br>- 参数个数需在32个以内,超出的参数会做丢弃处理。 |
| params | object | 是 | 事件参数对象,每个事件参数包括参数名和参数值,其规格定义如下:<br>- 参数名为string类型,只支持数字字符、字母字符、下划线字符,需要以字母字符或$字符开头且不能以下划线字符结尾,长度非空且不超过16个字符。<br>- 参数值支持string、number、boolean、数组类型,string类型参数长度需在8*1024个字符以内,超出会做丢弃处理;number类型参数取值需在Number.MIN_SAFE_INTEGER~Number.MAX_SAFE_INTEGER范围内,超出可能会产生不确定值;数组类型参数中的元素类型只能全为string、number、boolean中的一种,且元素个数需在100以内,超出会做丢弃处理。<br>- 参数个数需在32个以内,超出的参数会做丢弃处理。 |
## hiAppEvent.configure
......
......@@ -63,8 +63,8 @@ Invalid event name.
传入的事件名称不符合以下规则:
- 事件名称只包含数字、小写字母、下划线字符。
- 事件名称以小写字母开头,不以下划线结尾。
- 事件名称只包含数字字符、字母字符、下划线字符。
- 事件名称以字母字符或$字符开头,不以下划线字符结尾。
- 事件名称非空且长度不超过48个字符。
**处理步骤**
......@@ -121,8 +121,8 @@ Invalid event parameter name.
传入的事件名称不符合以下规则:
- 事件名称只包含数字、小写字母、下划线字符。
- 事件名称以小写字母开头,不以下划线结尾。
- 事件名称只包含数字字符、字母字符、下划线字符。
- 事件名称以字母字符或$字符开头,不以下划线字符结尾。
- 事件名称非空且长度不超过16个字符。
**处理步骤**
......
# DFX子系统ChangeLog
## cl.hiviewdfx.1 HiAppEvent模块write接口事件校验规格变更
应用打点功能由于需要支持Analytics预埋点事件接入,需要对打点接口支持的事件规格做拓展,现做出如下变更:
- 事件名称由支持[小写字母|数字|下划线],变更为支持[$字符开头|大小写字母|数字|下划线]。
- 事件参数名称由支持[小写字母|数字|下划线],变更为支持[$字符开头|大小写字母|数字|下划线]。
**变更影响**
打点接口支持的事件定义格式更丰富。
**关键的接口/组件变更**
涉及接口
- hiAppEvent.write;
**适配指导**
兼容原有规格,无需额外适配。
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册