simbot-api/love.forte.simbot.message/MessagesBuilder

MessagesBuilder

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

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

在Java中，你可以直接实例化并使用此构建器：

final MessagesBuilder builder = new MessagesBuilder();

final Messages messages = builder.at(Identifies.ID(123))
        .face(Identifies.ID("hi"))
        .atAll()
        .text("Hello ")
        .append(Text.of("World"))
        .build();

在kotlin中，你可以参考使用 buildMessages 来得到更佳的使用体验:

buildMessages {
 + "Hello "
 + "World".toText()
 + Face(2.ID)
 at(567.ID)
}

此构建器不是线程安全的。

Author

ForteScarlet

Constructors

MessagesBuilder

constructor(messages: Messages)

@JvmOverloads

constructor(collection: MutableCollection<Message.Element<*>>? = null)

Functions

append

fun append(vararg elements: Message.Element<*>): MessagesBuilder

fun append(elements: Iterable<Message.Element<*>>): MessagesBuilder

拼接多个任意消息。

fun append(text: String): MessagesBuilder

拼接一个字符串文本。

fun append(element: Message.Element<*>): MessagesBuilder

拼接一个任意消息。

@JvmOverloads

fun at(target: ID, atType: String = "user", originContent: String = "@"): MessagesBuilder

拼接一个 at。

atAll

fun atAll(): MessagesBuilder

拼接一个 atAll。

build

fun build(): Messages

根据前构建器中的内容构建一个 Messages 实例。

emoji

fun emoji(id: ID): MessagesBuilder

拼接一个emoji。

face

fun face(id: ID): MessagesBuilder

拼接一个表情。

image

suspend fun image(bot: Bot, id: ID): MessagesBuilder

通过 Bot.resolveImage 获取并拼接一个 Image 消息到当前消息中。

@JvmOverloads

fun image(resource: Resource, id: ID = resource.name.ID): MessagesBuilder

通过 ResourceImage 拼接一个 Image 消息到当前消息中。

image4J

@Api4J

@JvmName(name = "image")

fun image4J(bot: Bot, id: ID): MessagesBuilder

通过 Bot.resolveImageBlocking 获取并拼接一个 Image 消息到当前消息中。

text

fun text(text: String): MessagesBuilder

拼接一个字符串文本。

unaryPlus

operator fun String.unaryPlus(): MessagesBuilder

拼接一个字符串文本。

operator fun Iterable<Message.Element<*>>.unaryPlus(): MessagesBuilder

拼接多个任意消息。

operator fun Message.Element<*>.unaryPlus(): MessagesBuilder

拼接一个任意消息。

MessagesBuilder

Author

See also

Constructors

Functions