simbot-api/love.forte.simbot.application

Package-level declarations

Types

Application

interface Application : CoroutineScope

Simple Robot 的应用.

ApplicationBuilder

interface ApplicationBuilder<A : Application> : CompletionPerceivable<A>

Application 的构建器.

ApplicationBuilderDsl

@DslMarker

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CLASS])

annotation class ApplicationBuilderDsl

标记为用于 ApplicationBuilder 的 dsl api.

ApplicationConfiguration

open class ApplicationConfiguration

整个应用程序进行构建所需的基本配置信息。

ApplicationDslBuilder

interface ApplicationDslBuilder<Config : ApplicationConfiguration, Builder : ApplicationBuilder<A>, A : Application>

在 buildSimbotApplication 中提供允许通过DSL风格或链式调用风格来构建一个目标 Application.

ApplicationDslBuilderDsl

@DslMarker

annotation class ApplicationDslBuilderDsl

ApplicationFactory

interface ApplicationFactory<Config : ApplicationConfiguration, Builder : ApplicationBuilder<A>, A : Application>

用于构建 Application.Environment 的工厂。

ApplicationLauncher

interface ApplicationLauncher<out A : Application>

应用程序启动器。

BotManagers

interface BotManagers : List<BotManager<*>>

Application 中注册完成的所有 BotManager 集。

BotRegistrar

interface BotRegistrar

应用于 ApplicationBuilder.bots 中的bot注册函数, 提供一个通过 BotVerifyInfo 注册的通用bot注册函数。

EventProvider

interface EventProvider : Survivable

事件提供者。

EventProviderAutoRegistrarFactory

interface EventProviderAutoRegistrarFactory<P : EventProvider, Config : Any>

实现自动注册的配置类。通过 Java SPI 机制加载。

EventProviderFactory

interface EventProviderFactory<P : EventProvider, Config : Any>

EventProvider 工厂，用于在 Application 的过程中构建 EventProvider.

OnCompletion

@Api4J

fun interface OnCompletion<in A : Application>

使用于 ApplicationLauncher.launchAsync 中的回调函数。

Functions

applicationLauncher

fun <A : Application> CoroutineScope.applicationLauncher(create: suspend () -> A): ApplicationLauncher<A>

通过一个协程作用域并提供构建函数来得到一个 ApplicationLauncher 实例。

fun <A : Application> applicationLauncher(context: CoroutineContext = EmptyCoroutineContext, create: suspend () -> A): ApplicationLauncher<A>

提供一个协程上下文并提供构建函数来得到一个 ApplicationLauncher 实例。

bots

inline fun Application.bots(block: BotManagers.() -> Unit)

使用 Application.botManagers.

buildSimbotApplication

suspend fun <Config : ApplicationConfiguration, Builder : ApplicationBuilder<A>, A : Application> buildSimbotApplication(factory: ApplicationFactory<Config, Builder, A>, block: ApplicationDslBuilder<Config, Builder, A>.() -> Unit = {}): A

通过 ApplicationDslBuilder 来使用DSL风格或链式调用风格构建目标 Application.

buildSimbotApplicationLauncher

fun <Config : ApplicationConfiguration, Builder : ApplicationBuilder<A>, A : Application> buildSimbotApplicationLauncher(factory: ApplicationFactory<Config, Builder, A>, block: ApplicationDslBuilder<Config, Builder, A>.() -> Unit = {}): ApplicationLauncher<A>

通过 ApplicationDslBuilder 来使用DSL风格或链式调用风格构建目标 ApplicationLauncher<A>.

createApplicationDslBuilder

@JvmName(name = "buildSimbotApplication")

fun <Config : ApplicationConfiguration, Builder : ApplicationBuilder<A>, A : Application> createApplicationDslBuilder(factory: ApplicationFactory<Config, Builder, A>): ApplicationDslBuilder<Config, Builder, A>

构建一个 ApplicationDslBuilder 来使用DSL风格或链式调用风格构建目标 Application.

createSimbotApplication

suspend fun <Config : ApplicationConfiguration, Builder : ApplicationBuilder<A>, A : Application> createSimbotApplication(factory: ApplicationFactory<Config, Builder, A>, configurator: Config.() -> Unit = {}, builder: suspend Builder.(Config) -> Unit = {}): A

构建并启用一个 Application.

createSimbotApplication4J

@JvmOverloads

@JvmName(name = "createSimbotApplication")

fun <Config : ApplicationConfiguration, Builder : ApplicationBuilder<A>, A : Application> createSimbotApplication4J(factory: ApplicationFactory<Config, Builder, A>, configurator: Consumer<Config>? = null, builder: BiConsumer<Builder, Config>? = null): A

构建并启用一个 Application.

installAllEventProviders

fun <A : Application> ApplicationBuilder<A>.installAllEventProviders(classLoader: ClassLoader = EventProviderAutoRegistrarFactory::class.java.classLoader)

尝试加载所有的 ComponentAutoRegistrarFactory 并注册到 ApplicationBuilder 中。

simbotApplication

fun <Config : ApplicationConfiguration, Builder : ApplicationBuilder<A>, A : Application> simbotApplication(factory: ApplicationFactory<Config, Builder, A>, configurator: Config.() -> Unit = {}, builder: suspend Builder.(Config) -> Unit = {}): ApplicationLauncher<A>

构建一个 ApplicationLauncher.

simbotApplication4J

@JvmOverloads

@JvmName(name = "simbotApplication")

fun <Config : ApplicationConfiguration, Builder : ApplicationBuilder<A>, A : Application> simbotApplication4J(factory: ApplicationFactory<Config, Builder, A>, configurator: Consumer<Config>? = null, builder: BiConsumer<Builder, Config>? = null): ApplicationLauncher<A>

构建一个 ApplicationLauncher.