simbot-api/love.forte.simbot.bot/ConfigurableBot

ConfigurableBot

interface ConfigurableBot : Bot(source)

一个拥有配置信息的 Bot。配置信息的具体类型由实现者决定。

配置信息类可能是一个可变类型，当使用它构建 Bot 后，它理应不再被修改。如果实现了 InitializableBot，则直到 init 调用前，配置信息 configuration 中的信息可以被修改。

配置类的内容也许在上述要求“不可修改”的情况下进行修改时不会产生异常（例如在 init后继续修改），但是它的修改可能不会生效，或可能引发任何不可预知的错误或埋下隐患。

特殊含义

ConfigurableBot 具有特殊含义，可能会在部分场景被判断并有特殊作用。

Since

4.13.0

Author

ForteScarlet

Inheritors

InitializableBot

Properties

configuration

abstract val configuration: Any

当前 Bot 持有的配置信息。

Inherited properties

component

abstract val component: Component

此 bot 所属 Component。

contactRelation

abstract val contactRelation: ContactRelation?

此 Bot 与联系人的关系。可用于寻找指定的联系人或查询联系人/会话的集合。

coroutineContext

abstract val coroutineContext: CoroutineContext

groupRelation

abstract val groupRelation: GroupRelation?

此 Bot 与聊天群的关系。可用于寻找指定的聊天群或查询聊天群的集合。

guildRelation

abstract val guildRelation: GuildRelation?

此 Bot 与频道服务器的关系。可用于寻找指定的频道服务器或查询频道服务器的集合。

abstract override val id: ID

当前bot的标识。

isActive

abstract val isActive: Boolean

当前是否处于活跃、运行或尚未结束的状态。

isCompleted

abstract val isCompleted: Boolean

当前是否已经完成、已经结束。

isStarted

abstract val isStarted: Boolean

是否 启动过。

name

abstract val name: String

当前 Bot 作为用户的名称。

Inherited functions

cancel

open fun cancel()

abstract fun cancel(reason: Throwable?)

关闭当前 Bot。

isMe

abstract infix fun isMe(id: ID): Boolean

当可能有多个 id 用来与当前 Bot 进行对应时（例如 Bot 作为用户时的 id 以及注册 bot 时使用的 token）通过 isMe 来判断指定 id 是否可以用来表示当前 Bot。

join

abstract suspend fun join()

挂起 Bot 直到它完成其生命周期。

messageFromId

open suspend fun messageFromId(id: ID): MessageContent

根据一个消息ID 获取它对应地源消息。

messageFromReference

open suspend fun messageFromReference(reference: MessageReference): MessageContent

根据一个消息引用查询或获取它对应地源消息。

onCompletion

abstract fun onCompletion(handle: OnCompletion)

当目标完成时执行注册的回调函数。

start

abstract suspend fun start()

启动当前 Bot。

startAndJoin

suspend fun Bot.startAndJoin()

启动当前 Bot 后挂起。

startIn

fun Bot.startIn(scope: CoroutineScope): Job

通过 scope 在异步中启动 Bot。