Package-level declarations

Types

Link copied to clipboard
abstract class KookBotManager : BotManager<KookComponentBot> , KookBotRegistrar

KookComponentBot 的管理器实现。

Link copied to clipboard

实现 EventProviderAutoRegistrarFactory 并通过 Java SPI 支持 KookBotManager 的自动安装。

Link copied to clipboard

KookBotManager 使用的配置类。

Link copied to clipboard

在 Kook 组件中对于 Bot 的注册函数的常见形式。

Link copied to clipboard
data class KookBotVerifyInfoConfiguration(val clientId: String, val token: String, val config: KookBotVerifyInfoConfiguration.Config = Config.DEFAULT)

.bot 配置文件读取的配置信息实体, 用于接收从 BotVerifyInfo 中的序列化信息。

Link copied to clipboard

Kook 组件的子频道类型定义。

Link copied to clipboard

Kook 组件中对于 频道类型 的定义。

Link copied to clipboard
class KookComponent @InternalSimbotApi constructor : Component

Kook 组件的 Component 实现。

Link copied to clipboard

KookComponent 的注册器工厂,用于支持组件的自动加载。

Link copied to clipboard
interface KookComponentBot : Bot

Kook 组件在simbot下的组件 Bot 实现。

Link copied to clipboard

组件bot所使用的额外拓展配置类,应用于 KookBotManager 中。

Link copied to clipboard

KookComponent 注册时所使用的配置类。

Link copied to clipboard
interface KookComponentDefinition<out S>

一个 Kook 组件的对象定义,实现此接口并提供一个可以获取 对象的api。

Link copied to clipboard
abstract class KookComponentGuildBot : KookComponentBot, GuildBot

Kook 组件中针对于 GuildBot 的实现类型。

Link copied to clipboard
interface KookComponentUsageBuilder<A : Application>

同时配置 Kook 组件 Kook botManager 的构建器。

Link copied to clipboard
interface KookContact : Contact

Kook 组件下的联系人信息。

Link copied to clipboard

Kook 组件中的频道服务器信息。

Link copied to clipboard
interface KookGuildMember : GuildMember, KookComponentDefinition<User>

Kook 组件下,频道服务器 的成员信息.

Link copied to clipboard

使用 SystemUser 作为基础用户对象来作为一个频道内的用户。

Link copied to clipboard
interface KookUserChat : Stranger, Contact, KookComponentDefinition<UserChatView> , DeleteSupport

Functions

Link copied to clipboard
inline fun Iterable<EventProvider>.filterIsKookBotManagers(): List<KookBotManager>

从一个 EventProvider 列表中过滤寻找所有的 KookBotManager

从一个 EventProvider 序列中过滤寻找所有的 KookBotManager

Link copied to clipboard
@FragileSimbotApi
inline fun firstKookBotManager(): KookBotManager

OriginBotManager 获取第一个 KookBotManager

inline fun Iterable<EventProvider>.firstKookBotManager(): KookBotManager

从一个 EventProvider 列表中过滤寻找第一个的 KookBotManager

inline fun Sequence<EventProvider>.firstKookBotManager(): KookBotManager

从一个 EventProvider 序列中寻找第一个的 KookBotManager

Link copied to clipboard
@FragileSimbotApi
inline fun firstKookBotManagerOrNull(): KookBotManager?

OriginBotManager 获取第一个 KookBotManager

inline fun Iterable<EventProvider>.firstKookBotManagerOrNull(): KookBotManager?

从一个 EventProvider 列表中过滤寻找第一个的 KookBotManager。 当找不到时得到null。

inline fun Sequence<EventProvider>.firstKookBotManagerOrNull(): KookBotManager?

从一个 EventProvider 序列中寻找第一个的 KookBotManager。 当找不到时得到null。

Link copied to clipboard
inline suspend fun BotRegistrar.kook(crossinline block: suspend KookBotManager.() -> Unit)

ApplicationBuilder.bots 作用域中寻找并使用 KookBotManager.

Link copied to clipboard
fun kookBotManager(eventProcessor: EventProcessor, block: KookBotManagerConfiguration.() -> Unit = {}): KookBotManager

配置并构建一个 KookBotManager 实例。

Link copied to clipboard
@FragileSimbotApi
inline fun kookBotManagers(): List<KookBotManager>

通过 OriginBotManager 获取所有的 KookBotManager

Link copied to clipboard
inline fun ApplicationBuilder<*>.kookBots(crossinline block: suspend KookBotManager.(BotRegistrar) -> Unit)

ApplicationBuilder.bots 作用域中寻找并使用 KookBotManager.

Link copied to clipboard
inline fun ApplicationBuilder<*>.kookBotsIfSupport(crossinline block: suspend KookBotManager.(BotRegistrar) -> Unit)

ApplicationBuilder.bots 作用域中寻找并使用 KookBotManager.

Link copied to clipboard
inline suspend fun BotRegistrar.kookIfSupport(crossinline block: suspend KookBotManager.() -> Unit)

ApplicationBuilder.bots 作用域中寻找并使用 KookBotManager.

Link copied to clipboard
fun <A : Application> ApplicationBuilder<A>.useKook(usageBuilder: KookComponentUsageBuilder<A>.() -> Unit = {})

通过 KookComponentUsageBuilder 来同时配置使用 Kook 组件 Kook botManager

Link copied to clipboard
fun <A : Application> ApplicationBuilder<A>.useKookBotManager(configurator: KookBotManagerConfiguration.(perceivable: CompletionPerceivable<A>) -> Unit = {})

注册使用 Kook botManager

Link copied to clipboard
fun <A : Application> ApplicationBuilder<A>.useKookComponent(configurator: KookComponentConfiguration.(perceivable: CompletionPerceivable<A>) -> Unit = {})

注册 Kook 组件 信息。

Properties

Link copied to clipboard
@ExperimentalSimbotApi
val KookChannelCategory.channels: Sequence<KookChannel>

根据当前分组信息,寻找频道服务器下所有相同分类的子频道序列。

Link copied to clipboard
@FragileSimbotApi
val OriginBotManager.kookBotManagers: List<KookBotManager>

得到 OriginBotManager 中的所有 Kook 组件。

Application.providers 中寻找所有的 KookBotManager.