Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
b700a3aa
D
Docs
项目概览
OpenHarmony
/
Docs
12 个月 前同步成功
通知
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看板
体验新版 GitCode,发现更多精彩内容 >>
提交
b700a3aa
编写于
10月 18, 2022
作者:
L
lyj_love_code
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update the js-apis-hiviewdfx-hiappevent.md
Signed-off-by:
N
lyj_love_code
<
liangyujian2@huawei.com
>
上级
a359c257
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
49 addition
and
53 deletion
+49
-53
zh-cn/application-dev/reference/apis/js-apis-hiappevent.md
zh-cn/application-dev/reference/apis/js-apis-hiappevent.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-hiviewdfx-hiappevent.md
...cation-dev/reference/apis/js-apis-hiviewdfx-hiappevent.md
+48
-52
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-hiappevent.md
浏览文件 @
b700a3aa
...
...
@@ -3,7 +3,7 @@
本模块提供了应用事件打点能力,包括对打点数据的落盘,以及对打点功能的管理配置。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> - 本模块接口从API version 9开始废弃,建议使用新接口[@ohos.hiviewdfx.hiAppEvent](js-apis-hiviewdfx-hiappevent)替代。
> - 本模块接口从API version 9开始废弃,建议使用新接口[@ohos.hiviewdfx.hiAppEvent](js-apis-hiviewdfx-hiappevent
.md
)替代。
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-hiviewdfx-hiappevent.md
浏览文件 @
b700a3aa
...
...
@@ -12,22 +12,6 @@
import
hiAppEvent
from
'
@ohos.hiviewdfx.hiAppEvent
'
;
```
## 使用说明
开发者在使用应用事件打点功能前,需要首先了解应用事件相关的使用规格。
**事件打点回调**
开发者在调用事件打点方法时,可以在回调函数中对打点结果进行处理,当前支持callback形式和Promise形式的回调。
**事件订阅回调**
开发者在调用事件订阅方法时,可以在订阅回调函数中对订阅数据进行处理,其入参定义如下:
-
curRow:返回的订阅事件数量;
-
curSize:返回的订阅事件数据大小,单位为byte;
-
holder:返回的订阅事件数据持有者,可以通过其对订阅事件进行处理。
## hiAppEvent.write
write(info:
[
AppEventInfo
](
#appeventinfo
)
, callback: AsyncCallback
<
void
>
): void
...
...
@@ -41,7 +25,7 @@ write(info: [AppEventInfo](#appeventinfo), callback: AsyncCallback<void>):
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------ | ---- | -------------- |
| info |
[
AppEventInfo
](
#appeventinfo
)
| 是 | 应用事件对象。 |
| callback | AsyncCallback
<
void
>
|
否 | 事件
回调函数。 |
| callback | AsyncCallback
<
void
>
|
是 | 打点
回调函数。 |
**错误码:**
...
...
@@ -93,9 +77,9 @@ write(info: [AppEventInfo](#appeventinfo)): Promise<void>
**返回值:**
| 类型 | 说明
|
| ------------------- | -------------
-----------------------------------------------
|
| Promise
<
void
>
| Promise对象
,可以在其then()、catch()方法中分别对事件写入成功、写入异常的情况进行异步处理
。 |
| 类型 | 说明 |
| ------------------- | ------------- |
| Promise
<
void
>
| Promise对象。 |
**错误码:**
...
...
@@ -144,9 +128,9 @@ hiAppEvent.write({
## hiAppEvent.configure
configure(config:
ConfigOption
): void
configure(config:
[
ConfigOption
](
configoption
)
): void
应用事件打点配置方法,可用于配置打点开关、
文件目录存储限
额大小等功能。
应用事件打点配置方法,可用于配置打点开关、
目录存储配
额大小等功能。
**系统能力:**
SystemCapability.HiviewDFX.HiAppEvent
...
...
@@ -167,12 +151,12 @@ configure(config: ConfigOption): void
**示例:**
```
js
// 配置
应用事件打点功能开关
// 配置
打点开关为关闭状态
hiAppEvent
.
configure
({
disable
:
true
});
// 配置
事件文件目录存储限额大小
// 配置
文件目录存储配额为100M
hiAppEvent
.
configure
({
maxStorage
:
'
100M
'
});
...
...
@@ -180,20 +164,20 @@ hiAppEvent.configure({
## ConfigOption
此接口提供了
应用事件打点
的配置选项。
此接口提供了
对应用事件打点功能
的配置选项。
**系统能力:**
SystemCapability.HiviewDFX.HiAppEvent
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ------------------------------------------------------------ |
| disable | boolean | 否 |
应用事件打点功能开关。配置值为true表示关闭打点功能,false表示
不关闭打点功能。 |
| maxStorage | string | 否 | 打点数据
本地存储文件所在目录的配额大小,默认限额为“10M”。所在目录大小超出限额后会对目录进行清理操作,会按从旧到新的顺序逐个删除打点数据文件,直到目录大小不超出限额时停止
。 |
| disable | boolean | 否 |
打点功能开关,默认值为false。true:关闭打点功能,false:
不关闭打点功能。 |
| maxStorage | string | 否 | 打点数据
存放目录的配额大小,默认值为“10M”。
<br>
在目录大小超出配额后,下次打点会触发对目录的清理操作:按从旧到新的顺序逐个删除打点数据文件,直到目录大小不超出配额时结束
。 |
## hiAppEvent.addWatcher
addWatcher(watcher:
[
Watcher
](
#watcher
)
):
[
AppEventPackageHolder
](
#appeventpackageholder
)
添加应用事件
订阅者
。
添加应用事件
观察者方法,可用于订阅应用事件
。
**系统能力:**
SystemCapability.HiviewDFX.HiAppEvent
...
...
@@ -201,7 +185,7 @@ addWatcher(watcher: [Watcher](#watcher)): [AppEventPackageHolder](#appeventpacka
| 参数名 | 类型 | 必填 | 说明 |
| ------- | -------------------- | ---- | ---------------- |
| watcher |
[
Watcher
](
#watcher
)
| 是 | 应用事件
订阅
者。 |
| watcher |
[
Watcher
](
#watcher
)
| 是 | 应用事件
观察
者。 |
**返回值:**
...
...
@@ -224,12 +208,12 @@ addWatcher(watcher: [Watcher](#watcher)): [AppEventPackageHolder](#appeventpacka
**示例:**
```
js
// 1. 如果
订阅
者传入了回调的相关参数,则可以选择在自动触发的回调函数中对订阅事件进行处理
// 1. 如果
观察
者传入了回调的相关参数,则可以选择在自动触发的回调函数中对订阅事件进行处理
hiAppEvent
.
addWatcher
({
name
:
"
watcher1
"
,
appEventFilters
:
[
{
domain
:
"
domain_test1
"
,
domain
:
"
test_domain
"
,
eventTypes
:
[
hiAppEvent
.
EventType
.
FAULT
,
hiAppEvent
.
EventType
.
BEHAVIOR
]
}
],
...
...
@@ -255,7 +239,7 @@ hiAppEvent.addWatcher({
}
});
// 2. 如果
订阅
者未传入回调的相关参数,则可以选择使用返回的holder对象手动去处理订阅事件
// 2. 如果
观察
者未传入回调的相关参数,则可以选择使用返回的holder对象手动去处理订阅事件
let
holder
=
hiAppEvent
.
addWatcher
({
name
:
"
watcher2
"
,
});
...
...
@@ -276,7 +260,7 @@ if (holder != null) {
removeWatcher(watcher:
[
Watcher
](
#watcher
)
): void
移除应用事件
订阅者
。
移除应用事件
观察者方法,可用于取消订阅应用事件
。
**系统能力:**
SystemCapability.HiviewDFX.HiAppEvent
...
...
@@ -284,7 +268,7 @@ removeWatcher(watcher: [Watcher](#watcher)): void
| 参数名 | 类型 | 必填 | 说明 |
| ------- | -------------------- | ---- | ---------------- |
| watcher |
[
Watcher
](
#watcher
)
| 是 | 应用事件
订阅
者。 |
| watcher |
[
Watcher
](
#watcher
)
| 是 | 应用事件
观察
者。 |
**错误码:**
...
...
@@ -297,46 +281,46 @@ removeWatcher(watcher: [Watcher](#watcher)): void
**示例:**
```
js
// 1. 定义一个应用事件
订阅
者
// 1. 定义一个应用事件
观察
者
let
watcher
=
{
name
:
"
watcher1
"
,
}
// 2.
开始
订阅事件
// 2.
添加一个应用事件观察者来
订阅事件
hiAppEvent
.
addWatcher
(
watcher
);
// 3. 取消订阅事件
// 3.
移除该应用事件观察者以
取消订阅事件
hiAppEvent
.
removeWatcher
(
watcher
);
```
## Watcher
此接口提供了应用事件
订阅
者的参数选项。
此接口提供了应用事件
观察
者的参数选项。
**系统能力:**
SystemCapability.HiviewDFX.HiAppEvent
| 名称 | 参数类型 | 必填 | 说明 |
| ---------------- | ------------------------------------------------------------ | ---- | -------------------------------- |
| name | string | 是 |
订阅者名称,用于唯一标识订阅者。
|
| triggerCondition |
[
TriggerCondition
](
#triggercondition
)
| 否 | 订阅回调触发条件。
|
| appEventFilters |
[
AppEventFilter
](
#appeventfilter
)[]
| 否 | 订阅过滤条件。
|
| onTrigger | (curRow: number, curSize: number, holder:
[
AppEventPackageHolder
](
#appeventpackageholder
)
) => void | 否 | 订阅回调函数
。
|
| 名称 | 参数类型 | 必填 | 说明
|
| ---------------- | ------------------------------------------------------------ | ---- | --------------------------------
----------------------------
|
| name | string | 是 |
观察者名称,用于唯一标识观察者。
|
| triggerCondition |
[
TriggerCondition
](
#triggercondition
)
| 否 | 订阅回调触发条件,需要与回调函数一同传入才会生效。
|
| appEventFilters |
[
AppEventFilter
](
#appeventfilter
)[]
| 否 | 订阅过滤条件,在需要对订阅事件进行过滤时传入。
|
| onTrigger | (curRow: number, curSize: number, holder:
[
AppEventPackageHolder
](
#appeventpackageholder
)
) => void | 否 | 订阅回调函数
,需要与回调触发条件一同传入才会生效,函数入参说明如下:
<br>
curRow:在本次回调触发时的订阅事件总数量;
<br>
curSize:在本次回调触发时的订阅事件总大小,单位为byte;
<br/>
holder:订阅数据持有者对象,可以通过其对订阅事件进行处理。
|
## TriggerCondition
此接口提供了
订阅者回调触发条件的参数选项
。
此接口提供了
回调触发条件的参数选项,只要满足任一条件就会触发订阅回调
。
**系统能力:**
SystemCapability.HiviewDFX.HiAppEvent
| 名称 | 参数类型 | 必填 | 说明 |
| ------- | -------- | ---- | -------------------------------------- |
| row | number | 否 | 满足触发回调的事件总数
。
|
| row | number | 否 | 满足触发回调的事件总数
量。
|
| size | number | 否 | 满足触发回调的事件总大小,单位为byte。 |
| timeOut | number | 否 | 满足触发回调的
定
时时长,单位为30s。 |
| timeOut | number | 否 | 满足触发回调的
超
时时长,单位为30s。 |
## AppEventFilter
此接口提供了
订阅者
过滤应用事件的参数选项。
此接口提供了过滤应用事件的参数选项。
**系统能力:**
SystemCapability.HiviewDFX.HiAppEvent
...
...
@@ -353,12 +337,18 @@ hiAppEvent.removeWatcher(watcher);
### constructor
constructor(watcherName: string)
;
constructor(watcherName: string)
类构造函数,在添加
订阅时会被系统自动调用来创建一个订阅数据持有者对象
并返回给开发者。
类构造函数,在添加
应用事件观察者时,会由系统自动调用来创建一个该观察者对应的订阅数据持有者对象,
并返回给开发者。
**系统能力:**
SystemCapability.HiviewDFX.HiAppEvent
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------- | ---- | ------------------------ |
| watcherName | string | 是 | 观察者名称。 |
**示例:**
```
js
...
...
@@ -371,10 +361,16 @@ let holder = hiAppEvent.addWatcher({
setSize(size: number): void
设置每次取出的应用事件包的数据大小阈值
,单位为byte,默认值为512
*
1024
。
设置每次取出的应用事件包的数据大小阈值。
**系统能力:**
SystemCapability.HiviewDFX.HiAppEvent
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------------------------------- |
| size | number | 是 | 数据大小阈值,单位为byte,默认值为512
*
1024。 |
**错误码:**
以下错误码的详细介绍请参见
[
应用事件打点错误码
](
../errorcodes/errcode-hiviewdfx-hiappevent.md
)
。
...
...
@@ -419,7 +415,7 @@ let eventPkg = holder.takeNext();
| --------- | -------- | ------------------------------ |
| packageId | number | 事件包ID,从0开始自动递增。 |
| row | number | 事件包的事件数量。 |
| size | number | 事件包的
数据
大小,单位为byte。 |
| size | number | 事件包的
事件
大小,单位为byte。 |
| data | string[] | 事件包的事件信息。 |
## hiAppEvent.clearData
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录