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

CustomMessageMetadata

@MiraiExperimentalApi

abstract class CustomMessageMetadata : CustomMessage, MessageMetadata

自定义消息元数据.

实现方法:

实现一个类继承 CustomMessageMetadata, 添加 @Serializable (来自 kotlinx.serialization)
添加伴生对象, 继承 CustomMessage.ProtoBufSerializerFactory 或 CustomMessage.JsonSerializerFactory, 或 CustomMessage.Factory
在需要解析消息前调用一次伴生对象以注册

注意: 这是实验性 API. 可能会在未来发生变动.

Constructors

CustomMessageMetadata

fun CustomMessageMetadata()

Types

Companion

object Companion

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

customToString

open fun customToString(): ByteArray

followedBy

open fun followedBy(tail: Message): MessageChain

将 this 和 tail 连接.

getFactory

abstract fun getFactory(): CustomMessage.Factory<out CustomMessage>

获取这个消息的工厂

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

CustomMessageMetadata

See also

Constructors

Types

Functions