mirai-core-api/net.mamoe.mirai.message.data/OnlineMessageSource

OnlineMessageSource

sealed class OnlineMessageSource : MessageSource

从服务器接收的在线消息的 MessageSource.

对比 OfflineMessageSource, OnlineMessageSource 拥有完整的信息:

可获取 sender 和 target 的 ContactOrBot 对象
可获取有关 bot 对象.

此消息源一定 "指向" 一条存在于服务器上的消息, 但由于服务器消息可能已经被撤回, 对此消息源执行撤回仍然可能会失败.

来源

当 bot 主动发送消息时, 产生 (由协议模块主动构造) OnlineMessageSource.Outgoing
当 bot 接收消息时, 产生 (由协议模块根据服务器的提供的信息构造) OnlineMessageSource.Incoming

机器人主动发送消息

当机器人主动发出消息, 将会得到一个消息回执. 此回执的消息源即为一个外向消息源, 代表着刚刚发出的那条消息的来源.

机器人接受消息

当机器人接收一条消息 MessageEvent, 这条消息包含一个内向消息源, 代表着接收到的这条消息的来源.

实现

此类的所有子类都有协议模块实现. 不要自行实现它们, 否则将无法发送

Inheritors

Outgoing

Incoming

Types

Incoming

sealed class Incoming : OnlineMessageSource

接收到的一条消息的 MessageSource

Key

object Key : AbstractMessageKey<OnlineMessageSource>

Outgoing

sealed class Outgoing : OnlineMessageSource

由机器人主动发送消息产生的 MessageSource, 可通过 MessageReceipt 获得.

Functions

contentEquals

open fun contentEquals(another: String, ignoreCase: Boolean = false): Boolean

判断内容是否与 another 相等.

open fun contentEquals(another: Message, ignoreCase: Boolean = false): Boolean

判断内容是否与 another 相等即 this 与 another 的 contentToString 相等.

open fun contentEquals(another: Message, ignoreCase: Boolean = false, strict: Boolean = false): Boolean

判断内容是否与 another 相等即 this 与 another 的 contentToString 相等.

contentToString

abstract fun contentToString(): String

转为接近官方格式的字符串, 即 "内容". 如 At(member) + "test" 将转为 "@QQ test".

copyAmend

@JvmName(name = "copySource")

fun MessageSource.copyAmend(block: MessageSourceAmender.() -> Unit): OfflineMessageSource

复制这个消息源, 并以 block 修改

followedBy

open fun followedBy(tail: Message): MessageChain

将 this 和 tail 连接.

isContentBlank

fun Message.isContentBlank(): Boolean

当消息内容为空白时返回 true.

isContentEmpty

fun Message.isContentEmpty(): Boolean

当消息内容为空时返回 true.

plus

open operator fun plus(another: Array<out Message>): MessageChain

创建一个消息链, 将 another 连接到这个消息的尾部. 这不会改变本 Message, 而是会创建新的 MessageChain 实例. 返回的 MessageChain 实例的第一个元素为本 Message, 随后为按顺序的 another 中的元素.

open operator fun plus(another: CharSequence): MessageChain

open operator fun plus(another: String): MessageChain

@JvmName(name = "plusIterableString")

open operator fun plus(another: Iterable<String>): MessageChain

open operator fun plus(another: Iterable<Message>): MessageChain

open operator fun plus(another: Sequence<Message>): MessageChain

open operator fun plus(another: Message): MessageChain

open operator fun plus(another: MessageChain): MessageChain

open operator fun plus(another: SingleMessage): MessageChain

plus

suspend operator fun Message.plus(another: Flow<Message>): MessageChain

将 another 按顺序连接到这个消息的尾部.

quote

@JvmStatic

fun MessageSource.quote(): QuoteReply

引用这条消息.

recall

@JvmStatic

suspend fun MessageSource.recall()

以 Bot 身份撤回该消息源指向的存在于服务器上的消息. 可撤回自己 2 分钟内发出的消息, 和任意时间的群成员的消息.

recallIn

@JvmStatic

fun MessageSource.recallIn(millis: Long): AsyncRecallResult

在一段时间后撤回这条消息.

repeat

fun Message.repeat(count: Int): MessageChain

将此消息元素按顺序重复 count 次.

sendTo

inline suspend fun <C : Contact> Message.sendTo(contact: C): MessageReceipt<C>

将 this 发送给指定联系人

times

operator fun Message.times(count: Int): MessageChain

将此消息元素按顺序重复 count 次.

toForwardMessage

@JvmOverloads

fun Message.toForwardMessage(sender: User, time: Int = currentTimeSeconds().toInt(), displayStrategy: ForwardMessage.DisplayStrategy = DisplayStrategy): ForwardMessage

@JvmOverloads

fun Message.toForwardMessage(senderId: Long, senderName: String, time: Int = currentTimeSeconds().toInt(), displayStrategy: ForwardMessage.DisplayStrategy = DisplayStrategy): ForwardMessage

转换为 ForwardMessage

toMessageChain

fun Message.toMessageChain(): MessageChain

toOffline

@JvmName(name = "toOfflineMessageSource")

fun OnlineMessageSource.toOffline(): OfflineMessageSource

将在线消息源转换为离线消息源.

toString

abstract override fun toString(): String

得到包含 mirai 消息元素代码的, 易读的字符串. 如 At(member) + "test" 将转为 "[mirai:at:qqId]test".

Properties

bot

abstract val bot: Bot

bot

val MessageSource.bot: Bot

获取此消息源的相关 Bot.

botId

override val botId: Long

所属 Bot.id

botOrNull

val MessageSource.botOrNull: Bot?

获取此消息源的相关 Bot.

content

val Message.content: String

Message.contentToString 的捷径

fromId

abstract val fromId: Long

发送人用户 ID.

ids

abstract val ids: IntArray

消息 ids (序列号). 在获取失败时 (概率很低) 为空数组.

internalIds

abstract val internalIds: IntArray

内部 ids. 仅用于协议模块使用

isOriginalMessageInitialized

abstract val isOriginalMessageInitialized: Boolean

当 originalMessage 已被初始化后返回 true.

key

override val key: MessageKey<MessageSource>

用于判断是否为同一种元素的 MessageKey. 使用多态类型 MessageKey 最上层的 MessageKey.

kind

abstract val kind: MessageSourceKind

消息种类

originalMessage

abstract val originalMessage: MessageChain

该消息源指向的原消息的内容.

sender

abstract val sender: ContactOrBot

消息发送人. 可能为机器人或好友或群员. 即类型必定为 Bot, Friend 或 Member

subject

abstract val subject: Contact

消息主体. 群消息时为 Group. 好友消息时为 Friend, 临时消息为 Member 不论是机器人接收的消息还是发送的消息, 此属性都指向机器人能进行回复的目标.

target

abstract val target: ContactOrBot

消息发送目标. 可能为机器人或好友或群. 即类型必定为 Bot, Friend 或 Group

targetId

abstract val targetId: Long

消息发送目标用户或群号码.

time

abstract val time: Int

发送时间时间戳, 单位为秒.

OnlineMessageSource

来源

机器人主动发送消息

机器人接受消息

实现

See also

Inheritors

Types

Functions

Properties