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

Package-level declarations

Types

abstract class AbstractMessageKey<out M : SingleMessage>(val safeCast: (SingleMessage) -> M?) : MessageKey<M>

独立的 MessageKey 的实现. '独立' 即 final, 不支持多态类型. 适用于作为最顶层的 MessageKey, 如 MessageSource.

abstract class AbstractPolymorphicMessageKey<out B : SingleMessage, out M : B>(baseKey: MessageKey<B>, safeCast: (SingleMessage) -> M?) : AbstractMessageKey<M> , MessageKey<M>

多态 MessageKey.

AbstractServiceMessage

@MiraiExperimentalApi

@Serializable

abstract class AbstractServiceMessage : ServiceMessage

@Serializable

data class At(val target: Long) : MessageContent, CodableMessage

At 一个群成员. 只能发送给一个群.

AtAll

@Serializable

object AtAll : MessageContent, CodableMessage

"@全体成员".

Audio

interface Audio : MessageContent, ConstrainSingle

语音消息.

AudioCodec

@Serializable(with = AudioCodec.AsIntSerializer::class)

enum AudioCodec : Enum<AudioCodec>

语音编码方式.

CombinedMessage

@MiraiInternalApi

class CombinedMessage constructor(val element: Message, val tail: Message, val hasConstrainSingle: Boolean) : AbstractMessageChain, List<SingleMessage>

树状消息链的一个节点. element 为当前元素, tail 为下一个元素.

ConstrainSingle

interface ConstrainSingle : SingleMessage

约束一个 MessageChain 中只存在这一种类型的元素. 新元素将会替换旧元素, 保持原顺序.

CustomMessage

@Serializable

@MiraiExperimentalApi

sealed class CustomMessage : SingleMessage

自定义消息

CustomMessageMetadata

@Serializable

@MiraiExperimentalApi

abstract class CustomMessageMetadata : CustomMessage, MessageMetadata

自定义消息元数据.

Dice

@Serializable

data class Dice(val value: Int) : MarketFace, CodableMessage

骰子.

EmptyMessageChain

object ~~EmptyMessageChain~~ : AbstractMessageChain, MessageChain, List<SingleMessage> , DirectSizeAccess, DirectToStringAccess

不含任何元素的 MessageChain. 已弃用, 请使用 emptyMessageChain.

Face

@Serializable

data class Face(val id: Int) : MessageContent, CodableMessage

QQ 自带表情

FlashImage

@Serializable

data class FlashImage(val image: Image) : MessageContent, HummerMessage, CodableMessage, ConstrainSingle

闪照. 闪照的内容取决于 image 代表的图片.

ForwardMessage

@Serializable

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

合并转发消息

ForwardMessageBuilder

class ForwardMessageBuilder : MutableList<ForwardMessage.INode>

转发消息 DSL 构建器.

ForwardMessageDsl

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.TYPE])

@DslMarker

annotation class ForwardMessageDsl

标记转发消息 DSL

HummerMessage

@MiraiExperimentalApi

@NotStableForInheritance

interface HummerMessage : MessageContent, ConstrainSingle

一些特殊的消息

Image

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

@NotStableForInheritance

interface Image : Message, MessageContent, CodableMessage

自定义表情 (收藏的表情) 和普通图片.

ImageType

@Serializable

enum ImageType : Enum<ImageType>

InternalImageProtocol

@MiraiInternalApi

interface InternalImageProtocol

内部图片协议实现

LightApp

@Serializable

data class LightApp(val content: String) : RichMessage, CodableMessage

小程序.

MarketFace

@NotStableForInheritance

interface MarketFace : HummerMessage

商城表情

MessageChain

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

@NotStableForInheritance

interface MessageChain : Message, List<SingleMessage> , RandomAccess, CodableMessage

消息链, List<SingleMessage>, 即单个消息元素的有序集合.

MessageChainBuilder

class MessageChainBuilder : MutableList<SingleMessage> , Appendable

MessageChain 构建器.

MessageContent

interface MessageContent : SingleMessage

带内容的消息.

MessageKey

interface MessageKey<out M : SingleMessage>

类型 Key. 由伴生对象实现, 表示一个 Message 对象的类型.

MessageMetadata

interface MessageMetadata : SingleMessage

消息元数据, 即不含内容的元素.

MessageOriginKind

@Serializable

enum MessageOriginKind : Enum<MessageOriginKind>

MessageOrigin 来源

MessageSource

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

sealed class MessageSource : Message, MessageMetadata, ConstrainSingle

表示聊天中的一条消息的定位信息, 即消息源.

MessageSourceAmender

class MessageSourceAmender(origin: MessageSource) : MessageSourceBuilder

MessageSource 复制修改器. 不会修改原 MessageSource, 而是会创建一个新的 MessageSource.

MessageSourceBuilder

open class MessageSourceBuilder

离线消息源构建器.

MessageSourceKind

@Serializable

enum MessageSourceKind : Enum<MessageSourceKind>

消息来源类型

MusicKind

enum MusicKind : Enum<MusicKind>

MusicShare

@Serializable

data class MusicShare(val kind: MusicKind, val title: String, val summary: String, val jumpUrl: String, val pictureUrl: String, val musicUrl: String, val brief: String) : MessageContent, ConstrainSingle, CodableMessage

QQ 互联通道音乐分享.

OfflineAudio

@NotStableForInheritance

interface OfflineAudio : Audio

离线语音消息.

OfflineMessageSource

@NotStableForInheritance

abstract class OfflineMessageSource : MessageSource

一条在本地构建的, 或其他不保证指向一条服务器上存在的消息的消息源.

OnlineAudio

@NotStableForInheritance

interface OnlineAudio : Audio

在线语音消息, 即从消息事件中接收到的语音消息.

OnlineMessageSource

sealed class OnlineMessageSource : MessageSource

从服务器接收的在线消息的 MessageSource.

OrNullDelegate

@JvmInline

value class OrNullDelegate<out R>

可空的委托

PlainText

@Serializable

data class PlainText(val content: String) : MessageContent, CodableMessage

纯文本.

PokeMessage

@Serializable

data class PokeMessage @MiraiInternalApi constructor(val name: String, val pokeType: Int, val id: Int) : HummerMessage, CodableMessage

戳一戳. 可以发送给好友或群.

QuoteReply

@Serializable

data class QuoteReply(val source: MessageSource) : Message, MessageMetadata, ConstrainSingle

引用回复. QuoteReply 被作为 MessageMetadata, 因为它不包含实际的消息内容.

RawForwardMessage

@Serializable

data class RawForwardMessage(val nodeList: List<ForwardMessage.Node>)

未通过 DisplayStrategy 渲染的合并转发消息. RawForwardMessage 仅作为一个中间件, 用于 ForwardMessageBuilder.

RichMessage

@NotStableForInheritance

interface RichMessage : MessageContent, ConstrainSingle

XML, JSON 消息等富文本消息.

RockPaperScissors

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

enum RockPaperScissors : Enum<RockPaperScissors> , MarketFace, CodableMessage

石头剪刀布.

ServiceMessage

@NotStableForInheritance

interface ServiceMessage : RichMessage, CodableMessage

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

ShowImageFlag

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

object ShowImageFlag : AbstractMessageKey<ShowImageFlag> , MessageMetadata, ConstrainSingle

MessageChain 中包含秀图时的标记.

SimpleServiceMessage

@MiraiExperimentalApi

@Serializable

class SimpleServiceMessage(val serviceId: Int, val content: String) : ServiceMessage

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

SingleMessage

interface SingleMessage : Message

单个消息元素. 与之相对的是 MessageChain, 是多个 SingleMessage 的集合.

UnsupportedMessage

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

@NotStableForInheritance

interface UnsupportedMessage : MessageContent

mirai 尚未支持的消息类型.

VipFace

@Serializable

data class VipFace @MiraiInternalApi constructor(val kind: VipFace.Kind, val count: Int) : HummerMessage, CodableMessage

VIP 表情.

XmlMessageDsl

@MiraiExperimentalApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.TYPE])

@DslMarker

annotation class XmlMessageDsl

Functions

anyIsInstance

inline fun <M : SingleMessage> MessageChain.anyIsInstance(): Boolean

当 this 中存在 M 的实例时返回 true.

inline fun At(user: UserOrBot): At

构造 At

inline fun Member.at(): At

At 这个成员

buildForwardMessage

inline fun buildForwardMessage(context: Contact, displayStrategy: ForwardMessage.DisplayStrategy = DisplayStrategy, block: ForwardMessageBuilder.() -> Unit): ForwardMessage

构造一条 ForwardMessage

buildForwardMessage

inline fun MessageEvent.buildForwardMessage(context: Contact = this.subject, displayStrategy: ForwardMessage.DisplayStrategy = DisplayStrategy, block: ForwardMessageBuilder.() -> Unit): ForwardMessage

使用 DSL 构建一个 ForwardMessage.

buildMessageChain

inline fun buildMessageChain(block: MessageChainBuilder.() -> Unit): MessageChain

构建一个 MessageChain. 用法查看 MessageChainBuilder.

inline fun buildMessageChain(initialSize: Int, block: MessageChainBuilder.() -> Unit): MessageChain

使用特定的容器大小构建一个 MessageChain. 用法查看 MessageChainBuilder.

buildMessageSource

inline fun Bot.buildMessageSource(kind: MessageSourceKind, block: MessageSourceBuilder.() -> Unit): OfflineMessageSource

inline fun IMirai.buildMessageSource(botId: Long, kind: MessageSourceKind, block: MessageSourceBuilder.() -> Unit): OfflineMessageSource

使用 DSL 构建一个 OfflineMessageSource. 用法参考 MessageSourceBuilder.

contentsList

fun MessageChain.contentsList(): List<MessageContent>

筛选 MessageContent

contentsSequence

fun MessageChain.contentsSequence(): Sequence<MessageContent>

获取 Sequence<MessageContent> 相当于 this.asSequence().filterIsInstance<MessageContent>()

copyAmend

@JvmName(name = "copySource")

fun MessageSource.copyAmend(block: MessageSourceAmender.() -> Unit): OfflineMessageSource

复制这个消息源, 并以 block 修改

emptyMessageChain

fun emptyMessageChain(): MessageChain

返回一个不含任何元素的 MessageChain.

FileMessage

fun FileMessage(id: String, internalId: Int, name: String, size: Long): FileMessage

构造 FileMessage

findIsInstance

inline fun <M : SingleMessage?> MessageChain.findIsInstance(): M?

获取第一个 M 实例. 在不存在时返回 null.

firstIsInstance

inline fun <M : SingleMessage> MessageChain.firstIsInstance(): M

获取第一个 M 实例. 在不存在时抛出 NoSuchElementException.

firstIsInstanceOrNull

inline fun <M : SingleMessage?> MessageChain.firstIsInstanceOrNull(): M?

获取第一个 M 实例. 在不存在时返回 null.

flash

inline fun Image.flash(): FlashImage

将普通图片转换为闪照.

FlashImage

inline fun FlashImage(imageId: String): FlashImage

将普通图片转换为闪照.

getOrFail

inline fun <M : SingleMessage> MessageChain.getOrFail(key: MessageKey<M>, crossinline lazyMessage: (key: MessageKey<M>) -> String = { key.toString() }): M

获取第一个类型为 key 的 Message 实例, 在找不到此类型的元素时抛出 NoSuchElementException

getValue

inline operator fun <T : SingleMessage> MessageChain.getValue(thisRef: Any?, property: KProperty<*>): T

提供一个类型的值的委托. 若不存在则会抛出异常 NoSuchElementException

Image

fun Image(imageId: String): Image

通过 Image.imageId 构造一个 Image 以便发送.

inline fun Image(imageId: String, builderAction: Image.Builder.() -> Unit = {}): Image

使用 Image.Builder 构建一个 Image.

isContentBlank

fun Message.isContentBlank(): Boolean

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

isContentEmpty

fun Message.isContentEmpty(): Boolean

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

isInstance

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

尝试 MessageKey.safeCast, 成功时返回 true

messageChainOf

@JvmName(name = "newChain")

inline fun messageChainOf(vararg messages: Message): MessageChain

返回一个包含 messages 所有元素的消息链, 保留顺序.

metadataList

fun MessageChain.metadataList(): List<MessageMetadata>

筛选 MessageMetadata

metadataSequence

fun MessageChain.metadataSequence(): Sequence<MessageMetadata>

获取 Sequence<MessageMetadata> 相当于 this.asSequence().filterIsInstance<MessageMetadata>()

OfflineAudio

inline fun OfflineAudio(onlineAudio: OnlineAudio): OfflineAudio

使用 OnlineAudio 的信息构造 OfflineAudio.

inline fun OfflineAudio(filename: String, fileMd5: ByteArray, fileSize: Long, codec: AudioCodec, extraData: ByteArray?): OfflineAudio

构造 OfflineAudio. 有关参数的含义, 参考 Audio.

orElse

inline fun <T : R, R : SingleMessage?> MessageChain.orElse(lazyDefault: () -> R): OrNullDelegate<R>

提供一个类型的 Message 的委托, 若不存在这个类型的 Message 则委托会提供 null

orNull

inline fun <T : SingleMessage> MessageChain.orNull(): OrNullDelegate<T?>

提供一个类型的 Message 的委托, 若不存在这个类型的 Message 则委托会提供 null

plus

suspend operator fun Message.plus(another: Flow<Message>): MessageChain

将 another 按顺序连接到这个消息的尾部.

recallSource

inline suspend fun QuoteReply.recallSource()

撤回引用的源消息

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

toByteArray

@MiraiExperimentalApi

fun <T : CustomMessage> T.toByteArray(): ByteArray

序列化这个消息

toForwardMessage

@JvmOverloads

fun Iterable<MessageEvent>.toForwardMessage(displayStrategy: ForwardMessage.DisplayStrategy = DisplayStrategy): ForwardMessage

@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

inline fun Array<out Message>.toMessageChain(): MessageChain

@JvmName(name = "newChain")

inline fun Iterable<Message>.toMessageChain(): MessageChain

@JvmName(name = "newChain")

inline fun Iterator<Message>.toMessageChain(): MessageChain

@JvmName(name = "newChain")

fun Sequence<Message>.toMessageChain(): MessageChain

@JvmName(name = "newChain")

suspend fun Flow<Message>.toMessageChain(): MessageChain

扁平化 this 并创建一个 MessageChain.

@JvmName(name = "newChain")

fun Message.toMessageChain(): MessageChain

fun <Error class: unknown class><Message>.toMessageChain(): MessageChain

扁平化 this 并创建一个 MessageChain.

toOffline

@JvmName(name = "toOfflineMessageSource")

fun OnlineMessageSource.toOffline(): OfflineMessageSource

将在线消息源转换为离线消息源.

toPlainText

inline fun String.toPlainText(): PlainText

构造 PlainText

toVoice

fun Audio.~~toVoice~~(): Voice

将 2.7 新增的 Audio 转为旧版本的 Voice, 以兼容某些情况.

UnsupportedMessage

inline fun UnsupportedMessage(struct: ByteArray): UnsupportedMessage

创建 UnsupportedMessage

Properties

bot

val MessageChain.bot: Bot

消息内部 ids.

val MessageSource.bot: Bot

获取此消息源的相关 Bot.

botOrNull

val MessageSource.botOrNull: Bot?

获取此消息源的相关 Bot.

content

val Message.content: String

Message.contentToString 的捷径

ids

val MessageChain.ids: IntArray

消息 ids.

internalId

val MessageChain.internalId: IntArray

消息内部 ids.

lengthDuration

val OnlineAudio.lengthDuration: Duration

获取语音长度秒数, 作为 Duration.

source

val MessageChain.source: MessageSource

获取这条消息的消息源.

sourceOrNull

val MessageChain.sourceOrNull: MessageSource?

获取这条消息的消息源.

time

val MessageChain.time: Int

消息时间.

topmostKey

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

获取最上层 MessageKey.