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

AutoConfigurableBotPlugin

interface AutoConfigurableBotPlugin : BotPlugin(source)

BotPlugin 的标准扩展类型，允许根据其提供的 API 检测和使用 SerializableBotConfiguration 进行配置。

SerializableBotConfiguration 通常由 quantcat 或其他集成环境在多组件模式下自动加载并解析，因此无法明确具体类型，需要先通过 configurable 校验可用性，而用使用 register 注册。

Inheritors

Functions

abstract fun configurable(configuration: SerializableBotConfiguration): Boolean

检测提供的 configuration 是否能够应用于 register 中。通常是一种类型检测。如果 configurable 结果为 true，则使用此 configuration 执行 register 时不应出现 UnsupportedBotConfigurationException 异常。

abstract fun register(configuration: SerializableBotConfiguration): Bot

使用一个 configuration 注册并得到 Bot。

Inherited functions

fun AutoConfigurableBotPlugin.tryRegister(configuration: SerializableBotConfiguration): Bot?

尝试使用 register 注册并得到一个 Bot。如果 configurable 校验通过则通过 register 注册得到 Bot，否则得到 null。

inline fun <T> AutoConfigurableBotPlugin.tryRegister(configuration: SerializableBotConfiguration, block: (Bot) -> T): T?

尝试使用 register 注册并得到一个 Bot。如果 configurable 校验通过则通过 register 注册得到 Bot，并用于执行 block。