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

CombinedMessage

class CombinedMessage constructor(val element: Message, val tail: Message, val hasConstrainSingle: Boolean) : AbstractMessageChain, List<SingleMessage>

树状消息链的一个节点. element 为当前元素, tail 为下一个元素.

注意: 这是内部 API. 不要在任何情况下使用它. Message.plus 等连接消息链的 API 已经有性能优化, 会在合适的时机创建 CombinedMessage, 不需要自行考虑创建 CombinedMessage.

Since

2.12

Constructors

CombinedMessage

constructor(element: Message, tail: Message, hasConstrainSingle: Boolean)

Functions

anyIsInstance

inline fun <M : SingleMessage> MessageChain.anyIsInstance(): Boolean

当 this 中存在 M 的实例时返回 true.

appendMiraiCodeTo

@MiraiExperimentalApi

open override fun appendMiraiCodeTo(builder: StringBuilder)

contains

open operator override fun contains(element: SingleMessage): Boolean

open operator fun <M : SingleMessage> contains(key: MessageKey<M>): Boolean

当存在 ConstrainSingle.key 为 key 的 SingleMessage 实例时返回 true.

containsAll

open override fun containsAll(elements: Collection<SingleMessage>): Boolean

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

contentsList

fun MessageChain.contentsList(): List<MessageContent>

筛选 MessageContent

contentsSequence

fun MessageChain.contentsSequence(): Sequence<MessageContent>

获取 Sequence<MessageContent> 相当于 this.asSequence().filterIsInstance<MessageContent>()

contentToString

open override fun contentToString(): String

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

deserializeFromMiraiCode

fun MessageChain.~~deserializeFromMiraiCode~~(miraiCode: String, contact: Contact? = null): MessageChain

解析形如 "mirai:" 的 mirai 码, 即 CodableMessage.serializeToMiraiCode 返回的内容.

equals

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

findIsInstance

inline fun <M : SingleMessage?> MessageChain.findIsInstance(): M?

获取第一个 M 实例. 在不存在时返回 null.

firstIsInstance

inline fun <M : SingleMessage> MessageChain.firstIsInstance(): M

获取第一个 M 实例. 在不存在时抛出 NoSuchElementException.

firstIsInstanceOrNull

inline fun <M : SingleMessage?> MessageChain.firstIsInstanceOrNull(): M?

获取第一个 M 实例. 在不存在时返回 null.

followedBy

open fun followedBy(tail: Message): MessageChain

将 this 和 tail 连接.

get

open operator override fun get(index: Int): SingleMessage

open operator fun <M : SingleMessage> get(key: MessageKey<M>): M?

获取第一个类型为 key 的 Message 实例. 若不存在此实例, 返回 null.

getOrFail

inline fun <M : SingleMessage> MessageChain.getOrFail(key: MessageKey<M>, crossinline lazyMessage: (key: MessageKey<M>) -> String = { key.toString() }): M

获取第一个类型为 key 的 Message 实例, 在找不到此类型的元素时抛出 NoSuchElementException

getValue

inline operator fun <T : SingleMessage> MessageChain.getValue(thisRef: Any?, property: KProperty<*>): T

提供一个类型的值的委托. 若不存在则会抛出异常 NoSuchElementException

hashCode

open override fun hashCode(): Int

indexOf

open override fun indexOf(element: SingleMessage): Int

isContentBlank

fun Message.isContentBlank(): Boolean

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

isContentEmpty

fun Message.isContentEmpty(): Boolean

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

isEmpty

open override fun isEmpty(): Boolean

iterator

open operator override fun iterator(): Iterator<SingleMessage>

lastIndexOf

open override fun lastIndexOf(element: SingleMessage): Int

listIterator

open override fun listIterator(): ListIterator<SingleMessage>

open override fun listIterator(index: Int): ListIterator<SingleMessage>

metadataList

fun MessageChain.metadataList(): List<MessageMetadata>

筛选 MessageMetadata

metadataSequence

fun MessageChain.metadataSequence(): Sequence<MessageMetadata>

获取 Sequence<MessageMetadata> 相当于 this.asSequence().filterIsInstance<MessageMetadata>()

orElse

inline fun <T : R, R : SingleMessage?> MessageChain.orElse(lazyDefault: () -> R): OrNullDelegate<R>

提供一个类型的 Message 的委托, 若不存在这个类型的 Message 则委托会提供 null

orNull

inline fun <T : SingleMessage> MessageChain.orNull(): OrNullDelegate<T?>

提供一个类型的 Message 的委托, 若不存在这个类型的 Message 则委托会提供 null

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 MessageChain.quote(): QuoteReply

引用这条消息. 仅从服务器接收的消息 (即来自 MessageEvent) 才可以通过这个方式被引用.

recall

@JvmStatic

suspend fun MessageChain.recall()

以 Bot 身份撤回该消息. 可撤回自己 2 分钟内发出的消息, 和任意时间的群成员的消息.

recallIn

@JvmStatic

fun MessageChain.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 发送给指定联系人

serializeToJsonString

fun MessageChain.serializeToJsonString(json: Json = getDefaultJson()): String

将 MessageChain 序列化为 JSON 字符串.

serializeToMiraiCode

open fun serializeToMiraiCode(): String

转换为 mirai 码.

serializeToMiraiCode

@JvmStatic

fun Iterable<Message>.serializeToMiraiCode(): String

@JvmStatic

fun CodableMessage.serializeToMiraiCode(): String

转换得到 mirai 码.

serializeToString

@ExperimentalSerializationApi

fun MessageChain.serializeToString(format: StringFormat): String

将 MessageChain 序列化为指定格式的字符串.

subList

open override fun subList(fromIndex: Int, toIndex: Int): List<SingleMessage>

times

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

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

toForwardMessage

@JvmOverloads

fun Iterable<MessageEvent>.toForwardMessage(displayStrategy: ForwardMessage.DisplayStrategy = DisplayStrategy): ForwardMessage

@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

inline fun Iterable<Message>.toMessageChain(): MessageChain

扁平化 this 并创建一个 MessageChain.

fun Message.toMessageChain(): MessageChain

toString

open override fun toString(): String

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

Properties

bot

val MessageChain.bot: Bot

消息内部 ids.

content

val Message.content: String

Message.contentToString 的捷径

val element: Message

open override val hasConstrainSingle: Boolean

去重算法 v1 - 2.12: 在连接时若只有 0-1 方包含 ConstrainSingle, 则使用 CombinedMessage 优化性能. 否则使用旧版复杂去重算法构造 LinearMessageChainImpl.

ids

val MessageChain.ids: IntArray

消息 ids.

internalId

val MessageChain.internalId: IntArray

消息内部 ids.

size

open override val size: Int

source

val MessageChain.source: MessageSource

获取这条消息的消息源.

sourceOrNull

val MessageChain.sourceOrNull: MessageSource?

获取这条消息的消息源.

tail

@MiraiInternalApi

val tail: Message

time

val MessageChain.time: Int

消息时间.