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

ServiceMessage

@NotStableForInheritance

interface ServiceMessage : RichMessage, CodableMessage

服务消息, 可以是 JSON 消息或 XML 消息.

XML 消息有时候是 SimpleServiceMessage, 有时候是 LightApp. JSON 消息更多情况下通过 LightApp 发送.

建议使用官方客户端发送来确定具体是哪种类型.

Inheritors

SimpleServiceMessage

AbstractServiceMessage

Types

Key

object Key : AbstractPolymorphicMessageKey<RichMessage, ServiceMessage>

Functions

appendMiraiCodeTo

@MiraiExperimentalApi

open override fun appendMiraiCodeTo(builder: StringBuilder)

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

open override fun contentToString(): String

注意: 富文本消息的 RichMessage.contentEquals 和 RichMessage.toString 都不稳定. 将来可能在没有任何警告的情况下改变格式.

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

repeat

fun Message.repeat(count: Int): MessageChain

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

sendTo

inline suspend fun <C : Contact> Message.sendTo(contact: C): MessageReceipt<C>

将 this 发送给指定联系人

serializeToMiraiCode

open fun serializeToMiraiCode(): String

转换为 mirai 码.

serializeToMiraiCode

@JvmStatic

fun CodableMessage.serializeToMiraiCode(): String

转换得到 mirai 码.

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

abstract override fun toString(): String

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

Properties

content

abstract val content: String

消息内容. 可为 JSON 文本或 XML 文本

content

val Message.content: String

Message.contentToString 的捷径

key

open override val key: MessageKey<RichMessage>

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

serviceId

abstract val serviceId: Int

目前未知, XML 一般为 60, JSON 一般为 1

ServiceMessage

See also

Inheritors

Types

Functions

Properties