simbot-component-kook-core/love.forte.simbot.component.kook/KookComponentBot

KookComponentBot

interface KookComponentBot : Bot

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

Author

ForteScarlet

Functions

asFuture

open fun asFuture(): CompletableFuture<Unit>

cancel

abstract suspend override fun cancel(reason: Throwable?): Boolean

终止当前bot。

cancelAsync

open fun cancelAsync(): CompletableFuture<Boolean>

open fun cancelAsync(reason: Throwable?): CompletableFuture<out Boolean>

cancelBlocking

open fun cancelBlocking(): Boolean

open fun cancelBlocking(reason: Throwable?): Boolean

contact

abstract suspend override fun contact(id: ID): KookUserChat

通过指定ID 构建一个目标用户的聊天会话对象。

delay

open fun delay(duration: JavaDuration, runnable: Runnable): DelayableCompletableFuture<Void?>

open fun delay(millis: Long, runnable: Runnable): DelayableCompletableFuture<Void?>

open fun delay(time: Long, timeUnit: TimeUnit, runnable: Runnable): DelayableCompletableFuture<Void?>

delayAndCompute

open fun <V> delayAndCompute(duration: JavaDuration, supplier: Supplier<V>): DelayableCompletableFuture<V>

open fun <V> delayAndCompute(millis: Long, supplier: Supplier<V>): DelayableCompletableFuture<V>

open fun <V> delayAndCompute(time: Long, timeUnit: TimeUnit, supplier: Supplier<V>): DelayableCompletableFuture<V>

getContact

open fun getContact(id: ID): Contact?

getContactAsync

open fun getContactAsync(id: ID): CompletableFuture<out Contact?>

getGroup

open fun getGroup(id: ID): Group?

getGroupAsync

open fun getGroupAsync(id: ID): CompletableFuture<out Group?>

getGuild

open fun getGuild(id: ID): Guild?

getGuildAsync

open fun getGuildAsync(id: ID): CompletableFuture<out Guild?>

group

open suspend override fun ~~group~~(id: ID): Group?

guild

abstract suspend override fun guild(id: ID): KookGuild?

根据指定ID寻找频道服务器。

invokeOnCompletion

open override fun invokeOnCompletion(handler: CompletionHandler)

isMe

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

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

join

abstract suspend override fun join()

挂起直到当前bot被关闭。

joinBlocking

open fun joinBlocking()

resolveImage

abstract suspend override fun resolveImage(id: ID): KookAssetImage

由于 Kook 中的资源不存在id，因此会直接将 id 视为 url 进行转化。

resolveImageAsync

open fun resolveImageAsync(id: ID): CompletableFuture<out Image<*>>

resolveImageBlocking

open fun resolveImageBlocking(id: ID): Image<*>

sendIfSupportBlocking

open fun ~~sendIfSupportBlocking~~(message: Message): MessageReceipt?

start

abstract suspend override fun start(): Boolean

启动此bot。

startAsync

open fun startAsync(): CompletableFuture<out Boolean>

startBlocking

open fun startBlocking(): Boolean

toAsync

open fun ~~toAsync~~(): CompletableFuture<Unit>

uploadAsset

abstract suspend fun uploadAsset(resource: Resource, type: Int): KookSimpleAssetMessage

open suspend fun uploadAsset(resource: Resource, type: MessageType): KookSimpleAssetMessage

上传一个资源并得到一个 KookAssetMessage.

uploadAssetImage

abstract suspend fun uploadAssetImage(resource: Resource): KookAssetImage

提供一个资源类型并将其上传后作为 KookAssetImage 使用。

uploadImage

open suspend fun ~~uploadImage~~(resource: Resource): Image<*>

uploadImageBlocking

open fun ~~uploadImageBlocking~~(resource: Resource): Image<*>

waiting

open fun waiting()

Properties

avatar

abstract override val avatar: String

bot

open override val bot: KookComponentBot

bot自身。

Inheritors

KookComponentGuildBot

Extensions

request

inline suspend fun KookComponentBot.request(api: KookApiRequest<*>): ApiResult

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

requestBlocking

@Api4J

fun KookComponentBot.requestBlocking(api: KookApiRequest<*>): ApiResult

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

requestData

inline suspend fun <T> KookComponentBot.requestData(api: KookApiRequest<T>): T

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

requestDataBlocking

@Api4J

fun <T> KookComponentBot.requestDataBlocking(api: KookApiRequest<T>): T

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