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

ShowImageFlag

@Serializable(with = ShowImageFlag.Serializer::class)

object ShowImageFlag : AbstractMessageKey<ShowImageFlag> , MessageMetadata, ConstrainSingle

MessageChain 中包含秀图时的标记.

秀图已被 QQ 弃用, 仅作识别处理

MessageEvent event;

if (event.message.contains(ShowImageFlag.INSTANCE)) {
    // event.message 包含的图片是作为 '秀图' 发送
}

发送 ShowImageFlag 不会有任何效果.

Since

2.2

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

open override fun contentToString(): String

返回空字符串

followedBy

open fun followedBy(tail: Message): MessageChain

将 this 和 tail 连接.

isContentBlank

fun Message.isContentBlank(): Boolean

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

isContentEmpty

fun Message.isContentEmpty(): Boolean

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

isInstance

fun MessageKey<*>.isInstance(message: SingleMessage): Boolean

尝试 MessageKey.safeCast, 成功时返回 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 发送给指定联系人

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: ShowImageFlag

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

safeCast

open override val safeCast: (SingleMessage) -> ShowImageFlag?

将一个 SingleMessage 强转为 M 类型. 在类型不符合时返回 null

SERIAL_NAME

const val SERIAL_NAME: String

topmostKey

val <A : SingleMessage> MessageKey<A>.topmostKey: MessageKey<*>

获取最上层 MessageKey.