瀏覽代碼

Update api docs

ryoii 3 年之前
父節點
當前提交
301725e56e
共有 4 個文件被更改,包括 96 次插入2 次删除
  1. 34 0
      docs/adapter/HttpAdapter.md
  2. 30 0
      docs/adapter/ReverseWebsocketAdapter.md
  3. 30 0
      docs/adapter/WebsocketAdapter.md
  4. 2 2
      docs/api/API.md

+ 34 - 0
docs/adapter/HttpAdapter.md

@@ -99,6 +99,10 @@ adapterSettings:
   + [添加好友申请](#添加好友申请)
   + [用户入群申请](#用户入群申请)
   + [Bot被邀请入群申请](#Bot被邀请入群申请)
++ **[Console命令](#Console命令)**
+  + [执行命令](#执行命令)
+  + [注册命令](#注册命令)
+  + [命令接收](#命令接收)
 
 ## 认证与会话
 
@@ -917,3 +921,33 @@ adapterSettings:
 **本接口为[POST]请求, 参数格式为`application/json`**
 
 通用接口定义: [Bot被邀请入群申请](../api/API.md#Bot被邀请入群申请)
+
+## Console命令
+
+### 执行命令
+
+使用此方法向 console 提交一个消息作为命令执行
+
+```
+[POST] /cmd/execute
+```
+
+**本接口为[POST]请求, 参数格式为`application/json`**
+
+通用接口定义: [执行命令](../api/API.md#执行命令)
+
+### 注册命令
+
+使用此方法向 console 注册一个指令, 当指令触发时, 会生成一个 [CommandExecutedEvent](../api/EventType.md#命令被执行)
+
+```
+[POST] /cmd/register
+```
+
+**本接口为[POST]请求, 参数格式为`application/json`**
+
+通用接口定义: [执行命令](../api/API.md#注册命令)
+
+### 命令接收
+
+命令被调用时, 会触发 [CommandExecutedEvent](../api/EventType.md#命令被执行)

+ 30 - 0
docs/adapter/ReverseWebsocketAdapter.md

@@ -107,6 +107,10 @@ adapterSettings:
   + [添加好友申请](#添加好友申请)
   + [用户入群申请](#用户入群申请)
   + [Bot被邀请入群申请](#Bot被邀请入群申请)
++ **[Console命令](#Console命令)**
+  + [执行命令](#执行命令)
+  + [注册命令](#注册命令)
+  + [命令接收](#命令接收)
 
 ## 认证与会话
 
@@ -572,3 +576,29 @@ adapterSettings:
 ```
 
 通用接口定义: [Bot被邀请入群申请](../api/API.md#Bot被邀请入群申请)
+
+## Console命令
+
+### 执行命令
+
+使用此方法向 console 提交一个消息作为命令执行
+
+```
+命令字: cmd_execute
+```
+
+通用接口定义: [执行命令](../api/API.md#执行命令)
+
+### 注册命令
+
+使用此方法向 console 注册一个指令, 当指令触发时, 会生成一个 [CommandExecutedEvent](../api/EventType.md#命令被执行)
+
+```
+命令字: cmd_register
+```
+
+通用接口定义: [执行命令](../api/API.md#注册命令)
+
+### 命令接收
+
+命令被调用时, 会触发 [CommandExecutedEvent](../api/EventType.md#命令被执行)

+ 30 - 0
docs/adapter/WebsocketAdapter.md

@@ -88,6 +88,10 @@ adapterSettings:
   + [添加好友申请](#添加好友申请)
   + [用户入群申请](#用户入群申请)
   + [Bot被邀请入群申请](#Bot被邀请入群申请)
++ **[Console命令](#Console命令)**
+  + [执行命令](#执行命令)
+  + [注册命令](#注册命令)
+  + [命令接收](#命令接收)
 
 ## 认证与会话
 
@@ -578,3 +582,29 @@ adapterSettings:
 ```
 
 通用接口定义: [Bot被邀请入群申请](../api/API.md#Bot被邀请入群申请)
+
+## Console命令
+
+### 执行命令
+
+使用此方法向 console 提交一个消息作为命令执行
+
+```
+命令字: cmd_execute
+```
+
+通用接口定义: [执行命令](../api/API.md#执行命令)
+
+### 注册命令
+
+使用此方法向 console 注册一个指令, 当指令触发时, 会生成一个 [CommandExecutedEvent](../api/EventType.md#命令被执行)
+
+```
+命令字: cmd_register
+```
+
+通用接口定义: [执行命令](../api/API.md#注册命令)
+
+### 命令接收
+
+命令被调用时, 会触发 [CommandExecutedEvent](../api/EventType.md#命令被执行)

+ 2 - 2
docs/api/API.md

@@ -63,7 +63,7 @@
   + [添加好友申请](#添加好友申请)
   + [用户入群申请](#用户入群申请(Bot需要有管理员权限))
   + [Bot被邀请入群申请](#Bot被邀请入群申请)
-+ **[命令(Console Command)](# 命令(Console Command))**
++ **[Console命令](#Console命令)**
   + [执行命令](#执行命令)
   + [注册命令](#注册命令)
   + [命令接收](#命令接收)
@@ -1453,7 +1453,7 @@
 | 1       | 拒绝邀请                                       |
 
 
-## 命令(Console Command)
+## Console命令
 
 ### 执行命令