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

OneBotMessageSegmentElement

abstract class OneBotMessageSegmentElement : OneBotMessageElement(source)

消息段 OneBotMessageSegment 作为 OneBotMessageElement 的实现。

OneBotMessageSegment 不能直接实现 Message.Element，因为消息段的多态序列化信息很可能会与其他序列化信息产生冲突（比如 at，没有特殊的前缀，容易引发歧义）。

因此需要使用 OneBotMessageSegmentElement 作为其包装。可以使用 OneBotMessageSegment.toElement 或此类的构造函数构建它。

Inheritors

DefaultOneBotMessageSegmentElement

Constructors

OneBotMessageSegmentElement

constructor()

Properties

abstract val segment: OneBotMessageSegment

Inherited functions

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。

resolveToOneBotSegment

@InternalOneBotAPI

@ApiStatus.Internal

fun Message.Element.resolveToOneBotSegment(defaultImageAdditionalParams: DefaultImageAdditionalParams? = null): OneBotMessageSegment?

将一个 Message.Element 转化为用于API请求的 OneBotMessageSegment。

resolveToOneBotSegmentAsync

@InternalOneBotAPI

fun Message.Element.resolveToOneBotSegmentAsync(): CompletableFuture<out OneBotMessageSegment?>

将一个 Message.Element 转化为用于API请求的 OneBotMessageSegment。

resolveToOneBotSegmentBlocking

@InternalOneBotAPI

fun Message.Element.resolveToOneBotSegmentBlocking(): OneBotMessageSegment?

将一个 Message.Element 转化为用于API请求的 OneBotMessageSegment。

resolveToOneBotSegmentList

@InternalOneBotAPI

@ApiStatus.Internal

fun Message.resolveToOneBotSegmentList(defaultImageAdditionalParams: DefaultImageAdditionalParams? = null): List<OneBotMessageSegment>

将 Message 解析为一用于API请求的 OneBotMessageSegment 列表。

resolveToOneBotSegmentListAsync

@InternalOneBotAPI

fun Message.resolveToOneBotSegmentListAsync(): CompletableFuture<out List<OneBotMessageSegment>>

将 Message 解析为一用于API请求的 OneBotMessageSegment 列表。

resolveToOneBotSegmentListBlocking

@InternalOneBotAPI

fun Message.resolveToOneBotSegmentListBlocking(): List<OneBotMessageSegment>

将 Message 解析为一用于API请求的 OneBotMessageSegment 列表。

resolveToOneBotSegmentListReserve

@InternalOneBotAPI

fun Message.resolveToOneBotSegmentListReserve(): SuspendReserve<List<OneBotMessageSegment>>

将 Message 解析为一用于API请求的 OneBotMessageSegment 列表。

resolveToOneBotSegmentReserve

@InternalOneBotAPI

fun Message.Element.resolveToOneBotSegmentReserve(): SuspendReserve<OneBotMessageSegment?>

将一个 Message.Element 转化为用于API请求的 OneBotMessageSegment。