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

ForwardMessage

data class ForwardMessage(preview: List<String>, title: String, brief: String, source: String, summary: String, nodeList: List<ForwardMessage.Node>) : MessageContent, ConstrainSingle

合并转发消息

显示方案

移动端

在移动客户端将会显示为卡片

<title>: DisplayStrategy.generateTitle
<preview>: DisplayStrategy.generatePreview
<summary>: DisplayStrategy.generateSummary

|-------------------------|
| <title>                 |
| <preview>               |
|-------------------------|
| <summary>               |
|-------------------------|

默认显示方案:

|-------------------------|
| 群聊的聊天记录             |
| <消息 1>                 |
| <消息 2>                 |
| <消息 3>                 |
|-------------------------|
| 查看3条转发消息          |
|-------------------------|

PC 端

在部分 PC 端显示为类似移动端的卡片, 在其他 PC 端显示为以下格式

鸽子 A 2020/04/23 11:27:54
咕
鸽子 B 2020/04/23 11:27:55
咕
鸽子 C 1970/01/01 08:00:00
咕咕咕

构造

使用构建器 ForwardMessageBuilder
使用 DSL
通过 MessageEvent 集合转换: toForwardMessage

Constructors

ForwardMessage

fun ForwardMessage(preview: List<String>, title: String, brief: String, source: String, summary: String, nodeList: List<ForwardMessage.Node>)

Types

DisplayStrategy

interface DisplayStrategy

合并转发卡片展示策略. 用于 RawForwardMessage 的渲染.

INode

@MiraiExperimentalApi

interface INode

请构造 Node

Key

object Key : AbstractPolymorphicMessageKey<MessageContent, ForwardMessage>

Node

data class Node(senderId: Long, time: Int, senderName: String, messageChain: MessageChain) : ForwardMessage.INode

消息节点

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

open override fun contentToString(): String

转为最接近官方格式的字符串. 如 At(member) + "test" 将转为 "@群名片 test".

followedBy

open fun followedBy(tail: Message): MessageChain

将 this 和 tail 连接.

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

Properties

brief

val brief: String

key

open override val key: MessageKey<ForwardMessage>

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

nodeList

val nodeList: List<ForwardMessage.Node>

preview

val preview: List<String>

source

val source: String

summary

val summary: String

title

val title: String

ForwardMessage

显示方案

移动端

PC 端

构造

See also

Constructors

Types

Functions

Properties