simbot-component-kook-api/love.forte.simbot.kook.api.message

Package-level declarations

Types

interface Author : User

ChannelMessageDetails 中的作者信息, 是 User 的实现之一。

ChannelMessageDetails

interface ChannelMessageDetails : MessageDetails

频道的消息详情

DirectMessageCreateRequest

class DirectMessageCreateRequest : KookPostRequest<MessageCreated>

发送私信聊天消息

DirectMessageDeleteRequest

class DirectMessageDeleteRequest(msgId: ID) : KookPostRequest<Unit>

删除私信聊天消息

DirectMessageDetails

interface DirectMessageDetails : MessageDetails

私聊消息的内容详情

DirectMessageListRequest

class DirectMessageListRequest : KookGetRequest<KookApiResult.ListData<DirectMessageDetails>>

获取私信聊天消息列表

DirectMessageUpdateRequest

class DirectMessageUpdateRequest(msgId: ID, content: String, quote: ID?) : KookPostRequest<Unit>

更新私信聊天消息

data class Emoji @ApiResultType constructor(val id: ID, val name: String)

一个 emoji.

data class MentionInfo @ApiResultType constructor(val mentionPart: List<MentionPart>, val mentionRolePart: List<Role>)

提及（at）信息。

class Message(val id: String, val type: Int, val author: Map<String, String>)

消息体内容。

MessageAddReactionRequest

class MessageAddReactionRequest(msgId: ID, emoji: ID) : KookPostRequest<Unit>

给某个消息添加回应

data class MessageCreated @ApiResultType constructor(val msgId: CharSequenceID, val msgTimestamp: Timestamp, val nonce: String? = null)

发送频道消息和发送私聊消息的响应值。

MessageCreateRequest

class MessageCreateRequest(type: Int = MessageType.TEXT.type, targetId: ID, content: String, quote: ID? = null, nonce: String? = null, tempTargetId: ID? = null) : KookPostRequest<MessageCreated>

发送频道聊天消息

MessageDeleteReactionRequest

class MessageDeleteReactionRequest(msgId: ID, emoji: ID, userId: ID) : KookPostRequest<Unit>

删除消息的某个回应

MessageDeleteRequest

class MessageDeleteRequest(msgId: ID) : KookPostRequest<Unit>

删除频道聊天消息

interface MessageDetails

对消息的统一描述。

MessageListFlag

enum MessageListFlag : Enum<MessageListFlag>

对消息进行查询时的 flag 参数范围。

MessageListRequest

class MessageListRequest(targetId: ID, msgId: ID? = null, pin: Boolean = false, flag: MessageListFlag? = null, pageSize: Int = -1) : KookGetRequest<KookApiResult.ListData<ChannelMessageDetails>>

获取频道聊天消息列表

MessageReactionListRequest

class MessageReactionListRequest(msgId: ID, emoji: ID) : KookGetRequest<List<MessageReactor>>

获取频道消息某回应的用户列表

class MessageReactor @ApiResultType constructor(val id: CharSequenceID, val username: String, val nickname: String, val identifyNum: String, val online: Boolean, val status: Int, val avatar: String, val isBot: Boolean, val reactionTime: Timestamp)

api MessageReactionListRequest 的响应列表元素。

sealed class MessageType

消息的类型。

MessageTypeSerializer

object MessageTypeSerializer : KSerializer<MessageType>

MessageType 的序列化器, 使用 MessageType.type 作为字面量数字进行序列化。

MessageUpdateRequest

class MessageUpdateRequest(msgId: ID, content: String, quote: ID? = null, tempTargetId: ID? = null) : KookPostRequest<Unit>

更新频道聊天消息

MessageViewRequest

class MessageViewRequest(msgId: ID) : KookGetRequest<ChannelMessageDetails>

获取频道聊天消息详情

interface Reaction

回应信息

Functions

directMessageCreateRequestByChatCode

fun directMessageCreateRequestByChatCode(chatCode: ID, content: String, type: MessageType = MessageType.TEXT, quote: ID? = null, nonce: String? = null): DirectMessageCreateRequest

通过 chatCode 构建一个 DirectMessageCreateRequest api实例。

directMessageCreateRequestByTargetId

fun directMessageCreateRequestByTargetId(targetId: ID, content: String, type: MessageType = MessageType.TEXT, quote: ID? = null, nonce: String? = null): DirectMessageCreateRequest

通过 targetId 构建一个 DirectMessageCreateRequest api实例。

fun MessageReactor.isBan(): Boolean

fun MessageReactor.isNormal(): Boolean

fun MessageCreated.toDirectUpdate(content: String, quote: ID? = null): DirectMessageUpdateRequest

通过 MessageCreated 构建 DirectMessageUpdateRequest 实例。

fun MessageCreated.toUpdate(content: String, quote: ID? = null): MessageUpdateRequest

通过 MessageCreated 构建 MessageUpdateRequest 实例。