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

CustomMessage

@MiraiExperimentalApi

sealed class CustomMessage : SingleMessage

自定义消息

它不会显示在消息文本中, 也不会被其他客户端识别. 只有 mirai 才能识别这些消息.

目前在回复时无法通过 MessageSource.originalMessage 获取自定义类型消息

序列化

若要支持序列化, 需 MessageSerializers.registerSerializer

Samples

samples.CustomMessageIdentifier

Types

Companion

object Companion

Factory

@MiraiExperimentalApi

abstract class Factory<M : CustomMessage>(typeName: String)

序列化和反序列化此消息的工厂, 将会自动注册. 应实现为 object.

JsonSerializerFactory

abstract class JsonSerializerFactory<M : CustomMessage>(typeName: String) : CustomMessage.Factory<M>

使用 Json 作为序列模式的 Factory 推荐在调试时使用此工厂

ProtoBufSerializerFactory

abstract class ProtoBufSerializerFactory<M : CustomMessage>(typeName: String) : CustomMessage.Factory<M>

使用 ProtoBuf 作为序列模式的 Factory. 推荐使用此工厂

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

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

abstract override fun toString(): String

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

Inheritors

CustomMessageMetadata

CustomMessage

序列化

Samples

See also

Types

Functions

Inheritors