Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
12972b66
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看板
未验证
提交
12972b66
编写于
11月 26, 2022
作者:
O
openharmony_ci
提交者:
Gitee
11月 26, 2022
浏览文件
操作
浏览文件
下载
差异文件
!11842 HiAppEvent接口参数描述错误修复
Merge pull request !11842 from lyj/master
上级
c86e2f6e
9d346295
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
49 addition
and
49 deletion
+49
-49
zh-cn/application-dev/reference/apis/js-apis-hiappevent.md
zh-cn/application-dev/reference/apis/js-apis-hiappevent.md
+18
-18
zh-cn/application-dev/reference/apis/js-apis-hiviewdfx-hiappevent.md
...cation-dev/reference/apis/js-apis-hiviewdfx-hiappevent.md
+31
-31
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-hiappevent.md
浏览文件 @
12972b66
...
...
@@ -58,7 +58,7 @@ write(eventName: string, eventType: EventType, keyValues: object, callback: Asyn
| eventName | string | 是 | 事件名称。 |
| eventType |
[
EventType
](
#eventtype
)
| 是 | 事件类型。 |
| keyValues | object | 是 | 事件参数。 |
| callback | AsyncCallback
<
void
>
|
否
| 事件回调函数。 |
| callback | AsyncCallback
<
void
>
|
是
| 事件回调函数。 |
**示例:**
...
...
@@ -151,7 +151,7 @@ hiAppEvent.configure({
**系统能力:**
SystemCapability.HiviewDFX.HiAppEvent
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ------------------------------------------------------------ |
| disable | boolean | 否 | 应用打点功能开关。配置值为true表示关闭打点功能,false表示不关闭打点功能。 |
| maxStorage | string | 否 | 打点数据本地存储文件所在目录的配额大小,默认限额为“10M”。所在目录大小超出限额后会对目录进行清理操作,会按从旧到新的顺序逐个删除打点数据文件,直到目录大小不超出限额时停止。 |
...
...
@@ -163,12 +163,12 @@ hiAppEvent.configure({
**系统能力:**
SystemCapability.HiviewDFX.HiAppEvent
| 名称 |
默认值
| 说明 |
| --------- | ----
--
| -------------- |
| FAULT | 1
| 故障类型事件。 |
| STATISTIC | 2
| 统计类型事件。 |
| SECURITY | 3
| 安全类型事件。 |
| BEHAVIOR | 4
| 行为类型事件。 |
| 名称 |
值
| 说明 |
| --------- | ---- | -------------- |
| FAULT | 1 | 故障类型事件。 |
| STATISTIC | 2 | 统计类型事件。 |
| SECURITY | 3 | 安全类型事件。 |
| BEHAVIOR | 4 | 行为类型事件。 |
## Event
...
...
@@ -177,11 +177,11 @@ hiAppEvent.configure({
**系统能力:**
SystemCapability.HiviewDFX.HiAppEvent
| 名称 |
参数类型
| 可读 | 可写 | 说明 |
| ------------------------- | ------
--
| ---- | ---- | -------------------- |
| USER_LOGIN | string
| 是 | 否 | 用户登录事件。 |
| USER_LOGOUT | string
| 是 | 否 | 用户登出事件。 |
| DISTRIBUTED_SERVICE_START | string
| 是 | 否 | 分布式服务启动事件。 |
| 名称 |
类型
| 可读 | 可写 | 说明 |
| ------------------------- | ------ | ---- | ---- | -------------------- |
| USER_LOGIN | string | 是 | 否 | 用户登录事件。 |
| USER_LOGOUT | string | 是 | 否 | 用户登出事件。 |
| DISTRIBUTED_SERVICE_START | string | 是 | 否 | 分布式服务启动事件。 |
## Param
...
...
@@ -190,8 +190,8 @@ hiAppEvent.configure({
**系统能力:**
SystemCapability.HiviewDFX.HiAppEvent
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------------------------------- | -------- | ---- | ---- | ------------------ |
| USER_ID | string | 是 | 否 | 用户自定义ID。 |
| DISTRIBUTED_SERVICE_NAME | string | 是 | 否 | 分布式服务名称。 |
| DISTRIBUTED_SERVICE_INSTANCE_ID | string | 是 | 否 | 分布式服务实例ID。 |
\ No newline at end of file
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------------------- | ------ | ---- | ---- | ------------------ |
| USER_ID | string | 是 | 否 | 用户自定义ID。 |
| DISTRIBUTED_SERVICE_NAME | string | 是 | 否 | 分布式服务名称。 |
| DISTRIBUTED_SERVICE_INSTANCE_ID | string | 是 | 否 | 分布式服务实例ID。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-hiviewdfx-hiappevent.md
浏览文件 @
12972b66
...
...
@@ -119,7 +119,7 @@ hiAppEvent.write({
**系统能力:**
SystemCapability.HiviewDFX.HiAppEvent
| 名称 |
参数类型
| 必填 | 说明 |
| 名称 |
类型
| 必填 | 说明 |
| --------- | ----------------------- | ---- | ---------- |
| domain | string | 是 | 事件领域。 |
| name | string | 是 | 事件名称。 |
...
...
@@ -168,7 +168,7 @@ hiAppEvent.configure({
**系统能力:**
SystemCapability.HiviewDFX.HiAppEvent
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ------------------------------------------------------------ |
| disable | boolean | 否 | 打点功能开关,默认值为false。true:关闭打点功能,false:不关闭打点功能。 |
| maxStorage | string | 否 | 打点数据存放目录的配额大小,默认值为“10M”。
<br>
在目录大小超出配额后,下次打点会触发对目录的清理操作:按从旧到新的顺序逐个删除打点数据文件,直到目录大小不超出配额时结束。 |
...
...
@@ -299,7 +299,7 @@ hiAppEvent.removeWatcher(watcher);
**系统能力:**
SystemCapability.HiviewDFX.HiAppEvent
| 名称 |
参数类型
| 必填 | 说明 |
| 名称 |
类型
| 必填 | 说明 |
| ---------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| name | string | 是 | 观察者名称,用于唯一标识观察者。 |
| triggerCondition |
[
TriggerCondition
](
#triggercondition
)
| 否 | 订阅回调触发条件,需要与回调函数一同传入才会生效。 |
...
...
@@ -312,11 +312,11 @@ hiAppEvent.removeWatcher(watcher);
**系统能力:**
SystemCapability.HiviewDFX.HiAppEvent
| 名称 |
参数类型
| 必填 | 说明 |
| ------- | ------
--
| ---- | -------------------------------------- |
| row | number
| 否 | 满足触发回调的事件总数量。 |
| size | number
| 否 | 满足触发回调的事件总大小,单位为byte。 |
| timeOut | number
| 否 | 满足触发回调的超时时长,单位为30s。 |
| 名称 |
类型
| 必填 | 说明 |
| ------- | ------ | ---- | -------------------------------------- |
| row | number | 否 | 满足触发回调的事件总数量。 |
| size | number | 否 | 满足触发回调的事件总大小,单位为byte。 |
| timeOut | number | 否 | 满足触发回调的超时时长,单位为30s。 |
## AppEventFilter
...
...
@@ -324,7 +324,7 @@ hiAppEvent.removeWatcher(watcher);
**系统能力:**
SystemCapability.HiviewDFX.HiAppEvent
| 名称 |
参数类型
| 必填 | 说明 |
| 名称 |
类型
| 必填 | 说明 |
| ---------- | ------------------------- | ---- | ------------------------ |
| domain | string | 是 | 需要订阅的事件领域。 |
| eventTypes |
[
EventType
](
#eventtype
)[]
| 否 | 需要订阅的事件类型集合。 |
...
...
@@ -411,12 +411,12 @@ let eventPkg = holder.takeNext();
**系统能力:**
SystemCapability.HiviewDFX.HiAppEvent
| 名称 |
参数类型
| 说明 |
| --------- | -------- | ------------------------------ |
| packageId | number | 事件包ID,从0开始自动递增。 |
| row | number | 事件包的事件数量。 |
| size | number | 事件包的事件大小,单位为byte。 |
| data | string[] | 事件包的事件信息。 |
| 名称 |
类型 | 必填
| 说明 |
| --------- | -------- | ----
| ----
-------------------------- |
| packageId | number |
是 |
事件包ID,从0开始自动递增。 |
| row | number |
是 |
事件包的事件数量。 |
| size | number |
是 |
事件包的事件大小,单位为byte。 |
| data | string[] |
是 |
事件包的事件信息。 |
## hiAppEvent.clearData
...
...
@@ -439,12 +439,12 @@ hiAppEvent.clearData();
**系统能力:**
SystemCapability.HiviewDFX.HiAppEvent
| 名称 |
默认值
| 说明 |
| --------- | ----
--
| -------------- |
| FAULT | 1
| 故障类型事件。 |
| STATISTIC | 2
| 统计类型事件。 |
| SECURITY | 3
| 安全类型事件。 |
| BEHAVIOR | 4
| 行为类型事件。 |
| 名称 |
值
| 说明 |
| --------- | ---- | -------------- |
| FAULT | 1 | 故障类型事件。 |
| STATISTIC | 2 | 统计类型事件。 |
| SECURITY | 3 | 安全类型事件。 |
| BEHAVIOR | 4 | 行为类型事件。 |
## Event
...
...
@@ -453,11 +453,11 @@ hiAppEvent.clearData();
**系统能力:**
SystemCapability.HiviewDFX.HiAppEvent
| 名称 |
参数类型
| 可读 | 可写 | 说明 |
| ------------------------- | ------
--
| ---- | ---- | -------------------- |
| USER_LOGIN | string
| 是 | 否 | 用户登录事件。 |
| USER_LOGOUT | string
| 是 | 否 | 用户登出事件。 |
| DISTRIBUTED_SERVICE_START | string
| 是 | 否 | 分布式服务启动事件。 |
| 名称 |
类型
| 可读 | 可写 | 说明 |
| ------------------------- | ------ | ---- | ---- | -------------------- |
| USER_LOGIN | string | 是 | 否 | 用户登录事件。 |
| USER_LOGOUT | string | 是 | 否 | 用户登出事件。 |
| DISTRIBUTED_SERVICE_START | string | 是 | 否 | 分布式服务启动事件。 |
## Param
...
...
@@ -466,8 +466,8 @@ hiAppEvent.clearData();
**系统能力:**
SystemCapability.HiviewDFX.HiAppEvent
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------------------------------- | -------- | ---- | ---- | ------------------ |
| USER_ID | string | 是 | 否 | 用户自定义ID。 |
| DISTRIBUTED_SERVICE_NAME | string | 是 | 否 | 分布式服务名称。 |
| DISTRIBUTED_SERVICE_INSTANCE_ID | string | 是 | 否 | 分布式服务实例ID。 |
\ No newline at end of file
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------------------- | ------ | ---- | ---- | ------------------ |
| USER_ID | string | 是 | 否 | 用户自定义ID。 |
| DISTRIBUTED_SERVICE_NAME | string | 是 | 否 | 分布式服务名称。 |
| 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.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录