simbot-api/love.forte.simbot.plugin/CloseablePlugin

CloseablePlugin

interface CloseablePlugin : Plugin, LifecycleAware(source)

表示一个可以被取消/终止的 Plugin。

取消的过程不可逆，当一个插件被取消后，不可再次回到活跃状态，且不应当再有任何状态改变或可用行为。对于会产生各种副作用的行为，都应当抛出 PluginAlreadyCancelledException 异常。

Author

ForteScarlet

Since

5.0

Properties

abstract override val isActive: Boolean

是否处于活跃状态，近似于 kotlinx.coroutines.Job.isActive。

abstract val isClosed: Boolean

是否已经取消。这是一个原子属性，调用 close 后的瞬间被关闭，但这不代表它已经彻底完成。

abstract override val isCompleted: Boolean

是否已经彻底完成。

Functions

abstract fun close()

结束并关闭此插件。