Skip to content

D
Docs

OpenHarmony / Docs
大约 1 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 9c6a815a 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!5036 add api doc for hisysevent napi interfaces. 

Merge pull request !5036 from honghecun/master
上级 386ad709 594ce01d
隐藏空白更改
内联 并排
Showing with 358 addition and 13 deletion
en/device-dev/subsystems/subsys-dfx-hisysevent-listening.md
浏览文件 @ 9c6a815a
......@@ -18,8 +18,8 @@ Before subscribing to system events, you need to configure HiSysEvent logging. F
| Name| Description |
| -------- | --------- |
|bool HiSysEventManager::AddEventListener(std::shared_ptr&lt;HiSysEventSubscribeCallBack&gt; listener, std::vector&lt;ListenerRule&gt;&amp; rules)|Registers a listener for system events. You can listen for certain events by specifying rules.<br><br>Input arguments: <ul><li>**listener**: callback object for system events. </li><li>**rules**: rules for event listening. </li></ul>Return value:<ul><li>**0**: Repeated registration is successful. </li><li>**1**: Initial registration is successful. </li><li>Other values: Registration has failed.</li></ul>|
|bool HiSysEventManager::RemoveListener(std::shared_ptr&lt;HiSysEventSubscribeCallBack&gt; listener)|Removes the listener for system events.<br><br>Input arguments: <ul><li>**listener**: callback object for system events. </ul>Return value:<br>None.|
|int32_t HiSysEventManager::AddEventListener(std::shared_ptr&lt;HiSysEventSubscribeCallBack&gt; listener, std::vector&lt;ListenerRule&gt;&amp; rules)|Registers a listener for system events. You can listen for certain events by specifying rules.<br><br>Input arguments: <ul><li>**listener**: callback object for system events. </li><li>**rules**: rules for event listening. </li></ul>Return value:<ul><li>**0**: registration is successful. </li><li>Other values: Registration has failed.</li></ul>|
|int32_t HiSysEventManager::RemoveListener(std::shared_ptr&lt;HiSysEventSubscribeCallBack&gt; listener)|Removes the listener for system events.<br><br>Input arguments: <ul><li>**listener**: callback object for system events. </ul>Return value:<ul><li>**0**: Cancel registration is successful. </li><li>Other values: Cancel registration has failed.</li></ul>|
**Table 2** Description of ListenerRule
......
en/device-dev/subsystems/subsys-dfx-hisysevent-query.md
浏览文件 @ 9c6a815a
......@@ -12,7 +12,7 @@ HiSysEvent provides an API for you to query system events. You can query concern
| Name| Description |
| -------- | --------- |
| bool HiSysEventManager::QueryHiSysEvent(struct QueryArg&amp; queryArg, std::vector&lt;QueryRule&gt;&amp; queryRules, std::shared_ptr&lt;HiSysEventQueryCallBack&gt; queryCallBack) | Queries system events by specifying search criteria such as the time segment, event domain, and event name.<br><br>Input arguments:<ul><li>**queryArg**: event query parameter. </li><li>**queryRules**: event filtering rules. </li><li>**queryRules**: callback object for query results. </li></ul>Return value:<ul><li>**true**: The query is successful. </li><li>**false**: The query has failed.</li></ul> |
| int32_t HiSysEventManager::QueryHiSysEvent(struct QueryArg&amp; queryArg, std::vector&lt;QueryRule&gt;&amp; queryRules, std::shared_ptr&lt;HiSysEventQueryCallBack&gt; queryCallBack) | Queries system events by specifying search criteria such as the time segment, event domain, and event name.<br><br>Input arguments:<ul><li>**queryArg**: event query parameter. </li><li>**queryRules**: event filtering rules. </li><li>**queryRules**: callback object for query results. </li></ul>Return value:<ul><li>**0**: The query is successful. </li><li>Other values: The query has failed.</li></ul> |
**Table 2** Description of QueryArg
......
zh-cn/application-dev/reference/apis/js-apis-hisysevent.md 0 → 100644
浏览文件 @ 9c6a815a
# 系统事件打点
为系统hap应用提供系统事件打点接口。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - 本模块的接口为系统接口，三方应用不支持调用。
## 导入模块
```js
import hiSysEvent from '@ohos.hiSysEvent';
```
## EventType
系统事件类型枚举。
**系统能力：** SystemCapability.HiviewDFX.HiSysEvent
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| FAULT | 1 | 错误事件类型。 |
| STATISTIC | 2 | 统计事件类型。 |
| SECURITY | 3 | 安全事件类型。 |
| BEHAVIOR | 4 | 用户行为事件类型。 |
## SysEventInfo
系统事件信息对象接口。
**系统能力：** SystemCapability.HiviewDFX.HiSysEvent
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| domain | string | 是 | 事件领域。 |
| name | string | 是 | 事件名称。 |
| eventType | [EventType](#eventtype) | 是 | 事件类型。 |
| params | object | 否 | 事件参数。 |
## hiSysEvent.write
write(info: SysEventInfo, callback: AsyncCallback&lt;void&gt;): void
系统事件打点方法，接收[SysEventInfo](#syseventinfo)类型的对象作为事件参数，使用callback方式作为异步回调。
**系统能力：** SystemCapability.HiviewDFX.HiSysEvent
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | ------------------------------------------------------------ |
| info | [SysEventInfo](#syseventinfo) | 是 | 系统事件。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，可以在回调函数中处理接口返回值。<br/>-&nbsp;0表示事件校验成功，事件正常异步写入事件文件；<br/>-&nbsp;正值表示事件打点存在异常，但可以正常写入；<br/>-&nbsp;负值表示事件打点失败。 |
**示例：**
```js
import hiSysEvent from '@ohos.hiSysEvent';
hiSysEvent.write({
domain: "RELIABILITY",
name: "STACK",
eventType: hiSysEvent.EventType.FAULT,
params: {
PID: 487,
UID: 103,
PACKAGE_NAME: "com.ohos.hisysevent.test",
PROCESS_NAME: "syseventservice",
MSG: "no msg."
}
}, (err, val) => {
// do something here.
})
```
## hiSysEvent.write
write(info: SysEventInfo): Promise&lt;void&gt
系统事件打点方法，接收[SysEventInfo](#syseventinfo)类型的对象作为事件参数，使用promise方式作为异步回调。
**系统能力：** SystemCapability.HiviewDFX.HiSysEvent
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ----------------------- | ---- | --------------- |
| eventType | [EventType](#eventtype) | 是 | 应用事件类型。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | ------------------------------------------------------------ |
| Promise&lt;void&gt; | Promise实例，可以在其then()、catch()方法中分别对系统事件写入成功、写入异常的回调进行处理。 |
**示例：**
```js
import hiSysEvent from '@ohos.hiSysEvent';
hiSysEvent.write({
domain: "RELIABILITY",
name: "STACK",
eventType: hiSysEvent.EventType.FAULT,
params: {
PID: 487,
UID: 103,
PACKAGE_NAME: "com.ohos.hisysevent.test",
PROCESS_NAME: "syseventservice",
MSG: "no msg."
}
}).then(
(val) => {
// do something here.
}
).catch(
(err) => {
// do something here.
}
)
```
## RuleType
匹配规则类型枚举。
**系统能力：** SystemCapability.HiviewDFX.HiSysEvent
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| WHOLE_WORD | 1 | 全词匹配类型。 |
| PREFIX | 2 | 前缀匹配类型。 |
| REGULAR | 3 | 正则匹配类型。 |
## WatchRule
系统事件订阅规则对象接口。
**系统能力：** SystemCapability.HiviewDFX.HiSysEvent
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| domain | string | 是 | 事件领域。 |
| name | string | 是 | 事件名称。 |
| tag | string | 是 | 事件标签。 |
| ruleType | [RuleType](#ruletype) | 是 | 匹配规则类型。 |
## Watcher
系统事件订阅者对象接口。
**系统能力：** SystemCapability.HiviewDFX.HiSysEvent
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| rules | [WatchRule](#watchrule)[] | 是 | 订阅对象数组，每个订阅者对象包含多个订阅规则。 |
| onEvent | function | 是 | 订阅事件的回调方法(info: [SysEventInfo](#syseventinfo)) => void。 |
| onServiceDied | function | 是 | 系统事件服务关闭的回调方法() => void。 |
## hiSysEvent.addWatcher
addWatcher(watcher: Watcher): number
订阅系统事件，接收[Watcher](#watcher)类型的对象作为事件参数。
**需要权限：** ohos.permission.READ_DFX_SYSEVENT
**系统能力：** SystemCapability.HiviewDFX.HiSysEvent
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------------- | ---- | ------------------------ |
| watcher | [Watcher](#watcher) | 是 | 系统事件订阅者对象。 |
**返回值：**
| 类型 | 说明 |
| ------- | -------------------------------------------------- |
| number | 系统事件订阅结果。<br>-0&nbsp;表示订阅成功。<br>-负值&nbsp;表示订阅失败。 |
**示例：**
```js
import hiSysEvent from '@ohos.hiSysEvent';
let watcher = {
rules: [{
domain: "RELIABILITY",
name: "STACK",
tag: "STABILITY",
ruleType: hiSysEvent.RuleType.WHOLE_WORD,
}],
onEvent: (info) => {
// do something here.
},
onServiceDied: () => {
// do something here.
}
}
let ret = hiSysEvent.addWatcher(watcher)
```
## hiSysEvent.removeWatcher
removeWatcher(wathcer: Watcher): number
取消订阅系统事件，接收[Watcher](#watcher)类型的对象作为事件参数。
**需要权限：** ohos.permission.READ_DFX_SYSEVENT
**系统能力：** SystemCapability.HiviewDFX.HiSysEvent
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------- | ---- | ------------------------ |
| watcher | [Watcher](#watcher) | 是 | 系统事件订阅者对象。 |
**返回值：**
| 类型 | 说明 |
| ------- | ----------------------------------------------------------- |
| number | 取消订阅系统事件的结果。<br>-0&nbsp;表示取消订阅成功。<br>-负值&nbsp;表示取消订阅失败。 |
**示例：**
```js
import hiSysEvent from '@ohos.hiSysEvent';
let watcher = {
rules: [{
domain: "RELIABILITY",
name: "STACK",
tag: "STABILITY",
ruleType: hiSysEvent.RuleType.WHOLE_WORD,
}],
onEvent: (info) => {
// do something here.
},
onServiceDied: () => {
// do something here.
}
}
let ret = hiSysEvent.addWatcher(watcher)
hiSysEvent.removeWatcher(watcher)
```
## QueryArg
系统事件查询参数对象接口。
**系统能力：** SystemCapability.HiviewDFX.HiSysEvent
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| beginTime | number | 是 | 查询的系统事件起始时间（13位时间戳）。 |
| endTime | number | 是 | 查询的系统事件结束时间（13位时间戳）。 |
| maxEvents | number | 是 | 查询的系统事件最多条数。 |
## QueryRule
系统事件查询规则对象接口。
**系统能力：** SystemCapability.HiviewDFX.HiSysEvent
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| domain | string | 是 | 查询包含的事件领域。 |
| names | string[] | 是 | 查询所包含的多个事件名称，每个查询规则对象包含多个系统事件名称。 |
## Querier
系统事件查询者对象接口。
**系统能力：** SystemCapability.HiviewDFX.HiSysEvent
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| onQuery | function | 是 | 返回查询到的系统事件的回调方法(infos: [SysEventInfo](#syseventinfo)[], seqs: number[]) => void。 |
| onComplete | function | 是 | 查询结果统计的回调方法(reason: number, total: number) => void。 |
## hiSysEvent.query
query(queryArg: QueryArg, rules: QueryRule[], querier: Querier): number
查询系统事件。
**需要权限：** ohos.permission.READ_DFX_SYSEVENT
**系统能力：** SystemCapability.HiviewDFX.HiSysEvent
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------------- | ---- | ------------------------ |
| queryArg | [QueryArg](#queryarg) | 是 | 查询需要配置的查询参数。 |
| rules | [QueryRule](#queryrule)[] | 是 | 查询规则数组，每次查询可配置多个查询规则。 |
| querier | [Querier](#querier) | 是 | 查询者对象，包含查询结果及结束的相关回调。 |
**返回值：**
| 类型 | 说明 |
| ------- | ----------------------------------------------------------- |
| number | 系统事件查询的结果。<br>-0&nbsp;表示查询成功.<br>-负值&nbsp;表示查询失败。 |
**示例：**
```js
import hiSysEvent from '@ohos.hiSysEvent';
hiSysEvent.write({
domain: "RELIABILITY",
name: "STACK",
eventType: hiSysEvent.EventType.FAULT,
params: {
PID: 487,
UID: 103,
PACKAGE_NAME: "com.ohos.hisysevent.test",
PROCESS_NAME: "syseventservice",
MSG: "no msg."
}
}, (err, val) => {
// do something here.
})
hiSysEvent.query({
beginTime: -1,
endTime: -1,
maxEvents: 5,
}, [{
domain: "RELIABILITY",
names: ["STACK"],
}], {
onQuery: function (infos, seqs) {
// do something here.
},
onComplete: function(reason, total) {
// do something here.
}
})
```
\ No newline at end of file
zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-listening.md
浏览文件 @ 9c6a815a
......@@ -23,16 +23,16 @@ HiSysEvent提供了跨进程订阅机制，开发者可以通过注册订阅接
| 接口名称 | 描述 |
| -------- | -------- |
| bool&nbsp;HiSysEventManager::AddEventListener(std::shared_ptr&lt;HiSysEventSubscribeCallBack&gt;&nbsp;listener,&nbsp;std::vector&lt;ListenerRule&gt;&amp;&nbsp;rules) | 接口功能：注册订阅HiSysEvent系统事件侦听对象，可设置规则订阅某些事件。<br/>输入参数：<br/>-&nbsp;listener：订阅回调对象。<br/>-&nbsp;rules：事件订阅规则。<br/>返回值：<br/>-&nbsp;0：订阅成功，重复订阅。<br/>-&nbsp;1：订阅成功，初次订阅。<br/>-&nbsp;其他值：订阅失败。 |
| bool&nbsp;HiSysEventManager::RemoveListener(std::shared_ptr&lt;HiSysEventSubscribeCallBack&gt;&nbsp;listener) | 接口功能：移除订阅hisysevent系统事件侦听对象。<br/>输入参数：<br/>-&nbsp;listener：订阅回调对象。<br/>返回值：<br/>无。 |
| int32_t&nbsp;HiSysEventManager::AddEventListener(std::shared_ptr&lt;HiSysEventSubscribeCallBack&gt;&nbsp;listener,<br/>&nbsp;std::vector&lt;ListenerRule&gt;&amp;&nbsp;rules) | 接口功能：注册订阅HiSysEvent系统事件侦听对象，可设置规则订阅某些事件。<br/>输入参数：<br/>-&nbsp;listener：订阅回调对象。<br/>-&nbsp;rules：事件订阅规则。<br/>返回值：<br/>-&nbsp;0：订阅成功。<br/>-&nbsp;负值：订阅失败。 |
| int32_t&nbsp;HiSysEventManager::RemoveListener(std::shared_ptr&lt;HiSysEventSubscribeCallBack&gt;&nbsp;listener) | 接口功能：移除订阅hisysevent系统事件侦听对象。<br/>输入参数：<br/>-&nbsp;listener：订阅回调对象。<br/>返回值：<br/>-&nbsp;0：取消订阅成功。<br/>-&nbsp;负值：取消订阅失败。 |
**表2** ListenerRule订阅规则对象
| 接口名称 | 描述 |
| -------- | -------- |
| ListenerRule(const&nbsp;std::string&amp;&nbsp;tag,&nbsp;RuleType&nbsp;ruleType&nbsp;=&nbsp;RuleType::WHOLE_WORD) | 接口功能：订阅规则构造函数，创建事件标签订阅规则对象。<br/>输入参数：<br/>-&nbsp;tag：订阅规则的HisysEvent事件标签，字符串类型，最大长度16个字符（含），有效字符包含大小写字母及数字。<br/>-&nbsp;ruleType：订阅规则的规则类型，RuleType枚举类型(参考表3)。 |
| ListenerRule(const&nbsp;std::string&amp;&nbsp;domain,&nbsp;const&nbsp;std::string&amp;&nbsp;eventName,&nbsp;RuleType&nbsp;ruleType&nbsp;=&nbsp;RuleType::WHOLE_WORD) | 接口功能：订阅规则构造函数，创建事件领域与事件名称订阅规则对象。<br/>输入参数：<br/>-&nbsp;domain：订阅规则的HisysEvent事件领域，字符串类型，最大长度16个字符（含），有效字符包含大写字母、数字及下划线。<br/>-&nbsp;eventName：订阅规则的HisysEvent事件名称，字符串类型，最大长度32个字符（含），有效字符包含大写字母、数字及下划线。<br/>-&nbsp;ruleType：订阅规则的规则类型，RuleType枚举类型(参考表3)。 |
| ListenerRule(const&nbsp;std::string&amp;&nbsp;domain,&nbsp;const&nbsp;std::string&amp;&nbsp;eventName,&nbsp;const&nbsp;std::string&amp;&nbsp;tag,&nbsp;RuleType&nbsp;ruleType&nbsp;=&nbsp;RuleType::WHOLE_WORD) | 接口功能：订阅规则构造函数，创建事件领域、事件名称，事件标签订阅规则对象。<br/>输入参数：<br/>-&nbsp;tag：订阅规则的HisysEvent事件标签，字符串类型，最大长度16个字符（含），有效字符包含大小写字母及数字。<br/>-&nbsp;domain：订阅规则的HisysEvent事件领域，字符串类型，最大长度16个字符（含），有效字符包含大写字母、数字及下划线。<br/>-&nbsp;eventName：订阅规则的HisysEvent事件名称，字符串类型，最大长度32个字符（含），有效字符包含大写字母、数字及下划线。<br/>-&nbsp;ruleType：订阅规则的规则类型，RuleType枚举类型(参考表3)。 |
| ListenerRule(const&nbsp;std::string&amp;&nbsp;tag,<br/>&nbsp;RuleType&nbsp;ruleType&nbsp;=&nbsp;RuleType::WHOLE_WORD) | 接口功能：订阅规则构造函数，创建事件标签订阅规则对象。<br/>输入参数：<br/>-&nbsp;tag：订阅规则的HisysEvent事件标签，字符串类型，最大长度16个字符（含），有效字符包含大小写字母及数字。<br/>-&nbsp;ruleType：订阅规则的规则类型，RuleType枚举类型(参考表3)。 |
| ListenerRule(const&nbsp;std::string&amp;&nbsp;domain,<br/>&nbsp;const&nbsp;std::string&amp;&nbsp;eventName,<br/>&nbsp;RuleType&nbsp;ruleType&nbsp;=&nbsp;RuleType::WHOLE_WORD) | 接口功能：订阅规则构造函数，创建事件领域与事件名称订阅规则对象。<br/>输入参数：<br/>-&nbsp;domain：订阅规则的HisysEvent事件领域，字符串类型，最大长度16个字符（含），有效字符包含大写字母、数字及下划线。<br/>-&nbsp;eventName：订阅规则的HisysEvent事件名称，字符串类型，最大长度32个字符（含），有效字符包含大写字母、数字及下划线。<br/>-&nbsp;ruleType：订阅规则的规则类型，RuleType枚举类型(参考表3)。 |
| ListenerRule(const&nbsp;std::string&amp;&nbsp;domain,<br/>&nbsp;const&nbsp;std::string&amp;&nbsp;eventName,<br/>&nbsp;const&nbsp;std::string&amp;&nbsp;tag,<br/>&nbsp;RuleType&nbsp;ruleType&nbsp;=&nbsp;RuleType::WHOLE_WORD) | 接口功能：订阅规则构造函数，创建事件领域、事件名称，事件标签订阅规则对象。<br/>输入参数：<br/>-&nbsp;tag：订阅规则的HisysEvent事件标签，字符串类型，最大长度16个字符（含），有效字符包含大小写字母及数字。<br/>-&nbsp;domain：订阅规则的HisysEvent事件领域，字符串类型，最大长度16个字符（含），有效字符包含大写字母、数字及下划线。<br/>-&nbsp;eventName：订阅规则的HisysEvent事件名称，字符串类型，最大长度32个字符（含），有效字符包含大写字母、数字及下划线。<br/>-&nbsp;ruleType：订阅规则的规则类型，RuleType枚举类型(参考表3)。 |
**表3** RuleType类型
......@@ -46,7 +46,7 @@ HiSysEvent提供了跨进程订阅机制，开发者可以通过注册订阅接
| 接口名称 | 描述 |
| -------- | -------- |
| void&nbsp;HiSysEventSubscribeCallBack::OnHandle(const&nbsp;std::string&amp;&nbsp;domain,&nbsp;const&nbsp;std::string&amp;&nbsp;eventName,&nbsp;const&nbsp;int&nbsp;eventType,&nbsp;const&nbsp;std::string&amp;&nbsp;eventDetail) | 接口功能：订阅事件的回调接口。<br/>输入参数：<br/>-&nbsp;domain：事件所属领域。<br/>-&nbsp;eventName：事件的名称。<br/>-&nbsp;eventType：事件类型。<br/>-&nbsp;eventDetail：包含事件相关信息的字符串，以json的形式体现。<br/>返回值：<br/>无。 |
| void&nbsp;HiSysEventSubscribeCallBack::OnHandle(const&nbsp;std::string&amp;&nbsp;domain,<br/>&nbsp;const&nbsp;std::string&amp;&nbsp;eventName,<br/>&nbsp;const&nbsp;int&nbsp;eventType,<br/>&nbsp;const&nbsp;std::string&amp;&nbsp;eventDetail) | 接口功能：订阅事件的回调接口。<br/>输入参数：<br/>-&nbsp;domain：事件所属领域。<br/>-&nbsp;eventName：事件的名称。<br/>-&nbsp;eventType：事件类型。<br/>-&nbsp;eventDetail：包含事件相关信息的字符串，以json的形式体现。<br/>返回值：<br/>无。 |
## 开发实例
......
zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-query.md
浏览文件 @ 9c6a815a
......@@ -15,7 +15,7 @@ HiSysEvent提供了查询接口，支持开发者设置条件查询HiSysEvent事
| 接口名 | 描述 |
| -------- | -------- |
| bool&nbsp;HiSysEventManager::QueryHiSysEvent(struct&nbsp;QueryArg&amp;&nbsp;queryArg,&nbsp;std::vector&lt;QueryRule&gt;&amp;&nbsp;queryRules,&nbsp;std::shared_ptr&lt;HiSysEventQueryCallBack&gt;&nbsp;queryCallBack) | 接口功能：支持设置查询时间段，事件领域，事件名称等，查询满足条件的HiSysEvent事件。<br/>输入参数：<br/>-&nbsp;queryArg：查询参数。<br/>-&nbsp;queryRules：事件过滤规则。<br/>-&nbsp;queryCallBack：查询接口回调对象。<br/>返回值：<br/>-&nbsp;true：查询成功。<br/>-&nbsp;false：查询失败。 |
| int32_t&nbsp;HiSysEventManager::QueryHiSysEvent(struct&nbsp;QueryArg&amp;&nbsp;queryArg,<br/>&nbsp;std::vector&lt;QueryRule&gt;&amp;&nbsp;queryRules,<br/>&nbsp;std::shared_ptr&lt;HiSysEventQueryCallBack&gt;&nbsp;queryCallBack) | 接口功能：支持设置查询时间段，事件领域，事件名称等，查询满足条件的HiSysEvent事件。<br/>输入参数：<br/>-&nbsp;queryArg：查询参数。<br/>-&nbsp;queryRules：事件过滤规则。<br/>-&nbsp;queryCallBack：查询接口回调对象。<br/>返回值：<br/>-&nbsp;0：查询成功。<br/>-&nbsp;负值：查询失败。 |
**表2** QueryArg查询参数对象
......@@ -29,14 +29,14 @@ HiSysEvent提供了查询接口，支持开发者设置条件查询HiSysEvent事
| 接口名称 | 描述 |
| -------- | -------- |
| QueryRule(const&nbsp;std::string&amp;&nbsp;domain,&nbsp;const&nbsp;std::vector&lt;std::string&gt;&amp;&nbsp;eventList) | 接口功能：查询规则构造函数，创建查询规则对象。<br/>输入参数：<br/>-&nbsp;domain：string类型，用来标识查询规则对象的事件所属领域，如果传入的是空字符串，则默认事件领域字段匹配成功。<br/>-&nbsp;eventList：std::vector&lt;std::string&gt;类型，事件名称的列表，如果传入的是空字符串，则默认事件名称字段匹配成功。 |
| QueryRule(const&nbsp;std::string&amp;&nbsp;domain,<br/>&nbsp;const&nbsp;std::vector&lt;std::string&gt;&amp;&nbsp;eventList) | 接口功能：查询规则构造函数，创建查询规则对象。<br/>输入参数：<br/>-&nbsp;domain：string类型，用来标识查询规则对象的事件所属领域，如果传入的是空字符串，则默认事件领域字段匹配成功。<br/>-&nbsp;eventList：std::vector&lt;std::string&gt;类型，事件名称的列表，如果传入的是空字符串，则默认事件名称字段匹配成功。 |
**表4** HiSysEventQueryCallBack查询回调对象
| 接口名称 | 描述 |
| -------- | -------- |
| void&nbsp;HiSysEventQueryCallBack::OnQuery(const&nbsp;::std::vector&lt;std::string&gt;&amp;&nbsp;sysEvent,&nbsp;const&nbsp;::std::vector&lt;int64_t&gt;&amp;&nbsp;seq) | 接口功能：订阅事件查询中的回调。<br/>输入参数：<br/>-&nbsp;sysEvent：返回事件集合。<br/>-&nbsp;seq：事件序列集合。<br/>返回值：<br/>无。 |
| void&nbsp;HiSysEventQueryCallBack::OnComplete(int32_t&nbsp;reason,&nbsp;int32_t&nbsp;total) | 接口功能：订阅事件查询完成的回调。<br/>输入参数：<br/>-&nbsp;reason：查询结束返回原因，目前默认是0。<br/>-&nbsp;total：本次查询总共返回的事件总数量。<br/>返回值：<br/>无。 |
| void&nbsp;HiSysEventQueryCallBack::OnQuery(const&nbsp;::std::vector&lt;std::string&gt;&amp;&nbsp;sysEvent,<br/>&nbsp;const&nbsp;::std::vector&lt;int64_t&gt;&amp;&nbsp;seq) | 接口功能：订阅事件查询中的回调。<br/>输入参数：<br/>-&nbsp;sysEvent：返回事件集合。<br/>-&nbsp;seq：事件序列集合。<br/>返回值：<br/>无。 |
| void&nbsp;HiSysEventQueryCallBack::OnComplete(int32_t&nbsp;reason,&nbsp;int32_t&nbsp;total) | 接口功能：订阅事件查询完成的回调。<br/>输入参数：<br/>-&nbsp;reason：查询结束返回原因，目前默认是0。<br/>-&nbsp;total：本次查询总共返回的事件总数量。<br/>返回值：<br/>无。 |
### 开发实例
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或