📝 update api docs

This commit is contained in:
StarHeartHunt 2021-01-20 23:42:48 +00:00
parent a028766cf8
commit de0bca5c51
2 changed files with 21 additions and 18 deletions

View File

@ -17,21 +17,25 @@ sidebarDepth: 0
Bot 基类。用于处理上报消息,并提供 API 调用接口。 Bot 基类。用于处理上报消息,并提供 API 调用接口。
### _abstract_ `__init__(driver, connection_type, config, self_id, *, websocket=None)` ### `driver`
Driver 对象
### `config`
Config 配置对象
### _abstract_ `__init__(connection_type, self_id, *, websocket=None)`
* **参数** * **参数**
* `driver: Driver`: Driver 对象
* `connection_type: str`: http 或者 websocket * `connection_type: str`: http 或者 websocket
* `config: Config`: Config 对象
* `self_id: str`: 机器人 ID * `self_id: str`: 机器人 ID
@ -39,21 +43,11 @@ Bot 基类。用于处理上报消息,并提供 API 调用接口。
### `driver`
Driver 对象
### `connection_type` ### `connection_type`
连接类型 连接类型
### `config`
Config 配置对象
### `self_id` ### `self_id`
机器人 ID 机器人 ID
@ -69,6 +63,15 @@ Websocket 连接对象
Adapter 类型 Adapter 类型
### _classmethod_ `register(driver, config)`
* **说明**
register 方法会在 driver.register_adapter 时被调用,用于初始化相关配置
### _abstract async classmethod_ `check_permission(driver, connection_type, headers, body)` ### _abstract async classmethod_ `check_permission(driver, connection_type, headers, body)`

View File

@ -120,7 +120,7 @@ Driver 基类。将后端框架封装,以满足适配器使用。
### _classmethod_ `register_adapter(name, adapter)` ### `register_adapter(name, adapter)`
* **说明** * **说明**