simbot-component-kook-core/love.forte.simbot.component.kook.bot/KookBot

KookBot

interface KookBot : Bot, CoroutineScope(source)

simbot组件针对 Kook bot 的 Bot 实现。

注意：KookBot 对第三方实现不保证兼容与稳定

Author

ForteScarlet

Properties

avatar

open val avatar: String

头像信息

component

abstract override val component: KookComponent

得到对应的组件实例。

contactRelation

abstract override val contactRelation: KookContactRelation

与 KookUserChat 相关的行为关系操作。

coroutineContext

abstract override val coroutineContext: CoroutineContext

源自 sourceBot 的 CoroutineContext

groupRelation

open override val ~~groupRelation~~: GroupRelation?

Deprecated: KOOK 中没有群的概念。

guildRelation

abstract override val guildRelation: KookGuildRelation

与 KookGuild 相关的行为关系操作。

open override val id: ID

botID。即 Ticket.clientId.

isActive

abstract override val isActive: Boolean

bot 是否处于活跃状态

isStarted

abstract override val isStarted: Boolean

bot 是否已经被启动过

logger

abstract val logger: Logger

name

open override val name: String

用户名称

sourceBot

abstract val sourceBot: Bot

得到标准库中的 Kook Bot 源对象。

Inherited properties

isClosed

abstract val isClosed: Boolean

isCompleted

abstract override val isCompleted: Boolean

Functions

isMe

abstract infix override fun isMe(id: ID): Boolean

判断此 ID 是否代表当前 bot。可以代表 bot 的 id 可能是 clientId, 也有可能是此 bot 在系统中作为 User 时候的 user id。

messageFromId

open suspend override fun messageFromId(id: ID): KookMessageContent

根据引用ID查询对应的 频道消息 的 KookMessageContent。

messageFromReference

open suspend override fun messageFromReference(reference: MessageReference): KookMessageContent

根据引用查询对应的 频道消息 的 KookMessageContent。

uploadAsset

open suspend fun uploadAsset(api: CreateAssetApi, type: MessageType): KookAsset

提供一个 CreateAssetApi, 通过此BOT上传将得到的 Asset 结果包装为 KookAsset .

uploadAssetImage

open suspend fun uploadAssetImage(api: CreateAssetApi): KookAssetImage

提供一个 CreateAssetApi, 通过此BOT上传将得到的 Asset 结果包装为 KookAssetImage .

Inherited functions

cancel

open fun ~~cancel~~()

open fun ~~cancel~~(reason: Throwable?)

abstract fun close()

join

abstract suspend fun join()

onCompletion

abstract fun onCompletion(handle: OnCompletion)

request

suspend fun KookBot.request(api: KookApi<*>): HttpResponse

使用 KookBot 对 api 发起请求。

requestAsync

@Api4J

fun KookBot.requestAsync(api: KookApi<*>): CompletableFuture<out HttpResponse>

使用 KookBot 对 api 发起请求。

requestBlocking

@Api4J

fun KookBot.requestBlocking(api: KookApi<*>): HttpResponse

使用 KookBot 对 api 发起请求。

requestData

suspend fun <T : Any> KookBot.requestData(api: KookApi<T>): T

使用 KookBot 对 api 发起请求。

requestDataAsync

@Api4J

fun <T : Any> KookBot.requestDataAsync(api: KookApi<T>): CompletableFuture<out T>

使用 KookBot 对 api 发起请求。

requestDataBlocking

@Api4J

fun <T : Any> KookBot.requestDataBlocking(api: KookApi<T>): T

使用 KookBot 对 api 发起请求。

requestDataReserve

@Api4J

fun <T : Any> KookBot.requestDataReserve(api: KookApi<T>): SuspendReserve<T>

使用 KookBot 对 api 发起请求。

requestReserve

@Api4J

fun KookBot.requestReserve(api: KookApi<*>): SuspendReserve<HttpResponse>

使用 KookBot 对 api 发起请求。

requestResult

suspend fun KookBot.requestResult(api: KookApi<*>): ApiResult

使用 KookBot 对 api 发起请求。

requestResultAsync

@Api4J

fun KookBot.requestResultAsync(api: KookApi<*>): CompletableFuture<out ApiResult>

使用 KookBot 对 api 发起请求。

requestResultBlocking

@Api4J

fun KookBot.requestResultBlocking(api: KookApi<*>): ApiResult

使用 KookBot 对 api 发起请求。

requestResultReserve

@Api4J

fun KookBot.requestResultReserve(api: KookApi<*>): SuspendReserve<ApiResult>

使用 KookBot 对 api 发起请求。

requestText

suspend fun KookBot.requestText(api: KookApi<*>): String

使用 KookBot 对 api 发起请求。

requestTextAsync

@Api4J

fun KookBot.requestTextAsync(api: KookApi<*>): CompletableFuture<out String>

使用 KookBot 对 api 发起请求。

requestTextBlocking

@Api4J

fun KookBot.requestTextBlocking(api: KookApi<*>): String

使用 KookBot 对 api 发起请求。

requestTextReserve

@Api4J

fun KookBot.requestTextReserve(api: KookApi<*>): SuspendReserve<String>

使用 KookBot 对 api 发起请求。

start

abstract suspend fun start()