~~open~~ ~~class~~ ~~Voice~~ @MiraiInternalApi ~~constructor~~(~~fileName~~: String, ~~md5~~: ByteArray, ~~fileSize~~: Long, ~~_codec~~: Int, ~~_url~~: String) : ~~PttMessage~~

已弃用的旧版本语音消息.

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 Member.at(): At

At 这个成员

buildForwardMessage

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

构造一条 ForwardMessage

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

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

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

FileMessage

inline 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

inline 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

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

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

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

recallSource

inline suspend fun QuoteReply.recallSource()

撤回引用的源消息

repeat

inline fun Message.repeat(count: Int): MessageChain

将此消息元素按顺序重复 count 次.

sendTo

inline suspend fun <C : Contact> Message.sendTo(contact: C): MessageReceipt<C>

将 this 发送给指定联系人

times

inline operator fun Message.times(count: Int): MessageChain

将此消息元素按顺序重复 count 次.

toByteArray

@MiraiExperimentalApi

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

序列化这个消息

toForwardMessage

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

fun Message.toForwardMessage(sender: User, time: Int = currentTimeSeconds().toInt(), displayStrategy: ForwardMessage.DisplayStrategy = DisplayStrategy): ForwardMessage

fun Message.toForwardMessage(senderId: Long, senderName: String, time: Int = currentTimeSeconds().toInt(), displayStrategy: ForwardMessage.DisplayStrategy = DisplayStrategy): ForwardMessage

转换为 ForwardMessage

toMessageChain

fun <ERROR CLASS><Message>.toMessageChain(): MessageChain

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

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

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

fun Sequence<Message>.toMessageChain(): MessageChain

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

扁平化 this 并创建一个 MessageChain.

fun Message.toMessageChain(): MessageChain

toOffline

fun OnlineMessageSource.toOffline(): OfflineMessageSource

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

toPlainText

inline fun String.toPlainText(): PlainText

构造 PlainText

toVoice

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

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

UnsupportedMessage

inline fun UnsupportedMessage(struct: ByteArray): UnsupportedMessage

创建 UnsupportedMessage

Properties

bot

val MessageChain.bot: Bot

消息内部 ids.

bot

val MessageSource.bot: Bot

根据 MessageSource.botId 从 Bot.getInstance 获取 Bot

botOrNull

val MessageSource.botOrNull: Bot?

根据 MessageSource.botId 从 Bot.getInstanceOrNull 获取 Bot

content

val Message.content: String

Message.contentToString 的捷径

ids

val MessageChain.ids: IntArray

消息 ids.

internalId

val MessageChain.internalId: IntArray

消息内部 ids.

kind

val MessageSource.kind: MessageSourceKind

获取 MessageSourceKind

kind

val OnlineMessageSource.kind: MessageSourceKind

获取 MessageSourceKind

md5

@MiraiInternalApi

~~val~~ Image.~~md5~~: ByteArray

source

val MessageChain.source: MessageSource

获取这条消息的消息源.

sourceOrNull

val MessageChain.sourceOrNull: MessageSource?

获取这条消息的消息源.

time

val MessageChain.time: Int

消息时间.

topmostKey

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

获取最上层 MessageKey.