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

QuoteReply

@Serializable

data class QuoteReply(val source: MessageSource) : Message, MessageMetadata, ConstrainSingle

引用回复. QuoteReply 被作为 MessageMetadata, 因为它不包含实际的消息内容.

支持引用任何一条消息发送给任何人.

引用回复的原消息内容完全由 source 中 MessageSource.originalMessage 控制, 客户端不会自行寻找原消息. 可通过 MessageSource.copyAmend 修改引用的消息内容.

客户端通过 MessageSource.ids 等数据定位源消息, 在修改时使用 MessageSourceBuilder.metadata 可以修改定位结果.

创建引用回复

直接构造 QuoteReply: new QuoteReply(source)
在 Kotlin 使用扩展 MessageSource.quote

Constructors

QuoteReply

constructor(sourceMessage: MessageChain)

从消息链中获取 MessageSource 并构造.

constructor(source: MessageSource)

Types

Key

object Key : AbstractMessageKey<QuoteReply>

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".

equals

open operator override fun equals(other: Any?): Boolean

followedBy

open fun followedBy(tail: Message): MessageChain

将 this 和 tail 连接.

hashCode

open override fun hashCode(): Int

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 按顺序连接到这个消息的尾部.

recallSource

inline suspend fun QuoteReply.recallSource()

撤回引用的源消息

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

@JvmName(name = "newChain")

fun Message.toMessageChain(): MessageChain

toString

open override fun toString(): String

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

Properties

content

val Message.content: String

Message.contentToString 的捷径

key

open override val key: MessageKey<QuoteReply>

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

source

val source: MessageSource

指代被引用的消息. 其中 MessageSource.originalMessage 可以控制客户端显示的消息内容.

QuoteReply

创建引用回复

See also

Constructors

Types

Functions

Properties