simbot-component-kook-stdlib/love.forte.simbot.kook

Package-level declarations

Types

Link copied to clipboard
@Api4J
fun interface EventProcessor4J<out EX : Event.Extra, E : Event<EX>>

用于Java的事件处理函数接口。

Link copied to clipboard
interface KookBot : CoroutineScope, LoggerContainer

Kook Bot对应的bot类型。

Link copied to clipboard
class KookBotConfiguration

KookBot 需要使用的配置类。

Link copied to clipboard
Link copied to clipboard
class SimpleTicket(clientId: String, token: String) : KookBot.Ticket

KookBot.Ticket 的基础实现。

Functions

Link copied to clipboard
fun kookBot(ticket: KookBot.Ticket, block: KookBotConfiguration.() -> Unit): KookBot

最基础的用于构建 KookBot 的函数，提供票据信息和配置函数。

fun kookBot(ticket: KookBot.Ticket, configuration: KookBotConfiguration = KookBotConfiguration()): KookBot

最基础的用于构建 KookBot 的函数，提供票据信息 和 配置信息。

fun kookBot(clientId: String, token: String, block: KookBotConfiguration.() -> Unit): KookBot
fun kookBot(clientId: String, token: String, configuration: KookBotConfiguration = KookBotConfiguration()): KookBot
fun kookBot(clientId: ID, token: String, block: KookBotConfiguration.() -> Unit): KookBot
fun kookBot(clientId: ID, token: String, configuration: KookBotConfiguration = KookBotConfiguration()): KookBot

提供 clientId 和 KookBotConfiguration 构建得到一个 KookBot.

Link copied to clipboard
inline fun <EX : Event.Extra, E : Event<EX>> KookBot.processor(eventParser: EventParser<EX, E>, crossinline block: suspend (E) -> Unit)

提供一个 EventParser 进行事件验证并在验证通过时进行事件处理。

inline fun <EX : Event.Extra, E : Event<EX>> KookBot.processor(eventDefinition: KookEventParserDefinition<EX, E>, crossinline block: suspend (E) -> Unit)

提供一个 KookEventParserDefinition 进行事件验证并在验证通过时进行事件处理。

inline fun KookBot.processor(eventType: Event.Type, extraType: String, crossinline block: suspend Signal.Event.(decoder: Json, decoded: () -> Any) -> Unit)
inline fun KookBot.processor(eventType: Event.Type, extraType: Event.Type?, crossinline block: suspend Signal.Event.(decoder: Json, decoded: () -> Any) -> Unit)

提供一个事件类型， 并且可选的提供一个extra的子类型，监听这个事件。

Link copied to clipboard
inline fun <EX : Event.Extra, E : Event<EX>> KookBot.processorExcludeSelf(eventParser: EventParser<EX, E>, crossinline block: suspend (E) -> Unit)

提供一个 EventParser 进行事件验证并在验证通过时进行事件处理。

inline fun <EX : Event.Extra, E : Event<EX>> KookBot.processorExcludeSelf(eventDefinition: KookEventParserDefinition<EX, E>, crossinline block: suspend (E) -> Unit)

提供一个 KookEventParserDefinition 进行事件验证并在验证通过时进行事件处理。

Link copied to clipboard
inline suspend fun KookBot.request(api: KookApiRequest<*>): ApiResult

通过指定Bot，利用其token和client发起请求并得到对应的ApiResult。

Link copied to clipboard
@Api4J
fun KookBot.requestBlocking(api: KookApiRequest<*>): ApiResult

通过指定Bot，利用其token和client发起请求并得到对应的ApiResult。

Link copied to clipboard
inline suspend fun KookApiRequest<*>.requestBy(bot: KookBot): ApiResult

通过指定Bot，利用其token和client发起请求并得到对应的ApiResult。

Link copied to clipboard
inline suspend fun <T> KookBot.requestData(api: KookApiRequest<T>): T

通过指定Bot，利用其token和client发起请求并得到对应的data响应值。

Link copied to clipboard
@Api4J
fun <T> KookBot.requestDataBlocking(api: KookApiRequest<T>): T

通过指定Bot，利用其token和client发起请求并得到对应的data响应值。

Link copied to clipboard
inline suspend fun <T> KookApiRequest<T>.requestDataBy(bot: KookBot): T

通过指定Bot，利用其token和client发起请求并得到对应的data响应值。

Link copied to clipboard