Skip to content
This repository was archived by the owner on Aug 2, 2020. It is now read-only.

Commit 5c826f7

Browse files
committed
Update docs for v3.4 beta
1 parent c35d810 commit 5c826f7

File tree

4 files changed

+9
-8
lines changed

4 files changed

+9
-8
lines changed

docs/3.4/API.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ GET /send_private_msg?access_token=kSLuTF2GC2Q4q4ugm3&user_id=123456&message=hel
6767
| 1 | 同时 `status``async`,表示操作已进入异步执行,具体结果未知 |
6868
| 100 | 参数缺失或参数无效,通常是因为没有传入必要参数,某些接口中也可能因为参数明显无效(比如传入的 QQ 号小于等于 0,此时无需调用酷 Q 函数即可确定失败),此项和以下的 `status` 均为 `failed` |
6969
| 102 | 酷 Q 函数返回的数据无效,一般是因为传入参数有效但没有权限,比如试图获取没有加入的群组的成员列表 |
70-
| 103 | (v3.3.4 新增)操作失败,一般是因为用户权限不足,或文件系统异常、不符合预期 |
70+
| 103 | 操作失败,一般是因为用户权限不足,或文件系统异常、不符合预期 |
7171
| 201 | 工作线程池未正确初始化(无法执行异步任务) |
7272

7373
`data` 字段为 API 返回数据的内容,对于踢人、禁言等不需要返回数据的操作,这里为 null,对于获取群成员信息这类操作,这里为所获取的数据的对象,具体的数据内容将会在相应的 API 描述中给出。注意,异步版本的 API,`data` 永远是 null,即使其相应的同步接口本身是有数据。
@@ -534,7 +534,7 @@ GET /send_private_msg?access_token=kSLuTF2GC2Q4q4ugm3&user_id=123456&message=hel
534534

535535
### `/clean_data_dir` 清理数据目录
536536

537-
(v3.3.4 新增)用于清理积攒了太多旧文件的数据目录,如 `image`。有异步版本 `/clean_data_dir_async`
537+
用于清理积攒了太多旧文件的数据目录,如 `image`。有异步版本 `/clean_data_dir_async`
538538

539539
#### 参数
540540

docs/3.4/Configuration.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,5 @@ secret=kP9yK2lrGxoymmpo
5656
| `auto_perform_update` | `no` | 是否自动执行更新,仅在 `auto_check_update` 启用时有效,`yes``true` 表示启用,否则不启用,若启用,则插件将在自动检查更新后,自动下载新版本并重启酷 Q 生效 |
5757
| `thread_pool_size` | `4` | 工作线程池大小,用于异步发送消息和一些其它小的异步任务,应根据计算机性能和实际需求适当调节,若设为 0,则使用 `CPU 核心数 * 2 + 1` |
5858
| `server_thread_pool_size` | `1` | API 服务器线程池大小,用于异步处理请求,应根据计算机性能和实际需求适当调节,若设为 0,则使用 `CPU 核心数 * 2 + 1` |
59-
| `convert_unicode_emoji` | `yes` | (v3.3.4 新增)是否在 CQ:emoji 和实际的 Unicode 之间进行转换,转换可能耗更多时间,但日常情况下影响不大,如果你的机器人需要处理非常大段的消息(上千字),且对性能有要求,可以考虑关闭转换 |
59+
| `convert_unicode_emoji` | `yes` | 是否在 CQ:emoji 和实际的 Unicode 之间进行转换,转换可能耗更多时间,但日常情况下影响不大,如果你的机器人需要处理非常大段的消息(上千字),且对性能有要求,可以考虑关闭转换 |
60+
| `use_filter` | `no` | 是否开启事件过滤器,见 [事件过滤器](/EventFilter) |

docs/3.4/EventFilter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**注:目前过滤机制还在测试阶段,可能有破坏性的 bug,请酌情使用。**
44

5-
`app\io.github.richardchien.coolqhttpapi` 文件夹下创建 `filter.json` 文件即可启用事件过滤器,过滤规则使用 JSON 编写。
5+
将配置项 `use_filter` 设置为 `yes` 即可开启事件过滤器,插件启动时会在 `app\io.github.richardchien.coolqhttpapi` 文件夹下读取 `filter.json` 文件中定义的过滤规则(使用 JSON 编写),若文件不存在,或过滤规则语法错误,则会暂停所有上报
66

77
## 示例
88

docs/3.4/Post.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ ctx.assert(ctx.request.headers['x-signature'] === `sha1=${sig}`, 403);
115115
| `post_type` | string | `"message"` | 上报类型 |
116116
| `message_type` | string | `"private"` | 消息类型 |
117117
| `sub_type` | string | `"friend"``"group"``"discuss"``"other"` | 消息子类型,如果是好友则是 `"friend"`,如果从群或讨论组来的临时会话则分别是 `"group"``"discuss"` |
118-
| `message_id` | number | - | (v3.3.1 新增)消息 ID |
118+
| `message_id` | number | - | 消息 ID |
119119
| `user_id` | number | - | 发送者 QQ 号 |
120120
| `message` | string/array | - | 消息内容 |
121121
| `font` | number | - | 字体 |
@@ -153,7 +153,7 @@ ctx.assert(ctx.request.headers['x-signature'] === `sha1=${sig}`, 403);
153153
| `post_type` | string | `"message"` | 上报类型 |
154154
| `message_type` | string | `"group"` | 消息类型 |
155155
| `sub_type` | string | `"normal"``"anonymous"``"notice"` | 消息子类型,正常消息是 `"normal"`,匿名消息是 `"anonymous"`,系统提示(如「管理员已禁止群内匿名聊天」)是 `"notice"` |
156-
| `message_id` | number | - | (v3.3.1 新增)消息 ID |
156+
| `message_id` | number | - | 消息 ID |
157157
| `group_id` | number | - | 群号 |
158158
| `user_id` | number | - | 发送者 QQ 号 |
159159
| `anonymous` | string | - | 匿名用户显示名 |
@@ -168,7 +168,7 @@ ctx.assert(ctx.request.headers['x-signature'] === `sha1=${sig}`, 403);
168168
| `reply` | string/array | 要回复的内容 | 不回复 |
169169
| `auto_escape` | boolean | 消息内容是否作为纯文本发送(即不解析 CQ 码),`message` 数据类型为 `array` 时无效 | 不转义 |
170170
| `at_sender` | boolean | 是否要在回复开头 at 发送者(自动添加),发送者是匿名用户时无效 | at 发送者 |
171-
| `delete` | boolean | (v3.3.1 新增)撤回该条消息 | 不撤回 |
171+
| `delete` | boolean | 撤回该条消息 | 不撤回 |
172172
| `kick` | boolean | 把发送者踢出群组(需要登录号权限足够),**不拒绝**此人后续加群请求,发送者是匿名用户时无效 | 不踢 |
173173
| `ban` | boolean | 把发送者禁言 30 分钟(需要登录号权限足够),对匿名用户也有效,不支持指定禁言时长(如需指定,请调用相应 API) | 不禁言 |
174174

@@ -180,7 +180,7 @@ ctx.assert(ctx.request.headers['x-signature'] === `sha1=${sig}`, 403);
180180
| ----- | ------- | ------- | --- |
181181
| `post_type` | string | `"message"` | 上报类型 |
182182
| `message_type` | string | `"discuss"` | 消息类型 |
183-
| `message_id` | number | - | (v3.3.1 新增)消息 ID |
183+
| `message_id` | number | - | 消息 ID |
184184
| `discuss_id` | number | - | 讨论组 ID |
185185
| `user_id` | number | - | 发送者 QQ 号 |
186186
| `message` | string/array | - | 消息内容 |

0 commit comments

Comments
 (0)