可被取消的事件的实现
所有 Image 实现的基类.
At 一个群成员. 只能发送给一个群.
"@全体成员".
图片上传前. 可以阻止上传
机器人对象. 一个机器人实例登录一个 QQ 账号.
Mirai 为多账号设计, 可同时维护多个机器人.
由 Bot 主动发起的动作的事件
Bot 配置
有关一个 Bot 的事件
构造 Bot 的工厂.
Bot 在群里的权限被改变. 操作人一定是群主
Bot 被邀请加入一个群.
发送消息时 bot 正处于被禁言状态时抛出的异常.
Bot 中为了让 Java 使用者调用更方便的 API 列表.
Bot 成功加入了一个新群
机器人被踢出群或在其他客户端主动退出一个群. 在事件广播前 Bot.groups 就已删除这个群.
Bot 被禁言
Bot 离线.
Bot 登录完成, 好友列表, 群组列表初始化完成
Bot 被动接收的事件. 这些事件可能与机器人有关
Bot 主动重新登录.
Bot 被取消禁言
可控制是否需要广播这个事件包
(extensions in package net.mamoe.mirai.message)
(extensions in package net.mamoe.mirai.utils)
(extensions in package net.mamoe.mirai.utils)
可被取消的事件
(extensions in package net.mamoe.mirai.message.data)
约束一个 MessageChain 中只存在这一种类型的元素. 新元素将会替换旧元素, 保持原顺序.
联系人. 虽然叫做联系人, 但他的子类有 用户, 和 群.
Contact 中为了让 Java
更容易调用的 API.
不要用它作为一个类型, 只应使用其中的方法
只读联系人列表, 无锁链表实现
一条消息事件.
它是一个 BotEvent, 因此可以被 监听
拥有 id 的对象.
此为 Contact 与 Bot 的唯一公共接口.
On Android, typealias to android.content.Context
On JVM, empty class.
(extensions in package net.mamoe.mirai.event)
非 mirai 实现的异常
自定义消息
自定义消息元数据.
自动选择 SwingSolver 或 StandardCharImageLoginSolver
设备信息. 可通过继承 SystemDeviceInfo 来在默认的基础上修改
不含任何元素的 MessageChain.
可被监听的类, 可以是任何 class 或 object.
外部图片. 图片数据还没有读取到内存.
QQ 自带表情
(extensions in package net.mamoe.mirai.message)
(extensions in package net.mamoe.mirai.utils)
闪照
当 Bot 被迫下线时抛出, 作为 Job.cancel 的 cause
合并转发消息
转发消息 DSL 构建器.
标记转发消息 DSL
好友 对象.
注意: 一个 Friend 实例并不是独立的, 它属于一个 Bot.
它不能被直接构造. 任何时候都应从 Bot.getFriend 或事件中获取.
成功添加了一个新好友的事件
好友已被删除的事件.
有关好友的事件
好友图片
好友消息
给好友设置的备注
好友昵称改变事件. 目前仅支持解析 (来自 PC 端的修改).
性别
群.
群统计信息
群 "匿名聊天" 功能状态改变. 此事件广播前修改就已经完成.
群 "坦白说" 功能状态改变. 此事件广播前修改就已经完成.
群 "允许群员邀请好友加群" 功能状态改变. 此事件广播前修改就已经完成.
群公告数据类
getGroupAnnouncementList时,如果page=1,那么你可以在inst里拿到一些置顶公告
入群公告改变. 此事件广播前修改就已经完成.
有关群的事件
群图片.
群资料.
有关群成员的事件
群 "全员禁言" 功能状态改变. 此事件广播前修改就已经完成.
群名改变. 此事件广播前修改就已经完成.
可由 Member 或 Bot 操作的事件
群设置改变. 此事件广播前修改就已经完成.
群设置
一些特殊的消息
自定义表情 (收藏的表情) 和普通图片.
图片上传完成
(extensions in package net.mamoe.mirai.message)
(extensions in package net.mamoe.mirai.utils)
(extensions in package net.mamoe.mirai.message)
(extensions in package net.mamoe.mirai.utils)
(extensions in package net.mamoe.mirai.utils)
(extensions in package net.mamoe.mirai.message.data)
(extensions in package net.mamoe.mirai.utils)
表明这个 API 是为了让 Java 使用者调用更方便.
一般有一定的性能损失, 且不能在 JVM/Android 以外平台使用. 不要在 Kotlin 调用它.
Json 消息.
小程序, 如音乐分享.
事件监听器.
由 subscribe 等方法返回.
订阅者的状态
Implementation of lock-free LinkedList.
在 登录 失败时抛出, 可正常地中断登录过程.
验证码, 设备锁解决器
标示这个 API 是低级的 API.
Bot 相关协议层低级 API.
群成员.
成员群名片改动. 此事件广播前修改就已经完成.
Member 中为了让 Java
更容易调用的 API
不要用它作为一个类型, 只应使用其中的方法
成员已经加入群的事件
一个账号请求加入群事件, Bot 在此群中是管理员或群主.
成员已经离开群的事件. 在事件广播前成员就已经从 Group.members 中删除
群成员被禁言事件. 被禁言的成员都不可能是机器人本人
群成员的权限.
成员权限改变的事件. 成员不可能是机器人自己.
成员群头衔改动. 一定为群主操作
群成员被取消禁言事件. 被禁言的成员都不可能是机器人本人
可发送的或从服务器接收的消息.
采用这样的消息模式是因为 QQ 的消息多元化, 一条消息中可包含 纯文本, 图片 等.
消息链. 空的实现为 EmptyMessageChain
MessageChain 构建器.
多个连续的 String 会被连接为单个 PlainText 以优化性能.
消息内容
DSL 标记. 将能让 IDE 阻止一些错误的方法调用.
消息事件的处理器.
消息元数据, 即不含内容的元素.
一条从服务器接收到的消息事件.
请查看各平台的 actual
实现的说明.
仅内部使用, 请使用 ContactMessage
消息撤回事件. 可是任意消息被任意人撤回.
发送消息后得到的回执. 可用于撤回.
selectMessages 时的 DSL 构建器.
selectMessagesUnit 或 selectMessages 时的 DSL 构建器.
主动发送消息
消息源, 它存在于 MessageChain 中, 用于表示这个消息的来源.
仅于 copyAmend 中修改 MessageSource
消息订阅构造器
发送消息时消息过长抛出的异常.
标记这个类, 类型, 函数, 属性, 字段, 或构造器为实验性的 API.
标记为一个仅供 Mirai 内部使用的 API.
日志记录器. 所有的输出均依赖于它.
不同的对象可拥有只属于自己的 logger. 通过 identity 来区分.
日志基类. 实现了 follower 的调用传递.
若 Mirai 自带的日志系统无法满足需求, 请继承这个类并实现其抽象函数.
带有开关的 Logger. 仅能通过 MiraiLogger.withSwitch 构造
一个账号请求添加机器人为好友的事件
无可用服务器
无标准输入或 Kotlin 不支持此输入.
Null 的 MessageChain.
它不包含任何元素, 也没有创建任何 list.
通过 Group.uploadImage 上传得到的 GroupImage. 它的链接需要查询 Bot.queryImageUrl
通过 Group.uploadImage 上传得到的 GroupImage. 它的链接需要查询 Bot.queryImageUrl
离线的图片, 即为客户端主动上传到服务器而获得的 Image 实例.
不能直接获取它在服务器上的链接. 需要通过 Bot.queryImageUrl 查询
由一条消息中的 QuoteReply 得到的 MessageSource.
此消息源可能来自一条与机器人无关的消息. 因此无法提供对象化的 sender
或 target
获取.
接收消息时获取到的 FriendImage. 它可以直接获取下载链接 originUrl
接收消息时获取到的 GroupImage. 它可以直接获取下载链接 originUrl
在服务器上的图片. 它可以直接获取下载链接.
在线消息的 MessageSource.
拥有对象化的 sender, target, 也可以直接 recall 和 quote
在线状态
可空的委托
图片文件过大
从服务器收到的包解析之后的结构化数据.
它是一个数据包工厂的处理的返回值.
权限不足
纯文本. 可含 emoji 表情如 😊.
当前平台的默认的日志记录器.
在 JVM 控制台 端的实现为 println
在 Android 端的实现为 android.util.Log
戳一戳. 可以发送给好友或群.
曾用名列表
个人资料
QQ 对象.
引用回复.
XML 消息等富文本消息
(extensions in package net.mamoe.mirai.message.data)
(extensions in package net.mamoe.mirai.utils)
服务消息, 如 XmlMessage.
不做任何事情的 logger, keep silent.
简易日志记录, 所有类型日志都会被重定向 logger
标记一个自 Mirai 某个版本起才支持或在这个版本修改过的 API.
使用字符图片展示验证码, 使用 input 获取输入, 使用 overrideLogger 输出
(extensions in package net.mamoe.mirai.message.data)
通过本机信息来获取设备信息.
临时会话消息
This annotation indicates what exceptions should be declared by a function when compiled to a JVM method.
WeakRef that getValue
for delegation throws an IllegalStateException if the referent is released by GC. Therefore it returns notnull value only
需要短信验证时抛出. mirai 目前还不支持短信验证.
(extensions in package net.mamoe.mirai.message)
(extensions in package net.mamoe.mirai.utils)
代表一个 用户.
VIP 表情.
(extensions in package net.mamoe.mirai.utils)
Indicates that the property is delegated by a WeakRef
密码输入错误
XML 消息, 如分享, 卡片等.