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

Commit f037025

Browse files
committed
Update docs
1 parent 269982d commit f037025

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

docs/3.3/API.md

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

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

532533
533534

535+
### `/clean_data_dir` 清理数据目录
536+
537+
(v3.3.4 新增)用于清理积攒了太多旧文件的数据目录,如 `image`。有异步版本 `/clean_data_dir_async`
538+
539+
#### 参数
540+
541+
| 字段名 | 数据类型 | 默认值 | 说明 |
542+
| ----- | ------- | ----- | --- |
543+
| `data_dir` | string | - | 收到清理的目录名,支持 `image``record``show``bface` |
544+
545+
#### 响应数据
546+
547+
548+
534549
## API 列表(试验性)
535550

536551
试验性 API 可以一定程度上增强实用性,但它们并非酷 Q 原生提供的接口,不保证随时可用,且接口可能会在后面的版本中发生变动。

docs/3.3/Configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,4 @@ 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 之间进行转换,转换可能耗更多时间,但日常情况下影响不大,如果你的机器人需要处理非常大段的消息(上千字),且对性能有要求,可以考虑关闭转换 |

0 commit comments

Comments
 (0)