Package-level declarations

Types

Link copied to clipboard
data class AddBlockListEventBody(val operatorId: String, val remark: String, val userId: List<String> = emptyList())
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class CardEventExtra(val type: Int, val guildId: String? = null, val channelName: String? = null, val mention: List<String> = emptyList(), val isMentionAll: Boolean = false, val mentionRoles: List<Int> = emptyList(), val isMentionHere: Boolean = false, val author: SimpleUser, val navChannels: List<String>? = null, val code: String? = null) : TextExtra
Link copied to clipboard
data class DeleteBlockListEventBody(val operatorId: String, val remark: String)
Link copied to clipboard
data class DeletedChannelEventBody(val id: String, val deletedAt: Long)

DeletedChannelEventExtra 事件体,被删除的子频道信息。

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class Event<out E : EventExtra>(val channelTypeValue: String, val typeValue: Int, val targetId: String, val authorId: String, val content: String, val msgId: String, val msgTimestamp: Long, val nonce: String, val extra: E)
Link copied to clipboard

事件的消息 extra

Link copied to clipboard
data class EventGuild(val id: String, val name: String, val topic: String, val userId: String, val icon: String, val notifyType: Int, val region: String, val enableOpenValue: Int, val openId: String, val defaultChannelId: String, val welcomeChannelId: String) : Guild

// TODO

Link copied to clipboard
data class ExitedChannelEventBody(val userId: String, val channelId: String, val exitedAt: Long)
Link copied to clipboard
data class ExitedGuildEventBody(val userId: String, val exitedAt: Long)
Link copied to clipboard
Link copied to clipboard
data class GuildMemberOnlineStatusChangedEventBody(val userId: String, val eventTime: Long, val guilds: List<String> = emptyList())
Link copied to clipboard
data class ImageEventExtra(val type: Int, val guildId: String? = null, val channelName: String? = null, val mention: List<String> = emptyList(), val isMentionAll: Boolean = false, val mentionRoles: List<Int> = emptyList(), val isMentionHere: Boolean = false, val author: SimpleUser, val attachments: SimpleAttachments) : TextExtra
Link copied to clipboard
data class JoinedChannelEventBody(val userId: String, val channelId: String, val joinedAt: Long)
Link copied to clipboard
data class JoinedGuildEventBody(val userId: String, val joinedAt: Long)
Link copied to clipboard
Link copied to clipboard
data class KMarkdownEventExtra(val type: Int, val guildId: String? = null, val channelName: String? = null, val mention: List<String> = emptyList(), val isMentionAll: Boolean = false, val mentionRoles: List<Int> = emptyList(), val isMentionHere: Boolean = false, val author: SimpleUser, val navChannels: List<String>? = null, val code: String? = null, val kmarkdown: RawValueKMarkdown) : TextExtra
Link copied to clipboard
data class MessageBtnClickEventBody(val msgId: String, val userId: String, val value: String, val targetId: String, val userInfo: SimpleUser)
Link copied to clipboard
data class PingEventExtraBody(val channelId: String, val operatorId: String, val msgId: String)

置顶消息相关事件 extra 内 body

Link copied to clipboard
Link copied to clipboard
data class ReactionEventExtraBody(val msgId: String, val userId: String, val channelId: String, val emoji: ReactionEmoji)

Reaction 相关事件 extra 内 body

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class Signal

信令基本格式

Link copied to clipboard
@SerialName(value = "sys")
sealed class SystemExtra : EventExtra

系统事件消息 extra

Link copied to clipboard
data class TextEventExtra(val type: Int, val guildId: String? = null, val channelName: String? = null, val mention: List<String> = emptyList(), val isMentionAll: Boolean = false, val mentionRoles: List<Int> = emptyList(), val isMentionHere: Boolean = false, val author: SimpleUser) : TextExtra
Link copied to clipboard
@SerialName(value = "text")
sealed class TextExtra : EventExtra

文字频道消息 extra

Link copied to clipboard
@FragileSimbotAPI
@SerialName(value = "$$UNKNOWN")
class UnknownExtra : EventExtra

当一个事件反序列化失败的时候,会被尝试使用 UnknownExtra 作为 extra 的序列化目标。 如果是因为一个未知的事件导致的这次失败,则 UnknownExtra 便会反序列化成功并被推送。

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class UpdatedGuildMemberEventBody(val userId: String, val nickname: String)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class UserUpdatedEventBody(val userId: String, val username: String, val avatar: String)
Link copied to clipboard
Link copied to clipboard
data class VideoEventExtra(val type: Int, val guildId: String? = null, val channelName: String? = null, val mention: List<String> = emptyList(), val isMentionAll: Boolean = false, val mentionRoles: List<Int> = emptyList(), val isMentionHere: Boolean = false, val author: SimpleUser, val attachments: SimpleAttachments) : TextExtra