mirror of https://github.com/nonebot/nonebot2.git synced 2024-11-25 01:25:04 +08:00

nonebot 7fdfd89525 📝 update api docs

2021-01-31 16:02:54 +00:00

15 KiB

Raw Blame History

contentSidebar	sidebarDepth
true	0

NoneBot.adapters.mirai 模块

NoneBot.adapters.mirai.bot 模块

class `MiraiBot`

基类：nonebot.adapters.Bot

mirai-api-http 协议 Bot 适配。

async `send(event, message, at_sender=False)`

说明

根据 event 向触发事件的主题发送信息
参数
- event: Event: Event对象
- message: Union[MessageChain, MessageSegment, str]: 要发送的消息
- at_sender: bool: 是否 @ 事件主题
返回
- Any: API 调用返回数据

async `send_friend_message(target, message_chain)`

说明

使用此方法向指定好友发送消息
参数
- target: int: 发送消息目标好友的 QQ 号
- message_chain: MessageChain: 消息链，是一个消息对象构成的数组
返回
- Any: API 调用返回数据

async `send_temp_message(qq, group, message_chain)`

说明

使用此方法向临时会话对象发送消息
参数
- qq: int: 临时会话对象 QQ 号
- group: int: 临时会话群号
- message_chain: MessageChain: 消息链，是一个消息对象构成的数组
返回
- Any: API 调用返回数据

async `send_group_message(group, message_chain, quote=None)`

说明

使用此方法向指定群发送消息
参数
- group: int: 发送消息目标群的群号
- message_chain: MessageChain: 消息链，是一个消息对象构成的数组
- quote: Optional[int]: 引用一条消息的 message_id 进行回复
返回
- Any: API 调用返回数据

async `recall(target)`

说明

使用此方法撤回指定消息。对于bot发送的消息，有2分钟时间限制。对于撤回群聊中群员的消息，需要有相应权限
参数
- target: int: 需要撤回的消息的message_id
返回
- Any: API 调用返回数据

async `send_image_message(target, qq, group, urls)`

说明

使用此方法向指定对象（群或好友）发送图片消息除非需要通过此手段获取image_id，否则不推荐使用该接口

当qq和group同时存在时，表示发送临时会话图片，qq为临时会话对象QQ号，group为临时会话发起的群号
参数
- target: int: 发送对象的QQ号或群号，可能存在歧义
- qq: int: 发送对象的QQ号
- group: int: 发送对象的群号
- urls: List[str]: 是一个url字符串构成的数组
返回
- List[str]: 一个包含图片imageId的数组

async `upload_image(type, img)`

说明

使用此方法上传图片文件至服务器并返回Image_id
参数
- type: str: "friend" 或 "group" 或 "temp"
- img: BytesIO: 图片的BytesIO对象
返回
- Any: API 调用返回数据

async `upload_voice(type, voice)`

说明

使用此方法上传语音文件至服务器并返回voice_id
参数
- type: str: 当前仅支持 "group"
- voice: BytesIO: 语音的BytesIO对象
返回
- Any: API 调用返回数据

async `fetch_message(count=10)`

说明

使用此方法获取bot接收到的最老消息和最老各类事件 (会从MiraiApiHttp消息记录中删除)
参数
- count: int: 获取消息和事件的数量

async `fetch_latest_message(count=10)`

说明

使用此方法获取bot接收到的最新消息和最新各类事件 (会从MiraiApiHttp消息记录中删除)
参数
- count: int: 获取消息和事件的数量

async `peek_message(count=10)`

说明

使用此方法获取bot接收到的最老消息和最老各类事件 (不会从MiraiApiHttp消息记录中删除)
参数
- count: int: 获取消息和事件的数量

async `peek_latest_message(count=10)`

说明

使用此方法获取bot接收到的最新消息和最新各类事件 (不会从MiraiApiHttp消息记录中删除)
参数
- count: int: 获取消息和事件的数量

async `messsage_from_id(id)`

说明

通过messageId获取一条被缓存的消息使用此方法获取bot接收到的消息和各类事件
参数
- id: int: 获取消息的message_id

async `count_message()`

说明

使用此方法获取bot接收并缓存的消息总数，注意不包含被删除的

async `friend_list()`

说明

使用此方法获取bot的好友列表
返回
- List[Dict[str, Any]]: 返回的好友列表数据

async `group_list()`

说明

使用此方法获取bot的群列表
返回
- List[Dict[str, Any]]: 返回的群列表数据

async `member_list(target)`

说明

使用此方法获取bot指定群种的成员列表
参数
- target: int: 指定群的群号
返回
- List[Dict[str, Any]]: 返回的群成员列表数据

async `mute(target, member_id, time)`

说明

使用此方法指定群禁言指定群员（需要有相关权限）
参数
- target: int: 指定群的群号
- member_id: int: 指定群员QQ号
- time: int: 禁言时长，单位为秒，最多30天

async `unmute(target, member_id)`

说明

使用此方法指定群解除群成员禁言（需要有相关权限）
参数
- target: int: 指定群的群号
- member_id: int: 指定群员QQ号

async `kick(target, member_id, msg)`

说明

使用此方法移除指定群成员（需要有相关权限）
参数
- target: int: 指定群的群号
- member_id: int: 指定群员QQ号
- msg: str: 信息

async `quit(target)`

说明

使用此方法使Bot退出群聊
参数
- target: int: 退出的群号

async `mute_all(target)`

说明

使用此方法令指定群进行全体禁言（需要有相关权限）
参数
- target: int: 指定群的群号

async `unmute_all(target)`

说明

使用此方法令指定群解除全体禁言（需要有相关权限）
参数
- target: int: 指定群的群号

async `group_config(target)`

说明

使用此方法获取群设置
参数
- target: int: 指定群的群号
返回

{
    "name": "群名称",
    "announcement": "群公告",
    "confessTalk": true,
    "allowMemberInvite": true,
    "autoApprove": true,
    "anonymousChat": true
}

async `modify_group_config(target, config)`

说明

使用此方法修改群设置（需要有相关权限）
参数
- target: int: 指定群的群号
- config: Dict[str, Any]: 群设置, 格式见 group_config 的返回值

async `member_info(target, member_id)`

说明

使用此方法获取群员资料
参数
- target: int: 指定群的群号
- member_id: int: 群员QQ号
返回

{
    "name": "群名片",
    "specialTitle": "群头衔"
}

async `modify_member_info(target, member_id, info)`

说明

使用此方法修改群员资料（需要有相关权限）
参数
- target: int: 指定群的群号
- member_id: int: 群员QQ号
- info: Dict[str, Any]: 群员资料, 格式见 member_info 的返回值

NoneBot.adapters.mirai.bot_ws 模块

class `MiraiWebsocketBot`

基类：nonebot.adapters.mirai.bot.MiraiBot

mirai-api-http 正向 Websocket 协议 Bot 适配。

NoneBot.adapters.mirai.config 模块

NoneBot.adapters.mirai.message 模块

class `MessageType`

基类：str, enum.Enum

An enumeration.

NoneBot.adapters.mirai.event 模块

NoneBot.adapters.mirai.event.base 模块

class `UserPermission`

基类：str, enum.Enum

用户权限枚举类

OWNER: 群主

ADMINISTRATOR: 群管理

MEMBER: 普通群成员

class `Event`

基类：nonebot.adapters.Event

mirai-api-http 协议事件，字段与 mirai-api-http 一致。各事件字段参考 mirai-api-http 文档

classmethod `new(data)`

此事件类的工厂函数, 能够通过事件数据选择合适的子类进行序列化

`normalize_dict(**kwargs)`

返回可以被json正常反序列化的结构体

NoneBot.adapters.mirai.event.meta 模块

class `MetaEvent`

基类：nonebot.adapters.mirai.event.base.Event

元事件基类

class `BotOnlineEvent`

基类：nonebot.adapters.mirai.event.meta.MetaEvent

Bot登录成功

class `BotOfflineEventActive`

基类：nonebot.adapters.mirai.event.meta.MetaEvent

Bot主动离线

class `BotOfflineEventForce`

基类：nonebot.adapters.mirai.event.meta.MetaEvent

Bot被挤下线

class `BotOfflineEventDropped`

基类：nonebot.adapters.mirai.event.meta.MetaEvent

Bot被服务器断开或因网络问题而掉线

class `BotReloginEvent`

基类：nonebot.adapters.mirai.event.meta.MetaEvent

Bot主动重新登录

NoneBot.adapters.mirai.event.message 模块

class `MessageEvent`

基类：nonebot.adapters.mirai.event.base.Event

消息事件基类

class `GroupMessage`

基类：nonebot.adapters.mirai.event.message.MessageEvent

群消息事件

class `FriendMessage`

基类：nonebot.adapters.mirai.event.message.MessageEvent

好友消息事件

class `TempMessage`

基类：nonebot.adapters.mirai.event.message.MessageEvent

临时会话消息事件

NoneBot.adapters.mirai.event.notice 模块

class `NoticeEvent`

基类：nonebot.adapters.mirai.event.base.Event

通知事件基类

class `MuteEvent`

基类：nonebot.adapters.mirai.event.notice.NoticeEvent

禁言类事件基类

class `BotMuteEvent`

基类：nonebot.adapters.mirai.event.notice.MuteEvent

Bot被禁言

class `BotUnmuteEvent`

基类：nonebot.adapters.mirai.event.notice.MuteEvent

Bot被取消禁言

class `MemberMuteEvent`

基类：nonebot.adapters.mirai.event.notice.MuteEvent

群成员被禁言事件（该成员不是Bot）

class `MemberUnmuteEvent`

基类：nonebot.adapters.mirai.event.notice.MuteEvent

群成员被取消禁言事件（该成员不是Bot）

class `BotJoinGroupEvent`

基类：nonebot.adapters.mirai.event.notice.NoticeEvent

Bot加入了一个新群

class `BotLeaveEventActive`

基类：nonebot.adapters.mirai.event.notice.BotJoinGroupEvent

Bot主动退出一个群

class `BotLeaveEventKick`

基类：nonebot.adapters.mirai.event.notice.BotJoinGroupEvent

Bot被踢出一个群

class `MemberJoinEvent`

基类：nonebot.adapters.mirai.event.notice.NoticeEvent

新人入群的事件

class `MemberLeaveEventKick`

基类：nonebot.adapters.mirai.event.notice.MemberJoinEvent

成员被踢出群（该成员不是Bot）

class `MemberLeaveEventQuit`

基类：nonebot.adapters.mirai.event.notice.MemberJoinEvent

成员主动离群（该成员不是Bot）

class `FriendRecallEvent`

基类：nonebot.adapters.mirai.event.notice.NoticeEvent

好友消息撤回

class `GroupRecallEvent`

基类：nonebot.adapters.mirai.event.notice.FriendRecallEvent

群消息撤回