simbot-api/love.forte.simbot.message

Package-level declarations

Types

abstract class AggregatedMessageReceipt : StandardMessageReceipt, Iterable<SingleMessageReceipt>

聚合消息回执，代表多个 SingleMessageReceipt 的聚合体。

@SerialName(value = "m.std.at")

data class At @JvmOverloads constructor(val target: ID, val type: String = "user", val originContent: String = "@") : BaseStandardMessage<At>

一个 at 的标准。 at、或者说一个通知信息，用于通知一个用户目标。一个 At只能代表一个通知目标。

AtAll

@SerialName(value = "m.std.atAll")

@Serializable

object AtAll : BaseStandardMessage<AtAll> , Message.Key<AtAll>

一个通知所有人的消息。

BaseStandardMessage

@SerialName(value = "m.std")

@Serializable

sealed class BaseStandardMessage<out E : Message.Element<E>> : StandardMessage<E>

Emoji

@SerialName(value = "m.std.emoji")

@Serializable

data class Emoji(val id: ID) : StandardMessage<Emoji>

一个 Emoji。目前绝大多数平台已经不会再用一个独特的 "Emoji" 类型来专门标识Emoji了，此类型仅作为保留类型。

EmptyMessages

@Serializable

object EmptyMessages : Messages, View<Message.Element<*>>

没有任何元素的 Messages. 在追加列表时，总是会直接替换为后者。

Face

@SerialName(value = "m.std.face")

@Serializable

data class Face(val id: ID) : StandardMessage<Face>

一个表情。一般代表平台提供的自带表情。

Image

interface Image<E : Image<E>> : StandardMessage<E> , IDContainer, ResourceContainer

一个图片消息。

JsonBuilder4J

@Api4J

fun interface JsonBuilder4J

LocalMessageContent

abstract class LocalMessageContent : MessageContent

一个本地的消息实体，一般代表本地构建的非远端存在的消息。

Message

interface Message

消息。

MessageContainer

interface MessageContainer

一个消息容器，代表了一个承载着消息的内容。

MessageContent

abstract class MessageContent

一个消息内容，其中存在一个消息链。

MessageList

sealed class MessageList : Messages, IndexAccessView<Message.Element<*>>

Messages 基础实现, 是元素数量不应为空的消息列表。

MessageReceipt

interface MessageReceipt : DeleteSupport

消息回执，当消息发出去后所得到的回执信息。

Messages

interface Messages : View<Message.Element<*>> , RandomAccess, Message

消息列表，代表为可能多条的 MsgElement 信息。

MessagesBuilder

class MessagesBuilder @JvmOverloads constructor(collection: MutableCollection<Message.Element<*>>? = null)

用于构建 Messages 的构建器，提供了针对于标准消息的快捷api，并支持追加其他额外消息。

MessageSerializationUtil

@Api4J

object MessageSerializationUtil

服务于Java对 Messages 进行序列化的工具类。

ObtainedMessageContent

abstract class ObtainedMessageContent : RemoteMessageContent

一个获得的 MessageContent, 即主动获取的消息，常见于历史消息获取。

PlainText

interface PlainText<out A : PlainText<A>> : StandardMessage<A>

纯文本消息。代表一段只存在文本的消息。

ReceivedMessageContent

abstract class ReceivedMessageContent : RemoteMessageContent

一个接收到的 MessageContent, 即事件中的 MessageContent, 代表一个被动获取的消息。

RemoteMessageContainer

interface RemoteMessageContainer : MessageContainer

RemoteMessageContent

sealed class RemoteMessageContent : MessageContent, DeleteSupport

一个远端消息主体，一般代表通过事件或者查询而得的事件主体。

RemoteResource

interface ~~RemoteResource~~<E : RemoteResource<E>> : StandardMessage<E> , IDContainer

RemoteResource 代表一个携带 url 信息的远程资源。常见为文件或图片等形式。

ResourceImage

@SerialName(value = "m.std.img.resource")

@Serializable

data class ResourceImage constructor(val id: ID, _resource: Resource) : Image<ResourceImage>

通过直接提供 resource 的标准 Image 实现类型。常用于发送。

SingleMessageReceipt

abstract class SingleMessageReceipt : StandardMessageReceipt, IDContainer

明确代表为一个或零个（发送失败时）具体消息的消息回执，可以作为 AggregatedMessageReceipt 的元素进行聚合。

StandardMessage

interface StandardMessage<out E : Message.Element<E>> : Message.Element<E>

一些由核心提供的标准 Message 实例或标准. 标准消息中，仅提供如下实现：

StandardMessageReceipt

sealed class StandardMessageReceipt : MessageReceipt

由 MessageReceipt 衍生的标准消息回执类型, 提供用于表示独立元素回执的 SingleMessageReceipt 和复合回执的 AggregatedMessageReceipt.

Text

@Serializable

@SerialName(value = "m.std.text")

open class Text(val text: String) : BaseStandardMessage<Text> , PlainText<Text>

一个文本消息 Text。Text 是 PlainText 基础实现类型。

Properties

isStandard

val Message.Element<*>.isStandard: Boolean

判断一个 Message.Element 是否为一个标准 Message 下的实现。

Functions

aggregation

fun Collection<SingleMessageReceipt>.aggregation(): AggregatedMessageReceipt

fun Iterable<SingleMessageReceipt>.aggregation(): AggregatedMessageReceipt

fun List<SingleMessageReceipt>.aggregation(): AggregatedMessageReceipt

将多个 SingleMessageReceipt 聚合为 AggregatedMessageReceipt.

buildMessages

inline fun buildMessages(initial: MutableCollection<Message.Element<*>>? = null, block: MessagesBuilder.() -> Unit): Messages

通过 MessagesBuilder 构建 Messages.

deleteAllSafely

inline suspend fun AggregatedMessageReceipt.deleteAllSafely(onResult: (Result<Boolean>) -> Unit = { /* Just.. ignore it. */ })

尝试删除其所代表的所有消息回执。

doCast

inline fun <E> doCast(value: Any): E

将 value 转化为类型 E，如果类型不匹配则抛出 ClassCastException 异常。

doSafeCast

inline fun <E> doSafeCast(value: Any): E?

将 value 安全的转化为类型 E，或者得到null。相当于 value as? E

emptyMessages

fun emptyMessages(): Messages

得到一个空的消息列表。

filter

fun <E : Message.Element<E>> Iterable<Message.Element<*>>.filter(key: Message.Key<E>): Sequence<E>

fun <E : Message.Element<E>> Sequence<Message.Element<*>>.filter(key: Message.Key<E>): Sequence<E>

messages

fun messages(): Messages

得到元素为空的 Messages 实例。

fun messages(vararg messages: Message.Element<*>): Messages

将提供的消息元素组合为 Messages.

plus

operator fun Message.Element<*>.plus(other: Message.Element<*>): Messages

MsgElement 与另外一个 MsgElement 进行拼接并组合为 Messages.

operator fun Message.Element<*>.plus(other: Messages): Messages

MsgElement 与另外一个 Messages 进行拼接并组合为 Messages.

sendTo

infix inline suspend fun Message.sendTo(support: SendSupport): MessageReceipt

SendSupport.send 的反转形式，可以使用中缀函数写法。

Text

fun Text(): Text

得到一个空的 Text.

inline fun Text(block: () -> String): Text

构建一个 Text.

toMessages

fun Iterable<Message.Element<*>>.toMessages(): Messages

将元素为 MsgElement 的 Iterable 转化为 Messages 实例。

fun Message.Element<*>.toMessages(): Messages

得到元素数量为1的Messages实例。

toText

fun String.toText(): Text

将一个字符串转化为 Text.