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

OnlineMessageSource

sealed class OnlineMessageSource : MessageSource

在线消息的 MessageSource. 拥有对象化的 sender, target, 也可以直接 recallMessage 和 quote

来源

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

机器人主动发送消息

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

机器人接受消息

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

实现

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

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 相等. strict 为 true 时, 还会额外判断每个消息元素的类型, 顺序和属性. 如 Image 会判断 Image.imageId

contentToString

abstract fun contentToString(): String

转为最接近官方格式的字符串. 如 At(member) + "test" 将转为 "@群名片 test".

followedBy

open fun followedBy(tail: Message): MessageChain

将 this 和 tail 连接.

plus

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

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

open operator fun plus(another: CharSequence): MessageChain

将 another 作为 PlainText 连接到这个消息的尾部.

open operator fun plus(another: String): MessageChain

将 another 作为 PlainText 连接到这个消息的尾部.

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

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

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

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

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

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

open operator fun plus(another: Message): MessageChain

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

open operator fun plus(another: MessageChain): MessageChain

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

open operator fun plus(another: SingleMessage): MessageChain

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

toString

override fun toString(): String

返回 "[mirai:source:${ids.contentToString()},${internalIds.contentToString()}]"

Properties

bot

abstract val bot: Bot

botId

override val botId: Long

所属 Bot.id

fromId

abstract val fromId: Long

发送人用户 ID.

ids

abstract val ids: IntArray

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

internalIds

abstract val internalIds: IntArray

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

key

override val key: MessageKey<MessageSource>

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

originalMessage

abstract val originalMessage: MessageChain

该 source 指代的原消息内容.

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

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

Inheritors

Outgoing

Incoming

Extensions

kind

val OnlineMessageSource.kind: MessageSourceKind

获取 MessageSourceKind

toOffline

fun OnlineMessageSource.toOffline(): OfflineMessageSource

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

OnlineMessageSource

来源

机器人主动发送消息

机器人接受消息

实现

See also

Types

Functions

Properties

Inheritors

Extensions