Bot

@SubclassOptInRequired(markerClass = [InheritanceBotApi::class])

interface Bot : IDContainer, LifecycleAware, CompletionAware, CoroutineScope, BotRelations(source)

一个 Bot。

行为关系

Bot 实现 BotRelations 并提供了部分基础的行为关系对象，它们可以提供针对 Guild、ChatGroup、Contact 等常见行为对象的操作。 Bot 的实现者也许会根据不同的平台扩展这些行为类型或提供更多的行为类型。

扩展类型

对于组件实现者来说，Bot 有一些具有特殊含义的额外拓展类型。可参考:

Author

ForteScarlet

Inheritors

ConfigurableBot

JobBasedBot

Properties

component

abstract val component: Component

此 bot 所属 Component。

abstract override val id: ID

当前bot的标识。

isStarted

abstract val isStarted: Boolean

是否 启动过。

name

abstract val name: String

当前 Bot 作为用户的名称。

Inherited properties

contactRelation

abstract val contactRelation: ContactRelation?

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

coroutineContext

abstract val coroutineContext: CoroutineContext

groupRelation

abstract val groupRelation: GroupRelation?

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

guildRelation

abstract val guildRelation: GuildRelation?

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

isActive

abstract val isActive: Boolean

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

isCompleted

abstract val isCompleted: Boolean

当前是否已经彻底完成。

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

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

start

abstract suspend fun start()

启动当前 Bot。

Inherited functions

onCompletion

abstract fun onCompletion(handle: OnCompletion)

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

startAndJoin

suspend fun Bot.startAndJoin()

启动当前 Bot 后挂起。

startIn

fun Bot.startIn(scope: CoroutineScope): Job

通过 scope 在异步中启动 Bot。

Bot