mirror of
https://github.com/nonebot/nonebot2.git
synced 2024-12-12 14:35:45 +08:00
565 lines
7.9 KiB
Markdown
565 lines
7.9 KiB
Markdown
|
---
|
||
|
contentSidebar: true
|
||
|
sidebarDepth: 0
|
||
|
---
|
||
|
|
||
|
# NoneBot.adapters.cqhttp 模块
|
||
|
|
||
|
## CQHTTP (OneBot) v11 协议适配
|
||
|
|
||
|
协议详情请看: [CQHTTP](https://github.com/howmanybots/onebot/blob/master/README.md) | [OneBot](https://github.com/howmanybots/onebot/blob/master/README.md)
|
||
|
|
||
|
# NoneBot.adapters.cqhttp.utils 模块
|
||
|
|
||
|
|
||
|
## `escape(s, *, escape_comma=True)`
|
||
|
|
||
|
|
||
|
* **说明**
|
||
|
|
||
|
对字符串进行 CQ 码转义。
|
||
|
|
||
|
|
||
|
|
||
|
* **参数**
|
||
|
|
||
|
|
||
|
* `s: str`: 需要转义的字符串
|
||
|
|
||
|
|
||
|
* `escape_comma: bool`: 是否转义逗号(`,`)。
|
||
|
|
||
|
|
||
|
|
||
|
## `unescape(s)`
|
||
|
|
||
|
|
||
|
* **说明**
|
||
|
|
||
|
对字符串进行 CQ 码去转义。
|
||
|
|
||
|
|
||
|
|
||
|
* **参数**
|
||
|
|
||
|
|
||
|
* `s: str`: 需要转义的字符串
|
||
|
|
||
|
|
||
|
# NoneBot.adapters.cqhttp.exception 模块
|
||
|
|
||
|
|
||
|
## _exception_ `ActionFailed`
|
||
|
|
||
|
基类:[`nonebot.exception.ActionFailed`](../exception.md#nonebot.exception.ActionFailed), `nonebot.adapters.cqhttp.exception.CQHTTPAdapterException`
|
||
|
|
||
|
|
||
|
* **说明**
|
||
|
|
||
|
API 请求返回错误信息。
|
||
|
|
||
|
|
||
|
|
||
|
* **参数**
|
||
|
|
||
|
|
||
|
* `retcode: Optional[int]`: 错误码
|
||
|
|
||
|
|
||
|
|
||
|
## _exception_ `NetworkError`
|
||
|
|
||
|
基类:[`nonebot.exception.NetworkError`](../exception.md#nonebot.exception.NetworkError), `nonebot.adapters.cqhttp.exception.CQHTTPAdapterException`
|
||
|
|
||
|
|
||
|
* **说明**
|
||
|
|
||
|
网络错误。
|
||
|
|
||
|
|
||
|
|
||
|
* **参数**
|
||
|
|
||
|
|
||
|
* `retcode: Optional[int]`: 错误码
|
||
|
|
||
|
|
||
|
# NoneBot.adapters.cqhttp.bot 模块
|
||
|
|
||
|
|
||
|
## _async_ `_check_reply(bot, event)`
|
||
|
|
||
|
|
||
|
* **说明**
|
||
|
|
||
|
检查消息中存在的回复,去除并赋值 `event.reply`, `event.to_me`
|
||
|
|
||
|
|
||
|
|
||
|
* **参数**
|
||
|
|
||
|
|
||
|
* `bot: Bot`: Bot 对象
|
||
|
|
||
|
|
||
|
* `event: Event`: Event 对象
|
||
|
|
||
|
|
||
|
|
||
|
## `_check_at_me(bot, event)`
|
||
|
|
||
|
|
||
|
* **说明**
|
||
|
|
||
|
检查消息开头或结尾是否存在 @机器人,去除并赋值 `event.to_me`
|
||
|
|
||
|
|
||
|
|
||
|
* **参数**
|
||
|
|
||
|
|
||
|
* `bot: Bot`: Bot 对象
|
||
|
|
||
|
|
||
|
* `event: Event`: Event 对象
|
||
|
|
||
|
|
||
|
|
||
|
## `_check_nickname(bot, event)`
|
||
|
|
||
|
|
||
|
* **说明**
|
||
|
|
||
|
检查消息开头是否存在,去除并赋值 `event.to_me`
|
||
|
|
||
|
|
||
|
|
||
|
* **参数**
|
||
|
|
||
|
|
||
|
* `bot: Bot`: Bot 对象
|
||
|
|
||
|
|
||
|
* `event: Event`: Event 对象
|
||
|
|
||
|
|
||
|
|
||
|
## `_handle_api_result(result)`
|
||
|
|
||
|
|
||
|
* **说明**
|
||
|
|
||
|
处理 API 请求返回值。
|
||
|
|
||
|
|
||
|
|
||
|
* **参数**
|
||
|
|
||
|
|
||
|
* `result: Optional[Dict[str, Any]]`: API 返回数据
|
||
|
|
||
|
|
||
|
|
||
|
* **返回**
|
||
|
|
||
|
|
||
|
* `Any`: API 调用返回数据
|
||
|
|
||
|
|
||
|
|
||
|
* **异常**
|
||
|
|
||
|
|
||
|
* `ActionFailed`: API 调用失败
|
||
|
|
||
|
|
||
|
|
||
|
## _class_ `Bot`
|
||
|
|
||
|
基类:[`nonebot.adapters.Bot`](README.md#nonebot.adapters.Bot)
|
||
|
|
||
|
CQHTTP 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
|
||
|
|
||
|
|
||
|
### _property_ `type`
|
||
|
|
||
|
|
||
|
* 返回: `"cqhttp"`
|
||
|
|
||
|
|
||
|
### _async classmethod_ `check_permission(driver, connection_type, headers, body)`
|
||
|
|
||
|
|
||
|
* **说明**
|
||
|
|
||
|
CQHTTP (OneBot) 协议鉴权。参考 [鉴权](https://github.com/howmanybots/onebot/blob/master/v11/specs/communication/authorization.md)
|
||
|
|
||
|
|
||
|
|
||
|
### _async_ `handle_message(message)`
|
||
|
|
||
|
|
||
|
* **说明**
|
||
|
|
||
|
调用 [_check_reply](#async-check-reply-bot-event), [_check_at_me](#check-at-me-bot-event), [_check_nickname](#check-nickname-bot-event) 处理事件并转换为 [Event](#class-event)
|
||
|
|
||
|
|
||
|
|
||
|
### _async_ `call_api(api, **data)`
|
||
|
|
||
|
|
||
|
* **说明**
|
||
|
|
||
|
调用 CQHTTP 协议 API
|
||
|
|
||
|
|
||
|
|
||
|
* **参数**
|
||
|
|
||
|
|
||
|
* `api: str`: API 名称
|
||
|
|
||
|
|
||
|
* `**data: Any`: API 参数
|
||
|
|
||
|
|
||
|
|
||
|
* **返回**
|
||
|
|
||
|
|
||
|
* `Any`: API 调用返回数据
|
||
|
|
||
|
|
||
|
|
||
|
* **异常**
|
||
|
|
||
|
|
||
|
* `NetworkError`: 网络错误
|
||
|
|
||
|
|
||
|
* `ActionFailed`: API 调用失败
|
||
|
|
||
|
|
||
|
|
||
|
### _async_ `send(event, message, at_sender=False, **kwargs)`
|
||
|
|
||
|
|
||
|
* **说明**
|
||
|
|
||
|
根据 `event` 向触发事件的主体发送消息。
|
||
|
|
||
|
|
||
|
|
||
|
* **参数**
|
||
|
|
||
|
|
||
|
* `event: Event`: Event 对象
|
||
|
|
||
|
|
||
|
* `message: Union[str, Message, MessageSegment]`: 要发送的消息
|
||
|
|
||
|
|
||
|
* `at_sender: bool`: 是否 @ 事件主体
|
||
|
|
||
|
|
||
|
* `**kwargs`: 覆盖默认参数
|
||
|
|
||
|
|
||
|
|
||
|
* **返回**
|
||
|
|
||
|
|
||
|
* `Any`: API 调用返回数据
|
||
|
|
||
|
|
||
|
|
||
|
* **异常**
|
||
|
|
||
|
|
||
|
* `ValueError`: 缺少 `user_id`, `group_id`
|
||
|
|
||
|
|
||
|
* `NetworkError`: 网络错误
|
||
|
|
||
|
|
||
|
* `ActionFailed`: API 调用失败
|
||
|
|
||
|
|
||
|
# NoneBot.adapters.cqhttp.message 模块
|
||
|
|
||
|
|
||
|
## _class_ `MessageSegment`
|
||
|
|
||
|
基类:[`nonebot.adapters.MessageSegment`](README.md#nonebot.adapters.MessageSegment)
|
||
|
|
||
|
CQHTTP 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。
|
||
|
|
||
|
|
||
|
## _class_ `Message`
|
||
|
|
||
|
基类:[`nonebot.adapters.Message`](README.md#nonebot.adapters.Message)
|
||
|
|
||
|
CQHTTP 协议 Message 适配。
|
||
|
|
||
|
# NoneBot.adapters.cqhttp.permission 模块
|
||
|
|
||
|
|
||
|
## `PRIVATE`
|
||
|
|
||
|
|
||
|
* **说明**: 匹配任意私聊消息类型事件
|
||
|
|
||
|
|
||
|
## `PRIVATE_FRIEND`
|
||
|
|
||
|
|
||
|
* **说明**: 匹配任意好友私聊消息类型事件
|
||
|
|
||
|
|
||
|
## `PRIVATE_GROUP`
|
||
|
|
||
|
|
||
|
* **说明**: 匹配任意群临时私聊消息类型事件
|
||
|
|
||
|
|
||
|
## `PRIVATE_OTHER`
|
||
|
|
||
|
|
||
|
* **说明**: 匹配任意其他私聊消息类型事件
|
||
|
|
||
|
|
||
|
## `GROUP`
|
||
|
|
||
|
|
||
|
* **说明**: 匹配任意群聊消息类型事件
|
||
|
|
||
|
|
||
|
## `GROUP_MEMBER`
|
||
|
|
||
|
|
||
|
* **说明**: 匹配任意群员群聊消息类型事件
|
||
|
|
||
|
:::warning 警告
|
||
|
该权限通过 event.sender 进行判断且不包含管理员以及群主!
|
||
|
:::
|
||
|
|
||
|
|
||
|
## `GROUP_ADMIN`
|
||
|
|
||
|
|
||
|
* **说明**: 匹配任意群管理员群聊消息类型事件
|
||
|
|
||
|
|
||
|
## `GROUP_OWNER`
|
||
|
|
||
|
|
||
|
* **说明**: 匹配任意群主群聊消息类型事件
|
||
|
|
||
|
# NoneBot.adapters.cqhttp.event 模块
|
||
|
|
||
|
|
||
|
## _class_ `Event`
|
||
|
|
||
|
基类:[`nonebot.adapters.Event`](README.md#nonebot.adapters.Event)
|
||
|
|
||
|
CQHTTP 协议事件,字段与 CQHTTP 一致。各事件字段参考 [CQHTTP 文档](https://github.com/howmanybots/onebot/blob/master/README.md)
|
||
|
|
||
|
|
||
|
## _class_ `MessageEvent`
|
||
|
|
||
|
基类:`nonebot.adapters.cqhttp.event.Event`
|
||
|
|
||
|
消息事件
|
||
|
|
||
|
|
||
|
### `to_me`
|
||
|
|
||
|
|
||
|
* **说明**
|
||
|
|
||
|
消息是否与机器人有关
|
||
|
|
||
|
|
||
|
|
||
|
* **类型**
|
||
|
|
||
|
`bool`
|
||
|
|
||
|
|
||
|
|
||
|
### `reply`
|
||
|
|
||
|
|
||
|
* **说明**
|
||
|
|
||
|
消息中提取的回复消息,内容为 `get_msg` API 返回结果
|
||
|
|
||
|
|
||
|
|
||
|
* **类型**
|
||
|
|
||
|
`Optional[Reply]`
|
||
|
|
||
|
|
||
|
|
||
|
## _class_ `PrivateMessageEvent`
|
||
|
|
||
|
基类:`nonebot.adapters.cqhttp.event.MessageEvent`
|
||
|
|
||
|
私聊消息
|
||
|
|
||
|
|
||
|
## _class_ `GroupMessageEvent`
|
||
|
|
||
|
基类:`nonebot.adapters.cqhttp.event.MessageEvent`
|
||
|
|
||
|
群消息
|
||
|
|
||
|
|
||
|
## _class_ `NoticeEvent`
|
||
|
|
||
|
基类:`nonebot.adapters.cqhttp.event.Event`
|
||
|
|
||
|
通知事件
|
||
|
|
||
|
|
||
|
## _class_ `GroupUploadNoticeEvent`
|
||
|
|
||
|
基类:`nonebot.adapters.cqhttp.event.NoticeEvent`
|
||
|
|
||
|
群文件上传事件
|
||
|
|
||
|
|
||
|
## _class_ `GroupAdminNoticeEvent`
|
||
|
|
||
|
基类:`nonebot.adapters.cqhttp.event.NoticeEvent`
|
||
|
|
||
|
群管理员变动
|
||
|
|
||
|
|
||
|
## _class_ `GroupDecreaseNoticeEvent`
|
||
|
|
||
|
基类:`nonebot.adapters.cqhttp.event.NoticeEvent`
|
||
|
|
||
|
群成员减少事件
|
||
|
|
||
|
|
||
|
## _class_ `GroupIncreaseNoticeEvent`
|
||
|
|
||
|
基类:`nonebot.adapters.cqhttp.event.NoticeEvent`
|
||
|
|
||
|
群成员增加事件
|
||
|
|
||
|
|
||
|
## _class_ `GroupBanNoticeEvent`
|
||
|
|
||
|
基类:`nonebot.adapters.cqhttp.event.NoticeEvent`
|
||
|
|
||
|
群禁言事件
|
||
|
|
||
|
|
||
|
## _class_ `FriendAddNoticeEvent`
|
||
|
|
||
|
基类:`nonebot.adapters.cqhttp.event.NoticeEvent`
|
||
|
|
||
|
好友添加事件
|
||
|
|
||
|
|
||
|
## _class_ `GroupRecallNoticeEvent`
|
||
|
|
||
|
基类:`nonebot.adapters.cqhttp.event.NoticeEvent`
|
||
|
|
||
|
群消息撤回事件
|
||
|
|
||
|
|
||
|
## _class_ `FriendRecallNoticeEvent`
|
||
|
|
||
|
基类:`nonebot.adapters.cqhttp.event.NoticeEvent`
|
||
|
|
||
|
好友消息撤回事件
|
||
|
|
||
|
|
||
|
## _class_ `NotifyEvent`
|
||
|
|
||
|
基类:`nonebot.adapters.cqhttp.event.NoticeEvent`
|
||
|
|
||
|
提醒事件
|
||
|
|
||
|
|
||
|
## _class_ `PokeNotifyEvent`
|
||
|
|
||
|
基类:`nonebot.adapters.cqhttp.event.NotifyEvent`
|
||
|
|
||
|
戳一戳提醒事件
|
||
|
|
||
|
|
||
|
## _class_ `LuckyKingNotifyEvent`
|
||
|
|
||
|
基类:`nonebot.adapters.cqhttp.event.NotifyEvent`
|
||
|
|
||
|
群红包运气王提醒事件
|
||
|
|
||
|
|
||
|
## _class_ `HonorNotifyEvent`
|
||
|
|
||
|
基类:`nonebot.adapters.cqhttp.event.NotifyEvent`
|
||
|
|
||
|
群荣誉变更提醒事件
|
||
|
|
||
|
|
||
|
## _class_ `RequestEvent`
|
||
|
|
||
|
基类:`nonebot.adapters.cqhttp.event.Event`
|
||
|
|
||
|
请求事件
|
||
|
|
||
|
|
||
|
## _class_ `FriendRequestEvent`
|
||
|
|
||
|
基类:`nonebot.adapters.cqhttp.event.RequestEvent`
|
||
|
|
||
|
加好友请求事件
|
||
|
|
||
|
|
||
|
## _class_ `GroupRequestEvent`
|
||
|
|
||
|
基类:`nonebot.adapters.cqhttp.event.RequestEvent`
|
||
|
|
||
|
加群请求/邀请事件
|
||
|
|
||
|
|
||
|
## _class_ `MetaEvent`
|
||
|
|
||
|
基类:`nonebot.adapters.cqhttp.event.Event`
|
||
|
|
||
|
元事件
|
||
|
|
||
|
|
||
|
## _class_ `LifecycleMetaEvent`
|
||
|
|
||
|
基类:`nonebot.adapters.cqhttp.event.MetaEvent`
|
||
|
|
||
|
生命周期元事件
|
||
|
|
||
|
|
||
|
## _class_ `HeartbeatMetaEvent`
|
||
|
|
||
|
基类:`nonebot.adapters.cqhttp.event.MetaEvent`
|
||
|
|
||
|
心跳元事件
|
||
|
|
||
|
|
||
|
## `get_event_model(event_name)`
|
||
|
|
||
|
|
||
|
* **说明**
|
||
|
|
||
|
根据事件名获取对应 `Event Model` 及 `FallBack Event Model` 列表
|
||
|
|
||
|
|
||
|
|
||
|
* **返回**
|
||
|
|
||
|
|
||
|
* `List[Type[Event]]`
|