simbot-component-qq-guild-stdlib/love.forte.simbot.qguild.stdlib

Package-level declarations

Types

Bot

interface Bot : CoroutineScope

一个 QQ频道Bot。

BotAlreadyCancelledException

open class BotAlreadyCancelledException : IllegalStateException

当尝试使用已经被关闭的 Bot 进行某些操作时（例如尝试启动它）

BotConfiguration

interface BotConfiguration

Bot 所需的配置信息。

BotFactory

object BotFactory

用于构建 Bot 的工厂类型，提供一些工厂函数。

ConfigurableBotConfiguration

class ConfigurableBotConfiguration : BotConfiguration

对于一个Bot的配置信息。如果在配置bot之后对内容进行后续修改，可能会影响到当前bot的使用。

DisposableHandle

interface DisposableHandle

已分配对象的句柄。可通过 dispose 释放对象。

Ed25519SignatureVerification

data class Ed25519SignatureVerification(val signatureEd25519: String, val signatureTimestamp: String)

进行 Ed25519 签名校验所需的参数。

EmitEventOptions

class EmitEventOptions

在使用 Bot.emitEvent 时可选的一些额外属性或选项信息。

EmitResult

sealed class EmitResult

使用 Bot.emitEvent 推送事件后的结果，会根据配置的不同和推送事件的 opcode 的不同得到不同的结果.

EventProcessor

fun interface EventProcessor

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

ExceptionProcessor

interface ExceptionProcessor

一个异常处理器.

JAsyncEventProcessor

fun interface JAsyncEventProcessor : EventProcessor

以异步的形式实现 EventProcessor，是提供给 Java 的友好类型。可直接使用 EventProcessors.async((event, raw) -> { ... }) 构建。

JBlockEventProcessor

fun interface JBlockEventProcessor : EventProcessor

以阻塞的形式实现 EventProcessor，是提供给 Java 的友好类型。可直接使用 EventProcessors.block((event, raw) -> { ... }) 构建。

SubscribeSequence

enum SubscribeSequence : Enum<SubscribeSequence>

订阅事件用的事件处理器的顺序模式

TypedJAsyncEventProcessor

fun interface TypedJAsyncEventProcessor<T : Signal.Dispatch>

以异步的形式实现 EventProcessor，是提供给 Java 的友好类型。可直接使用 EventProcessors.async((event, raw) -> { ... }) 构建。

TypedJBlockEventProcessor

fun interface TypedJBlockEventProcessor<T : Signal.Dispatch>

以阻塞的形式实现 EventProcessor，是提供给 Java 的友好类型。可直接使用 EventProcessors.block((event, raw) -> { ... }) 构建。

Functions

async

fun async(function: JAsyncEventProcessor): JAsyncEventProcessor

fun <T : Signal.Dispatch> async(type: Class<T>, function: TypedJAsyncEventProcessor<T>): JAsyncEventProcessor

构建一个 JAsyncEventProcessor.

block

fun block(function: JBlockEventProcessor): JBlockEventProcessor

fun <T : Signal.Dispatch> block(type: Class<T>, function: TypedJBlockEventProcessor<T>): JBlockEventProcessor

构建一个 JBlockEventProcessor.

Inherited functions

emitEvent

inline suspend fun Bot.emitEvent(payload: String, block: EmitEventOptions.() -> Unit): EmitResult

使用 Bot.emitEvent 推送一个外部事件，并且在 block 中配置 EmitEventOptions。

process

inline fun <E : Signal.Dispatch> Bot.~~process~~(crossinline block: suspend E.(raw: String) -> Unit): DisposableHandle

用当前 Bot 订阅一个指定类型 E 的事件。

request

suspend fun Bot.request(api: QQGuildApi<*>): HttpResponse

直接通过bot进行请求。

requestAsync

@Api4J

@JvmOverloads

fun Bot.requestAsync(api: QQGuildApi<*>, scope: CoroutineScope? = null): CompletableFuture<HttpResponse>

直接通过bot进行请求。

requestBlocking

@Api4J

fun Bot.requestBlocking(api: QQGuildApi<*>): HttpResponse

直接通过bot进行请求。

requestBy

suspend fun QQGuildApi<*>.requestBy(bot: Bot): HttpResponse

直接通过bot进行请求。

requestByAsync

@Api4Js

fun Bot.requestByAsync(api: QQGuildApi<*>): Promise<HttpResponse>

直接通过bot进行请求。

requestData

suspend fun <R : Any> Bot.requestData(api: QQGuildApi<R>): R

直接通过bot进行请求。

requestDataAsync

@Api4J

@JvmOverloads

fun <R : Any> Bot.requestDataAsync(api: QQGuildApi<R>, scope: CoroutineScope? = null): CompletableFuture<R>

直接通过bot进行请求。

requestDataBlocking

@Api4J

fun <R : Any> Bot.requestDataBlocking(api: QQGuildApi<R>): R

直接通过bot进行请求。

requestDataBy

inline suspend fun <R : Any> QQGuildApi<R>.requestDataBy(bot: Bot): R

直接通过bot进行请求。

requestDataByAsync

@Api4Js

fun <R : Any> Bot.requestDataByAsync(api: QQGuildApi<R>): Promise<R>

直接通过bot进行请求。

requestDataReserve

@Api4J

@JvmOverloads

fun <R : Any> Bot.requestDataReserve(api: QQGuildApi<R>, scope: CoroutineScope? = null): SuspendReserve<R>

直接通过bot进行请求。

requestReserve

@Api4J

@JvmOverloads

fun Bot.requestReserve(api: QQGuildApi<*>, scope: CoroutineScope? = null): SuspendReserve<HttpResponse>

直接通过bot进行请求。

requestText

suspend fun Bot.requestText(api: QQGuildApi<*>): String

直接通过bot进行请求。

requestTextAsync

@Api4J

@JvmOverloads

fun Bot.requestTextAsync(api: QQGuildApi<*>, scope: CoroutineScope? = null): CompletableFuture<String>

直接通过bot进行请求。

requestTextBlocking

@Api4J

fun Bot.requestTextBlocking(api: QQGuildApi<*>): String

直接通过bot进行请求。

requestTextBy

inline suspend fun QQGuildApi<*>.requestTextBy(bot: Bot, useResp: (HttpResponse) -> Unit = {}): String

直接通过bot进行请求。

requestTextByAsync

@Api4Js

fun Bot.requestTextByAsync(api: QQGuildApi<*>): Promise<String>

直接通过bot进行请求。

requestTextReserve

@Api4J

@JvmOverloads

fun Bot.requestTextReserve(api: QQGuildApi<*>, scope: CoroutineScope? = null): SuspendReserve<String>

直接通过bot进行请求。

inline fun <E : Signal.Dispatch> Bot.subscribe(sequence: SubscribeSequence = SubscribeSequence.NORMAL, crossinline block: suspend E.(raw: String) -> Unit): DisposableHandle

用当前 Bot 订阅一个指定类型 E 的事件。