Bot

一个 Bot

行为关系

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

Author

ForteScarlet

Inheritors

Properties

Link copied to clipboard
abstract val component: Component

此 bot 所属 Component

Link copied to clipboard
abstract override val id: ID

当前bot的标识。

Link copied to clipboard
abstract val isStarted: Boolean

是否 启动过

Link copied to clipboard
abstract val name: String

当前 Bot 作为用户的名称。

Inherited properties

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
abstract val isActive: Boolean

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

Link copied to clipboard
abstract val isCompleted: Boolean

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

Functions

Link copied to clipboard
open fun cancel()
abstract fun cancel(reason: Throwable?)

关闭当前 Bot

Link copied to clipboard
abstract infix fun isMe(id: ID): Boolean

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

Link copied to clipboard
abstract suspend fun join()

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

Link copied to clipboard
open suspend fun messageFromId(id: ID): MessageContent

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun start()

启动当前 Bot

Inherited functions

Link copied to clipboard
abstract fun onCompletion(handle: OnCompletion)

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

Link copied to clipboard
suspend fun Bot.startAndJoin()

启动当前 Bot 后挂起。

Link copied to clipboard

通过 scope 在异步中启动 Bot