mirror of
https://github.com/nonebot/nonebot2.git
synced 2025-10-31 06:56:39 +00:00
📝 update docs
This commit is contained in:
yanyongyu
@@ -17,6 +17,16 @@ sidebarDepth: 0
|
||||
Bot 基类。用于处理上报消息，并提供 API 调用接口。
|
||||
|
||||
|
||||
### `driver`
|
||||
|
||||
Driver 对象
|
||||
|
||||
|
||||
### `config`
|
||||
|
||||
Config 配置对象
|
||||
|
||||
|
||||
### _abstract_ `__init__(connection_type, self_id, *, websocket=None)`
|
||||
|
||||
|
||||
@@ -33,34 +43,35 @@ Bot 基类。用于处理上报消息，并提供 API 调用接口。
|
||||
|
||||
|
||||
|
||||
### _abstract async_ `call_api(api, **data)`
|
||||
### `connection_type`
|
||||
|
||||
连接类型
|
||||
|
||||
|
||||
### `self_id`
|
||||
|
||||
机器人 ID
|
||||
|
||||
|
||||
### `websocket`
|
||||
|
||||
Websocket 连接对象
|
||||
|
||||
|
||||
### _abstract property_ `type`
|
||||
|
||||
Adapter 类型
|
||||
|
||||
|
||||
### _classmethod_ `register(driver, config)`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
调用机器人 API 接口，可以通过该函数或直接通过 bot 属性进行调用
|
||||
register 方法会在 driver.register_adapter 时被调用，用于初始化相关配置
|
||||
|
||||
|
||||
|
||||
* **参数**
|
||||
|
||||
|
||||
* `api: str`: API 名称
|
||||
|
||||
|
||||
* `**data`: API 数据
|
||||
|
||||
|
||||
|
||||
* **示例**
|
||||
|
||||
|
||||
```python
|
||||
await bot.call_api("send_msg", message="hello world")
|
||||
await bot.send_msg(message="hello world")
|
||||
```
|
||||
|
||||
|
||||
### _abstract async classmethod_ `check_permission(driver, connection_type, headers, body)`
|
||||
|
||||
|
||||
@@ -116,15 +127,34 @@ await bot.send_msg(message="hello world")
|
||||
|
||||
|
||||
|
||||
### _classmethod_ `register(driver, config)`
|
||||
### _abstract async_ `call_api(api, **data)`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
register 方法会在 driver.register_adapter 时被调用，用于初始化相关配置
|
||||
调用机器人 API 接口，可以通过该函数或直接通过 bot 属性进行调用
|
||||
|
||||
|
||||
|
||||
* **参数**
|
||||
|
||||
|
||||
* `api: str`: API 名称
|
||||
|
||||
|
||||
* `**data`: API 数据
|
||||
|
||||
|
||||
|
||||
* **示例**
|
||||
|
||||
|
||||
```python
|
||||
await bot.call_api("send_msg", message="hello world")
|
||||
await bot.send_msg(message="hello world")
|
||||
```
|
||||
|
||||
|
||||
### _abstract async_ `send(event, message, **kwargs)`
|
||||
|
||||
|
||||
@@ -147,167 +177,29 @@ await bot.send_msg(message="hello world")
|
||||
|
||||
|
||||
|
||||
### _abstract property_ `type`
|
||||
## _class_ `MessageSegment`
|
||||
|
||||
Adapter 类型
|
||||
基类：`abc.ABC`
|
||||
|
||||
消息段基类
|
||||
|
||||
## _class_ `Event`
|
||||
|
||||
基类：`abc.ABC`, `pydantic.main.BaseModel`
|
||||
### `type`
|
||||
|
||||
Event 基类。提供获取关键信息的方法，其余信息可直接获取。
|
||||
|
||||
* 类型: `str`
|
||||
|
||||
### _abstract_ `get_event_description()`
|
||||
|
||||
* 说明: 消息段类型
|
||||
|
||||
* **说明**
|
||||
|
||||
获取事件描述的方法，通常为事件具体内容。
|
||||
### `data`
|
||||
|
||||
|
||||
* 类型: `Dict[str, Union[str, list]]`
|
||||
|
||||
* **返回**
|
||||
|
||||
|
||||
* `str`
|
||||
|
||||
|
||||
|
||||
### _abstract_ `get_event_name()`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
获取事件名称的方法。
|
||||
|
||||
|
||||
|
||||
* **返回**
|
||||
|
||||
|
||||
* `str`
|
||||
|
||||
|
||||
|
||||
### `get_log_string()`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
获取事件日志信息的方法，通常你不需要修改这个方法，只有当希望 NoneBot 隐藏该事件日志时，可以抛出 `NoLogException` 异常。
|
||||
|
||||
|
||||
|
||||
* **返回**
|
||||
|
||||
|
||||
* `str`
|
||||
|
||||
|
||||
|
||||
* **异常**
|
||||
|
||||
|
||||
* `NoLogException`
|
||||
|
||||
|
||||
|
||||
### _abstract_ `get_message()`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
获取事件消息内容的方法。
|
||||
|
||||
|
||||
|
||||
* **返回**
|
||||
|
||||
|
||||
* `Message`
|
||||
|
||||
|
||||
|
||||
### `get_plaintext()`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
获取消息纯文本的方法，通常不需要修改，默认通过 `get_message().extract_plain_text` 获取。
|
||||
|
||||
|
||||
|
||||
* **返回**
|
||||
|
||||
|
||||
* `str`
|
||||
|
||||
|
||||
|
||||
### _abstract_ `get_session_id()`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
获取会话 id 的方法，用于判断当前事件属于哪一个会话，通常是用户 id、群组 id 组合。
|
||||
|
||||
|
||||
|
||||
* **返回**
|
||||
|
||||
|
||||
* `str`
|
||||
|
||||
|
||||
|
||||
### _abstract_ `get_type()`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
获取事件类型的方法，类型通常为 NoneBot 内置的四种类型。
|
||||
|
||||
|
||||
|
||||
* **返回**
|
||||
|
||||
|
||||
* `Literal["message", "notice", "request", "meta_event"]`
|
||||
|
||||
|
||||
|
||||
### _abstract_ `get_user_id()`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
获取事件主体 id 的方法，通常是用户 id 。
|
||||
|
||||
|
||||
|
||||
* **返回**
|
||||
|
||||
|
||||
* `str`
|
||||
|
||||
|
||||
|
||||
### _abstract_ `is_tome()`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
获取事件是否与机器人有关的方法。
|
||||
|
||||
|
||||
|
||||
* **返回**
|
||||
|
||||
|
||||
* `bool`
|
||||
|
||||
* 说明: 消息段数据
|
||||
|
||||
|
||||
## _class_ `Message`
|
||||
@@ -359,15 +251,6 @@ Event 基类。提供获取关键信息的方法，其余信息可直接获取
|
||||
|
||||
|
||||
|
||||
### `extract_plain_text()`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
提取消息内纯文本消息
|
||||
|
||||
|
||||
|
||||
### `reduce()`
|
||||
|
||||
|
||||
@@ -377,8 +260,167 @@ Event 基类。提供获取关键信息的方法，其余信息可直接获取
|
||||
|
||||
|
||||
|
||||
## _class_ `MessageSegment`
|
||||
### `extract_plain_text()`
|
||||
|
||||
基类：`abc.ABC`
|
||||
|
||||
消息段基类
|
||||
* **说明**
|
||||
|
||||
提取消息内纯文本消息
|
||||
|
||||
|
||||
|
||||
## _class_ `Event`
|
||||
|
||||
基类：`abc.ABC`, `pydantic.main.BaseModel`
|
||||
|
||||
Event 基类。提供获取关键信息的方法，其余信息可直接获取。
|
||||
|
||||
|
||||
### _abstract_ `get_type()`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
获取事件类型的方法，类型通常为 NoneBot 内置的四种类型。
|
||||
|
||||
|
||||
|
||||
* **返回**
|
||||
|
||||
|
||||
* `Literal["message", "notice", "request", "meta_event"]`
|
||||
|
||||
|
||||
|
||||
### _abstract_ `get_event_name()`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
获取事件名称的方法。
|
||||
|
||||
|
||||
|
||||
* **返回**
|
||||
|
||||
|
||||
* `str`
|
||||
|
||||
|
||||
|
||||
### _abstract_ `get_event_description()`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
获取事件描述的方法，通常为事件具体内容。
|
||||
|
||||
|
||||
|
||||
* **返回**
|
||||
|
||||
|
||||
* `str`
|
||||
|
||||
|
||||
|
||||
### `get_log_string()`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
获取事件日志信息的方法，通常你不需要修改这个方法，只有当希望 NoneBot 隐藏该事件日志时，可以抛出 `NoLogException` 异常。
|
||||
|
||||
|
||||
|
||||
* **返回**
|
||||
|
||||
|
||||
* `str`
|
||||
|
||||
|
||||
|
||||
* **异常**
|
||||
|
||||
|
||||
* `NoLogException`
|
||||
|
||||
|
||||
|
||||
### _abstract_ `get_user_id()`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
获取事件主体 id 的方法，通常是用户 id 。
|
||||
|
||||
|
||||
|
||||
* **返回**
|
||||
|
||||
|
||||
* `str`
|
||||
|
||||
|
||||
|
||||
### _abstract_ `get_session_id()`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
获取会话 id 的方法，用于判断当前事件属于哪一个会话，通常是用户 id、群组 id 组合。
|
||||
|
||||
|
||||
|
||||
* **返回**
|
||||
|
||||
|
||||
* `str`
|
||||
|
||||
|
||||
|
||||
### _abstract_ `get_message()`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
获取事件消息内容的方法。
|
||||
|
||||
|
||||
|
||||
* **返回**
|
||||
|
||||
|
||||
* `Message`
|
||||
|
||||
|
||||
|
||||
### `get_plaintext()`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
获取消息纯文本的方法，通常不需要修改，默认通过 `get_message().extract_plain_text` 获取。
|
||||
|
||||
|
||||
|
||||
* **返回**
|
||||
|
||||
|
||||
* `str`
|
||||
|
||||
|
||||
|
||||
### _abstract_ `is_tome()`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
获取事件是否与机器人有关的方法。
|
||||
|
||||
|
||||
|
||||
* **返回**
|
||||
|
||||
|
||||
* `bool`
|
||||
|
||||
@@ -193,7 +193,7 @@ CQHTTP 配置类
|
||||
|
||||
## _class_ `Bot`
|
||||
|
||||
基类：[`nonebot.adapters.Bot`](README.md#nonebot.adapters.Bot)
|
||||
基类：[`nonebot.adapters._base.Bot`](README.md#nonebot.adapters._base.Bot)
|
||||
|
||||
CQHTTP 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
|
||||
|
||||
@@ -307,14 +307,14 @@ CQHTTP 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
|
||||
|
||||
## _class_ `MessageSegment`
|
||||
|
||||
基类：[`nonebot.adapters.MessageSegment`](README.md#nonebot.adapters.MessageSegment)
|
||||
基类：[`nonebot.adapters._base.MessageSegment`](README.md#nonebot.adapters._base.MessageSegment)
|
||||
|
||||
CQHTTP 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。
|
||||
|
||||
|
||||
## _class_ `Message`
|
||||
|
||||
基类：[`nonebot.adapters.Message`](README.md#nonebot.adapters.Message)
|
||||
基类：[`nonebot.adapters._base.Message`](README.md#nonebot.adapters._base.Message)
|
||||
|
||||
CQHTTP 协议 Message 适配。
|
||||
|
||||
@@ -377,7 +377,7 @@ CQHTTP 协议 Message 适配。
|
||||
|
||||
## _class_ `Event`
|
||||
|
||||
基类：[`nonebot.adapters.Event`](README.md#nonebot.adapters.Event)
|
||||
基类：[`nonebot.adapters._base.Event`](README.md#nonebot.adapters._base.Event)
|
||||
|
||||
CQHTTP 协议事件，字段与 CQHTTP 一致。各事件字段参考 [CQHTTP 文档](https://github.com/howmanybots/onebot/blob/master/README.md)
|
||||
|
||||
|
||||
@@ -94,7 +94,7 @@ sidebarDepth: 0
|
||||
|
||||
## _class_ `Bot`
|
||||
|
||||
基类：[`nonebot.adapters.Bot`](README.md#nonebot.adapters.Bot)
|
||||
基类：[`nonebot.adapters._base.Bot`](README.md#nonebot.adapters._base.Bot)
|
||||
|
||||
钉钉 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
|
||||
|
||||
@@ -199,7 +199,7 @@ sidebarDepth: 0
|
||||
|
||||
## _class_ `MessageSegment`
|
||||
|
||||
基类：[`nonebot.adapters.MessageSegment`](README.md#nonebot.adapters.MessageSegment)
|
||||
基类：[`nonebot.adapters._base.MessageSegment`](README.md#nonebot.adapters._base.MessageSegment)
|
||||
|
||||
钉钉 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。
|
||||
|
||||
@@ -283,7 +283,7 @@ message += MessageSegment.atDingtalkIds(event.senderId)
|
||||
|
||||
## _class_ `Message`
|
||||
|
||||
基类：[`nonebot.adapters.Message`](README.md#nonebot.adapters.Message)
|
||||
基类：[`nonebot.adapters._base.Message`](README.md#nonebot.adapters._base.Message)
|
||||
|
||||
钉钉 协议 Message 适配。
|
||||
|
||||
@@ -292,7 +292,7 @@ message += MessageSegment.atDingtalkIds(event.senderId)
|
||||
|
||||
## _class_ `Event`
|
||||
|
||||
基类：[`nonebot.adapters.Event`](README.md#nonebot.adapters.Event)
|
||||
基类：[`nonebot.adapters._base.Event`](README.md#nonebot.adapters._base.Event)
|
||||
|
||||
钉钉协议事件。各事件字段参考 [钉钉文档](https://ding-doc.dingtalk.com/document#/org-dev-guide/elzz1p)
|
||||
|
||||
|
||||
@@ -117,7 +117,7 @@ Bot会话管理器, 提供API主动调用接口
|
||||
|
||||
## _class_ `Bot`
|
||||
|
||||
基类：[`nonebot.adapters.Bot`](README.md#nonebot.adapters.Bot)
|
||||
基类：[`nonebot.adapters._base.Bot`](README.md#nonebot.adapters._base.Bot)
|
||||
|
||||
mirai-api-http 协议 Bot 适配。
|
||||
|
||||
@@ -722,7 +722,7 @@ mirai-api-http 正向 Websocket 协议 Bot 适配。
|
||||
|
||||
## _class_ `MessageSegment`
|
||||
|
||||
基类：[`nonebot.adapters.MessageSegment`](README.md#nonebot.adapters.MessageSegment)
|
||||
基类：[`nonebot.adapters._base.MessageSegment`](README.md#nonebot.adapters._base.MessageSegment)
|
||||
|
||||
CQHTTP 协议 MessageSegment 适配。具体方法参考 [mirai-api-http 消息类型](https://github.com/project-mirai/mirai-api-http/blob/master/docs/MessageType.md)
|
||||
|
||||
@@ -963,7 +963,7 @@ CQHTTP 协议 MessageSegment 适配。具体方法参考 [mirai-api-http 消息
|
||||
|
||||
## _class_ `MessageChain`
|
||||
|
||||
基类：[`nonebot.adapters.Message`](README.md#nonebot.adapters.Message)
|
||||
基类：[`nonebot.adapters._base.Message`](README.md#nonebot.adapters._base.Message)
|
||||
|
||||
Mirai 协议 Message 适配
|
||||
|
||||
@@ -1060,7 +1060,7 @@ Mirai 协议 Message 适配
|
||||
|
||||
## _class_ `Event`
|
||||
|
||||
基类：[`nonebot.adapters.Event`](README.md#nonebot.adapters.Event)
|
||||
基类：[`nonebot.adapters._base.Event`](README.md#nonebot.adapters._base.Event)
|
||||
|
||||
mirai-api-http 协议事件，字段与 mirai-api-http 一致。各事件字段参考 [mirai-api-http 事件类型](https://github.com/project-mirai/mirai-api-http/blob/master/docs/EventType.md)
|
||||
|
||||
@@ -1486,7 +1486,7 @@ Bot被邀请入群申请
|
||||
|
||||
## _class_ `Event`
|
||||
|
||||
基类：[`nonebot.adapters.Event`](README.md#nonebot.adapters.Event)
|
||||
基类：[`nonebot.adapters._base.Event`](README.md#nonebot.adapters._base.Event)
|
||||
|
||||
mirai-api-http 协议事件，字段与 mirai-api-http 一致。各事件字段参考 [mirai-api-http 事件类型](https://github.com/project-mirai/mirai-api-http/blob/master/docs/EventType.md)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user