Package-level declarations

Types

Link copied to clipboard

KOOK 中通过事件接收得到的消息正文类型的抽象类型。

Link copied to clipboard
@ExperimentalSimbotAPI
class KookAggregatedMessageReceipt : AggregatedMessageReceipt, KookMessageReceipt

多条消息发送后的回执,其中会包含多个 KookMessageReceipt

Link copied to clipboard

提供一个 KookApi 作为原始的消息发送请求(例如 SendChannelMessageApi)。

Link copied to clipboard
class KookApiRequestedReceipt(val result: Any?, val isDirect: Boolean) : SingleKookMessageReceipt

消息发送后的回执。

Link copied to clipboard
@SerialName(value = "kook.asset.std")
data class KookAsset(val asset: Asset, val type: Int) : KookAssetMessage

Kook 组件中针对 CreateAssetApi api 的请求响应的消息封装。

Link copied to clipboard
@SerialName(value = "kook.asset.img")
data class KookAssetImage(val asset: Asset) : KookAssetMessage, RemoteUrlAwareImage

使用 Asset 作为一个 Image 消息类型。 Asset 是上传后的产物,因此 KookAssetImage 可以被视为 RemoteImage

Link copied to clipboard

与上传后的媒体资源相关的消息类型。

Link copied to clipboard
@SerialName(value = "kook.AtAllHere")
object KookAtAllHere : KookMessageElement

通知(mention)所有当前的 在线用户

Link copied to clipboard
@SerialName(value = "kook.attachment.std")
class KookAttachment : KookAttachmentMessage

普通的 KookAttachmentMessage 实现。

Link copied to clipboard
@SerialName(value = "kook.attachment.file")
@ExperimentalSimbotAPI
class KookAttachmentFile : KookAttachmentMessage

文件附件类型的 KookAttachmentMessage 实现。

Link copied to clipboard
@SerialName(value = "kook.attachment.image")
@ExperimentalSimbotAPI
class KookAttachmentImage : KookAttachmentMessage, RemoteUrlAwareImage

一个可以代表 ImageKookAttachmentMessage

Link copied to clipboard
@SerialName(value = "kook.attachment")
sealed class KookAttachmentMessage : KookMessageElement

Attachments 作为 simbot 消息元素。

Link copied to clipboard
@SerialName(value = "kook.attachment.video")
@ExperimentalSimbotAPI
class KookAttachmentVideo : KookAttachmentMessage

代表为视频类型的 KookAttachmentMessage 类型实现。

Link copied to clipboard
@ExperimentalSimbotAPI
@SerialName(value = "kook.card")
data class KookCardMessage(val cards: CardMessage) : KookMessageElement

Card 作为消息使用。

Link copied to clipboard
Link copied to clipboard
@SerialName(value = "kook.kmd")
@ExperimentalSimbotAPI
data class KookKMarkdownMessage(val kMarkdown: KMarkdown) : KookMessageElement

KMarkdown 作为消息使用。

Link copied to clipboard
interface KookMessageContent : MessageContent, DeleteSupport

KOOK 中的消息正文类型的抽象接口类型。

Link copied to clipboard

消息创建后的回执实例。

Link copied to clipboard
interface KookMessageElement : Message.Element

Kook 组件中对 Message.Element 消息实现的根类型。

Link copied to clipboard
interface KookMessageReceipt : MessageReceipt

Kook 进行消息回复、发送后得到的回执。

Link copied to clipboard

提供 KOOK 组件中一些会用到的信息。

Link copied to clipboard
@SerialName(value = "kook.quote")
data class KookQuote : MessageReference

一个通过 KookMessageContent.reference 查询得到的消息引用信息。

Link copied to clipboard

KOOK 消息事件所收到的消息正文类型。

Link copied to clipboard
annotation class KookSendOnlyMessage

此注解标记一个 KookMessageElement 的实现类型,用于标记其为一个仅用于发送的消息。

Link copied to clipboard
@SerialName(value = "kook.temp.target")
sealed class KookTempTarget : KookMessageElement

频道聊天消息中的临时消息ID

Link copied to clipboard

KOOK 中消息更新等非消息事件推送得到的消息正文。

Link copied to clipboard
abstract class SingleKookMessageReceipt : SingleMessageReceipt, KookMessageReceipt

用于表示 SingleMessageReceiptKookMessageReceipt 实现。

Functions

Link copied to clipboard

获取一个根据 Attachments.url 重新上传此图片的 CreateAssetApi。 会通过 KookBot.sourceBot.apiClient 请求 url 并将结果“转录”至 CreateAssetApi

Link copied to clipboard
@ExperimentalSimbotAPI
inline fun kookCard(action: CardMessageBuilder.() -> Unit): KookCardMessage

通过 buildCardMessage 构建 CardMessage 并包装为 KookCardMessage

Link copied to clipboard
@ExperimentalSimbotAPI
inline fun kookKMarkdown(block: KMarkdownBuilder.() -> Unit): KookKMarkdownMessage

通过 buildKMarkdown 构建 KMarkdown 并包装为 KookKMarkdownMessage

Inherited functions

Link copied to clipboard
suspend fun Message.sendToChannel(bot: KookBot, targetId: String, quote: String? = null, nonce: String? = null, tempTargetId: String? = null, defaultTempTargetId: String? = null): KookMessageReceipt?

将消息发送给目标。此消息如果是个消息链,则有可能会被拆分为多条消息发送, 届时将会返回 KookAggregatedMessageReceipt.

Link copied to clipboard
suspend fun Message.sendToDirectByChatCode(bot: KookBot, chatCode: String, quote: String? = null, nonce: String? = null, tempTargetId: String? = null): KookMessageReceipt?

将消息发送给目标。此消息如果是个消息链,则有可能会被拆分为多条消息发送, 届时将会返回 KookAggregatedMessageReceipt.

Link copied to clipboard
suspend fun Message.sendToDirectByTargetId(bot: KookBot, targetId: String, quote: String? = null, nonce: String? = null, tempTargetId: String? = null): KookMessageReceipt?

将消息发送给目标。此消息如果是个消息链,则有可能会被拆分为多条消息发送, 届时将会返回 KookAggregatedMessageReceipt.

Link copied to clipboard

使用消息事件并将其中的消息内容转化为 KookChannelMessageDetailsContent.

Link copied to clipboard
fun Event<TextExtra>.toMessages(): Messages

将消息事件相关内容转化为 Messages.