> 说明
本功能添加于`2.1.4.0` / `2.4.0`版本。
使用本功能需启用 **`动态交互`** 模块。
整体说明
---
事件管理功能中的所有函数均含有以下请求参数,后续不再重复说明.
| 参数 | 类型 | 值 | 说明 |
| --- | :-: | :-: | --- |
| `module` | string | `eventManage` | 模块名 |
| `function` | string | - | 函数名 |
在响应数据中均含有以下响应字段
| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `request` | object | 本次请求的相关数据 |
| `request.handle` | number | 请求绑定的句柄 |
| `request.text` | object | 请求内容 |
函数列表
---
### 获取事件数据(`get`)
说明
* 用于取回为未成功投递到服务端的事件数据
#### 请求数据
```
{
"module":"eventManage",
"function":"get",
"limit":5
}
```
##### 请求参数说明
| 参数 | 类型 | 默认值 | 说明 |
| --- | :-: | :-: | --- |
| `function` | string | `get` | 功能名 |
| `limit` | number | `5` | 需要取回的数据数量 |
#### 响应数据
```
{
"status": 0,
"amount": 3,
"margin": 0,
"event": [
{
"type": 1,
"subType": 1,
"msgID": 534,
"time": 1532109054,
"loginQQ": 10000,
"qq": 2010741172,
"msg": null,
"font": 54519592
},
{
"type": 2,
"subType": 1,
"msgID": 536,
"time": 1532111575,
"loginQQ": 0,
"qq": 0,
"group": 0,
"msg": "写文档是真的emmm",
"font": 54989944
},
{
"type": 2,
"subType": 1,
"msgID": 537,
"time": 1532111612,
"loginQQ": 0,
"qq": 0,
"group": 0,
"originalMsg": "还有一个说明没补充,有点不想动了[CQ:image,file=xxxxx.jpg],",
"imageInfo": [
{
"fileName": "xxxxx.jpg",
"md5": "xxxxx",
"width": 50,
"height": 65,
"size": 20829,
"url": "https://gchat.qpic.cn/gchatpic_new/xxxxx",
"addTime": 1532011070
}
],
"msg": "还有一个说明没补充,有点不想动了",
"font": 55416120
}
]
}
```
##### 响应字段说明
| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `status` | number | 响应状态,成功为0 |
| `amount` | number | 实际取回的事件数据数量 |
| `margin` | number | 未取回的事件数据数量(可以理解成未读消息) |
| `event` | array | 取回的事件数据 |
| `event[i]` | object | 取回的第`i`个事件数据,具体说明请参考 **`提交事件说明`** |
---
### 拦截事件(`intercept`)
#### 说明
当客户端进程收到事件,并且处理完事件数据后,需要选择是否将该事件传递给下一进程处理。在开启事件拦截处理功能后,进程会保留该事件一段时间,用于等待服务端发送拦截处理结果,若该段时间结束后仍未收到拦截处理结果,则进程将会把该事件传递给下一进程处理。
#### 请求数据
```
{
"module":"eventManage",
"function":"intercept",
"handle": 12345678,
"intercept": false
}
```
##### 请求参数说明
| 参数 | 类型 | 默认值 | 说明 |
| --- | :-: | :-: | --- |
| `handle` | number | - | 事件中的处理标志 |
| `intercept` | bool | `true` | `true` / 拦截,`false` / 不拦截 |
#### 响应数据
```
{
"status": 0,
"errMsg": ""
}
```
##### 响应字段说明
| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `status` | number | 拦截结果,`0` / 处理成功,`400` / 事件不存在,`425` / 刚好超过等待结果时间 |
| `errMsg` | string | 错误原因,成功时为`空文本` |