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

OfflineMessageSource

@NotStableForInheritance

abstract class OfflineMessageSource : MessageSource

由一条消息中的 QuoteReply 得到的, 或通过 MessageSourceBuilder 手动构建的 MessageSource.

此消息源可能来自一条与机器人无关的消息, 因此缺少相关发送环境信息, 无法提供 sender 或 target 对象的获取.

要获得 OfflineMessageSource, 使用 MessageSourceBuilder. 或通过 OnlineMessageSource.toOffline 转换得到 (一般没有必要).

Constructors

OfflineMessageSource

fun OfflineMessageSource()

Types

Key

object Key : AbstractPolymorphicMessageKey<MessageSource, OfflineMessageSource>

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 消息元素代码的, 易读的字符串. 如 At(member) + "test" 将转为 "[mirai:at:qqId]test".

Properties

botId

abstract val botId: Long

所属 Bot.id

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

该 source 指代的原消息内容.

targetId

abstract val targetId: Long

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

time

abstract val time: Int

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