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

OfflineMessageSource

@NotStableForInheritance

abstract class OfflineMessageSource : MessageSource

一条在本地构建的, 或其他不保证指向一条服务器上存在的消息的消息源.

来源

离线消息源可从引用回复中获得, 因为协议上引用回复中的被引用的消息是由客户端自己提供的. 离线消息源也可通过 MessageSourceBuilder, MessageSource.copyAmend 等方法构建得到.

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

构建

使用 MessageSourceBuilder 可使用相关属性构建实例.
使用 MessageSource.copyAmend 复制另外一个 MessageSource 得到.
使用 OnlineMessageSource.toOffline 可将 OfflineMessageSource 转换得到 OfflineMessageSource. 但这一般没有意义.

Constructors

OfflineMessageSource

constructor()

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 相等.

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

toString

override fun toString(): String

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

Properties

bot

val MessageSource.bot: Bot

获取此消息源的相关 Bot.

botId

abstract 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 override val kind: MessageSourceKind

消息种类

originalMessage

abstract val originalMessage: MessageChain

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

targetId

abstract val targetId: Long

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

time

abstract val time: Int

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