Simple Robot 组件 | OneBot

1.7.0

simbot-component-onebot-v11-message/love.forte.simbot.component.onebot.v11.message.segment

Package-level declarations

Types

DefaultOneBotMessageSegmentElement

@SerialName(value = "ob11.segment.default")

data class DefaultOneBotMessageSegmentElement(val segment: OneBotMessageSegment) : OneBotMessageSegmentElement

OneBotMessageSegmentElement 的普通默认实现。

OneBotAnonymous

@SerialName(value = "anonymous")

class OneBotAnonymous : OneBotMessageSegment

匿名发消息

@SerialName(value = "at")

class OneBotAt : OneBotMessageSegment

@SerialName(value = "contact")

class OneBotContact : OneBotMessageSegment

@SerialName(value = "dice")

object OneBotDice : OneBotMessageSegment, OneBotMessageSegmentElementResolver

掷骰子魔法表情

@SerialName(value = "face")

class OneBotFace : OneBotMessageSegment

@SerialName(value = "forward")

class OneBotForward : OneBotMessageSegment

OneBotForwardNode

@SerialName(value = "node")

class OneBotForwardNode : OneBotMessageSegment

@SerialName(value = "image")

class OneBotImage : OneBotMessageSegment, OneBotMessageSegmentElementResolver

@SerialName(value = "json")

class OneBotJson : OneBotMessageSegment

@SerialName(value = "location")

class OneBotLocation : OneBotMessageSegment

OneBotMessageSegment

interface OneBotMessageSegment

OneBot11的消息段类型定义。其中，消息段的类型 type 由多态序列化类型名决定，而 data 的类型则由实现者决定。

OneBotMessageSegmentElement

abstract class OneBotMessageSegmentElement : OneBotMessageElement

消息段 OneBotMessageSegment 作为 OneBotMessageElement 的实现。

OneBotMessageSegmentElementResolver

interface OneBotMessageSegmentElementResolver

由 OneBotMessageSegment 类型的实现类实现，表示它可以将自己转化为一个独特的 OneBotMessageSegmentElement 类型，例如某个实现了 MentionMessage 的 OneBotMessageSegmentElement 实例。

OneBotMessageSegmentSerializer

object OneBotMessageSegmentSerializer : KSerializer<List<OneBotMessageSegment>>

可用于便捷地直接对一个 OneBotMessageSegment 列表进行序列化地序列化器。

@SerialName(value = "music")

class OneBotMusic : OneBotMessageSegment

@SerialName(value = "poke")

class OneBotPoke : OneBotMessageSegment

@SerialName(value = "record")

class OneBotRecord : OneBotMessageSegment

@SerialName(value = "reply")

class OneBotReply : OneBotMessageSegment, MessageReference

@SerialName(value = "rps")

object OneBotRps : OneBotMessageSegment

猜拳魔法表情

@SerialName(value = "shake")

object OneBotShake : OneBotMessageSegment

窗口抖动（戳一戳）

@SerialName(value = "share")

class OneBotShare : OneBotMessageSegment

@SerialName(value = "text")

class OneBotText : OneBotMessageSegment, OneBotMessageSegmentElementResolver

OneBotUnknownSegment

@FragileSimbotAPI

@ExperimentalOneBotAPI

data class OneBotUnknownSegment @InternalOneBotAPI constructor(val type: String, val data: JsonElement? = null) : OneBotMessageSegment

一个未知类型的 OneBotMessageSegment。

OneBotUnknownSegmentDeserializer

@InternalOneBotAPI

@ExperimentalOneBotAPI

object OneBotUnknownSegmentDeserializer : DeserializationStrategy<OneBotUnknownSegment>

OneBotUnknownSegment 的反序列化器，将任意未知的segment内容解析为 OneBotUnknownSegment

OneBotUnknownSegmentPolymorphicSerializer

@InternalOneBotAPI

@ExperimentalOneBotAPI

class OneBotUnknownSegmentPolymorphicSerializer(type: String) : SerializationStrategy<OneBotMessageSegment>

OneBotUnknownSegment 的多态序列化器，提供类型 type 后进行序列化。

@SerialName(value = "video")

class OneBotVideo : OneBotMessageSegment

@SerialName(value = "xml")

class OneBotXml : OneBotMessageSegment

Inherited functions

fun MessagesBuilder.add(segment: OneBotMessageSegment): MessagesBuilder

向 MessagesBuilder 中直接添加一个 OneBotMessageSegment。

inline fun OneBotImage.Factory.create(resource: Resource, block: OneBotImage.AdditionalParams.() -> Unit): OneBotImage

使用 Resource 构建一个用于发送的 OneBotImage。

isOneBotSegment

inline fun <T : OneBotMessageSegment> Message.Element.isOneBotSegment(): Boolean

判断 this 的类型是 OneBotMessageSegmentElement 并且 segment 的类型是 T。

inline fun <T : OneBotMessageSegment> Message.Element.oneBotSegment(): T

如果this 的类型是 OneBotMessageSegmentElement 并且 segment，则获取到对应的 T 结果，否则抛出 ClassCastException。

oneBotSegmentOrNull

inline fun <T : OneBotMessageSegment> Message.Element.oneBotSegmentOrNull(): T?

如果this 的类型是 OneBotMessageSegmentElement 并且 segment，则获取到对应的 T 结果，否则得到 null。

fun OneBotMessageSegment.toElement(): OneBotMessageSegmentElement

将 OneBotMessageSegment 转化或包装为 OneBotMessageSegmentElement。这并不是在收到消息时用于转换类型的直接方法，而是 OneBotMessageSegment.resolveToMessageElement —— 后者会将一些与标准消息元素无差别的类型直接转为标准消息类型，例如将 OneBotAt 转为 At 或 AtAll、OneBotFace 转为 Face。