Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
ac4839e7
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
ac4839e7
编写于
3月 21, 2022
作者:
Z
zengyawen
提交者:
Gitee
3月 21, 2022
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update zh-cn/application-dev/reference/apis/js-apis-hiappevent.md.
Signed-off-by:
N
zengyawen
<
zengyawen1@huawei.com
>
上级
7bf3f575
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
38 addition
and
38 deletion
+38
-38
zh-cn/application-dev/reference/apis/js-apis-hiappevent.md
zh-cn/application-dev/reference/apis/js-apis-hiappevent.md
+38
-38
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-hiappevent.md
浏览文件 @
ac4839e7
...
@@ -21,12 +21,12 @@ write(eventName: string, eventType: EventType, keyValues: object, callback: Asyn
...
@@ -21,12 +21,12 @@ write(eventName: string, eventType: EventType, keyValues: object, callback: Asyn
**参数:**
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| 参数名
| 类型 | 必填 | 说明
|
| --------
| -------- | -------- |
-------- |
| --------
- | ------------------------- | ---- | ----------------------------------------------------
-------- |
| eventName | string
| 是 | 应用事件名称
。 |
| eventName | string
| 是 | 应用事件名称。
<br/>
由开发者自定义。事件名称在48个字符以内,有效的字符是0-9、a-z、下划线,只能以字母开头
。 |
| eventType |
[
EventType
](
#eventtype
)
| 是 | 应用事件类型。
|
| eventType |
[
EventType
](
#eventtype
)
| 是 | 应用事件类型。
|
| keyValues | object
| 是 | 应用事件的参数,key类型只能为string,value类型只能为string、number、boolean、Array(数组数据类型只能为string、number、boolean)
。 |
| 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
<
void
>
| 否
| 回调函数,可以在回调函数中处理接口返回值。
<br/>
-
返回值为0表示事件校验成功,事件正常异步写入事件文件;
<br/>
-
大于0表示事件校验存在异常参数,在忽略异常参数后将事件异步写入事件文件;
<br/>
-
小于0表示事件校验失败,不将事件写入事件文件。 |
| callback
| AsyncCallback
<
void
>
| 否
| 回调函数,可以在回调函数中处理接口返回值。
<br/>
-
返回值为0表示事件校验成功,事件正常异步写入事件文件;
<br/>
-
大于0表示事件校验存在异常参数,在忽略异常参数后将事件异步写入事件文件;
<br/>
-
小于0表示事件校验失败,不将事件写入事件文件。 |
**示例:**
**示例:**
...
@@ -54,16 +54,16 @@ write(eventName: string, eventType: EventType, keyValues: object): Promise<vo
...
@@ -54,16 +54,16 @@ write(eventName: string, eventType: EventType, keyValues: object): Promise<vo
**参数:**
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| 参数名
| 类型 | 必填 | 说明
|
| --------
| -------- | -------- |
-------- |
| --------
- | ----------------------- | ---- | ----------------------------------------------------
-------- |
| eventName | string
| 是 | 应用事件名称
。 |
| eventName | string
| 是 | 应用事件名称。
<br/>
由开发者自定义。事件名称在48个字符以内,有效的字符是0-9、a-z、下划线,只能以字母开头
。 |
| eventType |
[
EventType
](
#eventtype
)
| 是
| 应用事件类型。
|
| eventType |
[
EventType
](
#eventtype
)
| 是
| 应用事件类型。
|
| keyValues | object
| 是 | 应用事件的参数,key类型只能为string,value类型只能为string、number、boolean、Array(数组数据类型只能为string、number、boolean)
。 |
| 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
<
void
>
| Promise实例,可以在其then()、catch()方法中分别对事件写入成功、写入异常的情况进行回调处理。 |
| Promise
<
void
>
| Promise实例,可以在其then()、catch()方法中分别对事件写入成功、写入异常的情况进行回调处理。 |
**示例:**
**示例:**
...
@@ -90,14 +90,14 @@ configure(config: ConfigOption): boolean
...
@@ -90,14 +90,14 @@ configure(config: ConfigOption): boolean
**参数:**
**参数:**
| 参数名 | 类型
| 必填 | 说明
|
| 参数名 | 类型
| 必填 | 说明
|
| ------
-- | -------- | -------- |
-------- |
| ------
| ----------------------------- | ---- | ----------------
-------- |
| config |
[
ConfigOption
](
#configoption
)
| 是 | 应用事件打点配置项对象。 |
| config |
[
ConfigOption
](
#configoption
)
| 是
| 应用事件打点配置项对象。 |
**返回值:**
**返回值:**
| 类型
| 说明
|
| 类型
| 说明
|
| -------
- |
-------- |
| -------
| ---------------------------------------------------
-------- |
| boolean | 配置结果,true
表示配置成功,false
表示配置失败。 |
| boolean | 配置结果,true
表示配置成功,false
表示配置失败。 |
**示例:**
**示例:**
...
@@ -120,10 +120,10 @@ hiAppEvent.configure({
...
@@ -120,10 +120,10 @@ hiAppEvent.configure({
**系统能力:**
以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。
| 参数名
| 类型 | 必填 | 说明
|
| 参数名
| 类型 | 必填 | 说明
|
| --------
| -------- | -------- |
-------- |
| --------
-- | ------- | ---- | ----------------------------------------------------
-------- |
| disable
| boolean | 否
| 应用打点功能开关。配置值为true表示关闭打点功能,false表示不关闭打点功能。 |
| disable
| boolean | 否
| 应用打点功能开关。配置值为true表示关闭打点功能,false表示不关闭打点功能。 |
| maxStorage | string
| 否
| 打点数据本地存储文件所在目录的配额大小,默认限额为“10M”。所在目录大小超出限额后会对目录进行清理操作,会按从旧到新的顺序逐个删除打点数据文件,直到目录大小不超出限额时停止。 |
| maxStorage | string
| 否
| 打点数据本地存储文件所在目录的配额大小,默认限额为“10M”。所在目录大小超出限额后会对目录进行清理操作,会按从旧到新的顺序逐个删除打点数据文件,直到目录大小不超出限额时停止。 |
## EventType
## EventType
...
@@ -132,12 +132,12 @@ hiAppEvent.configure({
...
@@ -132,12 +132,12 @@ hiAppEvent.configure({
**系统能力:**
以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。
| 名称
| 默认值 | 说明
|
| 名称
| 默认值 | 说明
|
| --------
| -------- |
-------- |
| --------
- | ------ | ------
-------- |
| FAULT
| 1
| 故障类型事件。 |
| FAULT
| 1
| 故障类型事件。 |
| STATISTIC | 2 | 统计类型事件。 |
| STATISTIC | 2
| 统计类型事件。 |
| SECURITY
| 3
| 安全类型事件。 |
| SECURITY
| 3
| 安全类型事件。 |
| BEHAVIOR
| 4
| 行为类型事件。 |
| BEHAVIOR
| 4
| 行为类型事件。 |
## Event
## Event
...
@@ -146,11 +146,11 @@ hiAppEvent.configure({
...
@@ -146,11 +146,11 @@ hiAppEvent.configure({
**系统能力:**
以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | -------- |
-------- |
| --------
----------------- | -------- | ---- | ---- | ------------
-------- |
| USER_LOGIN
| string | 是 | 否 | 用户登录事件。
|
| USER_LOGIN
| string | 是 | 否 | 用户登录事件。
|
| USER_LOGOUT
| string | 是 | 否 | 用户登出事件。
|
| USER_LOGOUT
| string | 是 | 否 | 用户登出事件。
|
| DISTRIBUTED_SERVICE_START | string
| 是 | 否
| 分布式服务启动事件。 |
| DISTRIBUTED_SERVICE_START | string
| 是 | 否
| 分布式服务启动事件。 |
## Param
## Param
...
@@ -159,8 +159,8 @@ hiAppEvent.configure({
...
@@ -159,8 +159,8 @@ hiAppEvent.configure({
**系统能力:**
以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | -------- |
-------- |
| --------
----------------------- | -------- | ---- | ---- | ----------
-------- |
| USER_ID
| string | 是 | 否 | 用户自定义ID。
|
| USER_ID
| string | 是 | 否 | 用户自定义ID。
|
| DISTRIBUTED_SERVICE_NAME
| string | 是 | 否 | 分布式服务名称。
|
| DISTRIBUTED_SERVICE_NAME
| string | 是 | 否 | 分布式服务名称。
|
| DISTRIBUTED_SERVICE_INSTANCE_ID | string
| 是 | 否
| 分布式服务实例ID。 |
| DISTRIBUTED_SERVICE_INSTANCE_ID | string
| 是 | 否
| 分布式服务实例ID。 |
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录