ProjectHentai/nonebot2
6
0
Fork 0
mirror of https://github.com/nonebot/nonebot2.git synced 2025-07-27 16:21:28 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

📝 update api docs

Browse Source
This commit is contained in:
yanyongyu
2020-12-07 00:52:26 +08:00
parent a420af75fc
commit e0d44f3fa7
12 changed files with 58 additions and 204 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/api/adapters/README.md
View File

@ -10,7 +10,7 @@ sidebarDepth: 0
各协议请继承以下基类，并使用 `driver.register_adapter` 注册适配器
## _class_ `BaseBot`
## _class_ `Bot`
基类：`abc.ABC`
@ -174,7 +174,7 @@ await bot.send_msg(message="hello world")
## _class_ `BaseEvent`
## _class_ `Event`
基类：`abc.ABC`, `typing.Generic`
@ -271,7 +271,7 @@ Event 基类。提供上报信息的关键信息，其余信息可从原始上
消息发送者信息
## _class_ `BaseMessageSegment`
## _class_ `MessageSegment`
基类：`abc.ABC`
@ -296,7 +296,7 @@ Event 基类。提供上报信息的关键信息，其余信息可从原始上
* 说明: 消息段数据
## _class_ `BaseMessage`
## _class_ `Message`
基类：`list`, `abc.ABC`

8
docs/api/adapters/cqhttp.md
View File

@ -176,7 +176,7 @@ sidebarDepth: 0
## _class_ `Bot`
基类：[`nonebot.adapters.BaseBot`](README.md#nonebot.adapters.BaseBot)
基类：[`nonebot.adapters.Bot`](README.md#nonebot.adapters.Bot)
CQHTTP 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
@ -288,7 +288,7 @@ CQHTTP 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
## _class_ `Event`
基类：[`nonebot.adapters.BaseEvent`](README.md#nonebot.adapters.BaseEvent)
基类：[`nonebot.adapters.Event`](README.md#nonebot.adapters.Event)
CQHTTP 协议 Event 适配。继承属性参考 [BaseEvent](./#class-baseevent) 。
@ -430,13 +430,13 @@ CQHTTP 协议 Event 适配。继承属性参考 [BaseEvent](./#class-baseevent)
## _class_ `MessageSegment`
基类：[`nonebot.adapters.BaseMessageSegment`](README.md#nonebot.adapters.BaseMessageSegment)
基类：[`nonebot.adapters.MessageSegment`](README.md#nonebot.adapters.MessageSegment)
CQHTTP 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。
## _class_ `Message`
基类：[`nonebot.adapters.BaseMessage`](README.md#nonebot.adapters.BaseMessage)
基类：[`nonebot.adapters.Message`](README.md#nonebot.adapters.Message)
CQHTTP 协议 Message 适配。

8
docs/api/adapters/ding.md
View File

@ -74,7 +74,7 @@ sidebarDepth: 0
## _class_ `Bot`
基类：[`nonebot.adapters.BaseBot`](README.md#nonebot.adapters.BaseBot)
基类：[`nonebot.adapters.Bot`](README.md#nonebot.adapters.Bot)
钉钉 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
@ -193,7 +193,7 @@ sidebarDepth: 0
## _class_ `Event`
基类：[`nonebot.adapters.BaseEvent`](README.md#nonebot.adapters.BaseEvent)
基类：[`nonebot.adapters.Event`](README.md#nonebot.adapters.Event)
钉钉 协议 Event 适配。继承属性参考 [BaseEvent](./#class-baseevent) 。
@ -340,7 +340,7 @@ sidebarDepth: 0
## _class_ `MessageSegment`
基类：[`nonebot.adapters.BaseMessageSegment`](README.md#nonebot.adapters.BaseMessageSegment)
基类：[`nonebot.adapters.MessageSegment`](README.md#nonebot.adapters.MessageSegment)
钉钉 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。
@ -375,6 +375,6 @@ sidebarDepth: 0
## _class_ `Message`
基类：[`nonebot.adapters.BaseMessage`](README.md#nonebot.adapters.BaseMessage)
基类：[`nonebot.adapters.Message`](README.md#nonebot.adapters.Message)
钉钉 协议 Message 适配。