kord-gateway/dev.kord.gateway

Package-level declarations

Types

data class ApplicationCommandPermissionsUpdate(val permissions: DiscordGuildApplicationCommandPermissions, val sequence: Int?) : DispatchEvent

AutoModerationActionExecution

data class AutoModerationActionExecution(val actionExecution: DiscordAutoModerationActionExecution, val sequence: Int?) : DispatchEvent

AutoModerationRuleCreate

data class AutoModerationRuleCreate(val rule: DiscordAutoModerationRule, val sequence: Int?) : DispatchEvent

AutoModerationRuleDelete

data class AutoModerationRuleDelete(val rule: DiscordAutoModerationRule, val sequence: Int?) : DispatchEvent

AutoModerationRuleUpdate

data class AutoModerationRuleUpdate(val rule: DiscordAutoModerationRule, val sequence: Int?) : DispatchEvent

ChannelCreate

data class ChannelCreate(val channel: DiscordChannel, val sequence: Int?) : DispatchEvent

ChannelDelete

data class ChannelDelete(val channel: DiscordChannel, val sequence: Int?) : DispatchEvent

ChannelPinsUpdate

data class ChannelPinsUpdate(val pins: DiscordPinsUpdateData, val sequence: Int?) : DispatchEvent

ChannelUpdate

data class ChannelUpdate(val channel: DiscordChannel, val sequence: Int?) : DispatchEvent

sealed class Close : Event

Command

sealed class Command

DefaultGateway

class DefaultGateway(data: DefaultGatewayData) : Gateway

The default Gateway implementation of Kord, using an HttpClient for the underlying webSocket

DefaultGatewayBuilder

class DefaultGatewayBuilder

DefaultGatewayData

data class DefaultGatewayData(val url: String, val client: HttpClient, val reconnectRetry: Retry, val sendRateLimiter: RateLimiter, val identifyRateLimiter: IdentifyRateLimiter, val dispatcher: CoroutineDispatcher, val eventFlow: MutableSharedFlow<Event>)

DiscordAutoModerationActionExecution

@Serializable

data class DiscordAutoModerationActionExecution(val guildId: Snowflake, val action: DiscordAutoModerationAction, val ruleId: Snowflake, val ruleTriggerType: AutoModerationRuleTriggerType, val userId: Snowflake, val channelId: OptionalSnowflake = OptionalSnowflake.Missing, val messageId: OptionalSnowflake = OptionalSnowflake.Missing, val alertSystemMessageId: OptionalSnowflake = OptionalSnowflake.Missing, val content: String, val matchedKeyword: String?, val matchedContent: String?)

DiscordCreatedInvite

@Serializable

data class DiscordCreatedInvite(val channelId: Snowflake, val code: String, val createdAt: Instant, val guildId: OptionalSnowflake = OptionalSnowflake.Missing, val inviter: Optional<DiscordUser> = Optional.Missing(), val maxAge: DurationInSeconds, val maxUses: Int, val targetType: Optional<InviteTargetType> = Optional.Missing(), val targetUser: Optional<DiscordUser> = Optional.Missing(), val targetApplication: Optional<DiscordPartialApplication> = Optional.Missing(), val temporary: Boolean, val uses: Int)

DiscordDeletedInvite

@Serializable

data class DiscordDeletedInvite(val channelId: Snowflake, val guildId: OptionalSnowflake = OptionalSnowflake.Missing, val code: String)

DiscordPresence

@Serializable

data class DiscordPresence(val status: PresenceStatus, val afk: Boolean, val since: InstantInEpochMilliseconds? = null, val game: DiscordBotActivity? = null)

DiscordRemovedEmoji

@Serializable

data class DiscordRemovedEmoji(val channelId: Snowflake, val guildId: Snowflake, val messageId: Snowflake, val emoji: DiscordRemovedReactionEmoji)

DiscordRemovedReactionEmoji

@Serializable

data class DiscordRemovedReactionEmoji(val id: Snowflake?, val name: String?)

DiscordThreadListSync

@Serializable

data class DiscordThreadListSync(val guildId: Snowflake, val channelIds: Optional<List<Snowflake>> = Optional.Missing(), val threads: List<DiscordChannel>, val members: List<DiscordThreadMember>)

DiscordThreadMembersUpdate

@Serializable

data class DiscordThreadMembersUpdate(val id: Snowflake, val guildId: Snowflake, val memberCount: Int, val addedMembers: Optional<List<DiscordThreadMember>> = Optional.Missing(), val removedMemberIds: Optional<List<Snowflake>> = Optional.Missing())

DispatchEvent

sealed class DispatchEvent : Event

EntitlementCreate

data class EntitlementCreate(val entitlement: DiscordEntitlement, val sequence: Int?) : DispatchEvent

EntitlementDelete

data class EntitlementDelete(val entitlement: DiscordEntitlement, val sequence: Int?) : DispatchEvent

EntitlementUpdate

data class EntitlementUpdate(val entitlement: DiscordEntitlement, val sequence: Int?) : DispatchEvent

Event

sealed class Event

Gateway

interface Gateway : CoroutineScope

An implementation of the Discord Gateway and its lifecycle.

GatewayCloseCode

enum GatewayCloseCode : Enum<GatewayCloseCode>

Enum representation of Discord's Gateway close event codes.

GatewayConfiguration

data class GatewayConfiguration(val token: String, val name: String, val shard: DiscordShard, val presence: Optional<DiscordPresence> = Optional.Missing(), val threshold: Int, val intents: Intents)

GatewayConfigurationBuilder

class GatewayConfigurationBuilder(val token: String, var name: String = "Kord", var shard: DiscordShard = DiscordShard(0, 1), var presence: DiscordPresence? = null, var threshold: Int = 250, var intents: Intents = Intents.NON_PRIVILEGED)

GuildAuditLogEntryCreate

data class GuildAuditLogEntryCreate(val entry: DiscordAuditLogEntry, val sequence: Int?) : DispatchEvent

GuildBanAdd

data class GuildBanAdd(val ban: DiscordGuildBan, val sequence: Int?) : DispatchEvent

GuildBanRemove

data class GuildBanRemove(val ban: DiscordGuildBan, val sequence: Int?) : DispatchEvent

GuildCreate

data class GuildCreate(val guild: DiscordGuild, val sequence: Int?) : DispatchEvent

GuildDelete

data class GuildDelete(val guild: DiscordUnavailableGuild, val sequence: Int?) : DispatchEvent

GuildEmojisUpdate

data class GuildEmojisUpdate(val emoji: DiscordUpdatedEmojis, val sequence: Int?) : DispatchEvent

GuildIntegrationsUpdate

data class GuildIntegrationsUpdate(val integrations: DiscordGuildIntegrations, val sequence: Int?) : DispatchEvent

GuildMemberAdd

data class GuildMemberAdd(val member: DiscordAddedGuildMember, val sequence: Int?) : DispatchEvent

GuildMemberRemove

data class GuildMemberRemove(val member: DiscordRemovedGuildMember, val sequence: Int?) : DispatchEvent

GuildMembersChunk

data class GuildMembersChunk(val data: GuildMembersChunkData, val sequence: Int?) : DispatchEvent

GuildMembersChunkData

@Serializable

data class GuildMembersChunkData(val guildId: Snowflake, val members: List<DiscordGuildMember>, val chunkIndex: Int, val chunkCount: Int, val notFound: Optional<Set<Snowflake>> = Optional.Missing(), val presences: Optional<List<DiscordPresenceUpdate>> = Optional.Missing(), val nonce: Optional<String> = Optional.Missing())

GuildMemberUpdate

data class GuildMemberUpdate(val member: DiscordUpdatedGuildMember, val sequence: Int?) : DispatchEvent

GuildRoleCreate

data class GuildRoleCreate(val role: DiscordGuildRole, val sequence: Int?) : DispatchEvent

GuildRoleDelete

data class GuildRoleDelete(val role: DiscordDeletedGuildRole, val sequence: Int?) : DispatchEvent

GuildRoleUpdate

data class GuildRoleUpdate(val role: DiscordGuildRole, val sequence: Int?) : DispatchEvent

GuildScheduledEventCreate

data class GuildScheduledEventCreate(val event: DiscordGuildScheduledEvent, val sequence: Int?) : DispatchEvent

GuildScheduledEventDelete

data class GuildScheduledEventDelete(val event: DiscordGuildScheduledEvent, val sequence: Int?) : DispatchEvent

GuildScheduledEventUpdate

data class GuildScheduledEventUpdate(val event: DiscordGuildScheduledEvent, val sequence: Int?) : DispatchEvent

GuildScheduledEventUserAdd

data class GuildScheduledEventUserAdd(val data: GuildScheduledEventUserMetadata, val sequence: Int?) : DispatchEvent

GuildScheduledEventUserMetadata

@Serializable

data class GuildScheduledEventUserMetadata(val guildScheduledEventId: Snowflake, val userId: Snowflake, val guildId: Snowflake)

GuildScheduledEventUserRemove

data class GuildScheduledEventUserRemove(val data: GuildScheduledEventUserMetadata, val sequence: Int?) : DispatchEvent

GuildUpdate

data class GuildUpdate(val guild: DiscordGuild, val sequence: Int?) : DispatchEvent

Heartbeat

@Serializable(with = Heartbeat.Serializer::class)

data class Heartbeat(val data: Long?) : Event

HeartbeatACK

object HeartbeatACK : Event

Hello

@Serializable

data class Hello(val heartbeatInterval: Int) : Event

Identify

@Serializable

data class Identify(val token: String, val properties: IdentifyProperties, val compress: OptionalBoolean = OptionalBoolean.Missing, val largeThreshold: OptionalInt = OptionalInt.Missing, val shard: Optional<DiscordShard> = Optional.Missing(), val presence: Optional<DiscordPresence> = Optional.Missing(), val intents: Intents) : Command

IdentifyProperties

@Serializable

data class IdentifyProperties(val os: String, val browser: String, val device: String)

IntegrationCreate

data class IntegrationCreate(val integration: DiscordIntegration, val sequence: Int?) : DispatchEvent

IntegrationDelete

data class IntegrationDelete(val integration: DiscordIntegrationDelete, val sequence: Int?) : DispatchEvent

IntegrationUpdate

data class IntegrationUpdate(val integration: DiscordIntegration, val sequence: Int?) : DispatchEvent

Intent

sealed class Intent

Values that enable a group of events as defined by Discord.

Intents

@Serializable(with = Intents.Serializer::class)

class Intents

A collection of multiple Intents.

InteractionCreate

data class InteractionCreate(val interaction: DiscordInteraction, val sequence: Int?) : DispatchEvent

InvalidSession

@Serializable(with = InvalidSession.Serializer::class)

data class InvalidSession(val resumable: Boolean) : Event

InviteCreate

data class InviteCreate(val invite: DiscordCreatedInvite, val sequence: Int?) : DispatchEvent

Sent when a new invite to a channel is created.

InviteDelete

data class InviteDelete(val invite: DiscordDeletedInvite, val sequence: Int?) : DispatchEvent

Sent when an invite is deleted.

MessageCreate

data class MessageCreate(val message: DiscordMessage, val sequence: Int?) : DispatchEvent

MessageDelete

data class MessageDelete(val message: DeletedMessage, val sequence: Int?) : DispatchEvent

MessageDeleteBulk

data class MessageDeleteBulk(val messageBulk: BulkDeleteData, val sequence: Int?) : DispatchEvent

MessageReactionAdd

data class MessageReactionAdd(val reaction: MessageReactionAddData, val sequence: Int?) : DispatchEvent

MessageReactionRemove

data class MessageReactionRemove(val reaction: MessageReactionRemoveData, val sequence: Int?) : DispatchEvent

MessageReactionRemoveAll

data class MessageReactionRemoveAll(val reactions: AllRemovedMessageReactions, val sequence: Int?) : DispatchEvent

MessageReactionRemoveEmoji

data class MessageReactionRemoveEmoji(val reaction: DiscordRemovedEmoji, val sequence: Int?) : DispatchEvent

MessageUpdate

data class MessageUpdate(val message: DiscordPartialMessage, val sequence: Int?) : DispatchEvent

OpCode

@Serializable(with = OpCode.Serializer::class)

enum OpCode : Enum<OpCode>

PresenceUpdate

data class PresenceUpdate(val presence: DiscordPresenceUpdate, val sequence: Int?) : DispatchEvent

PrivilegedIntent

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FUNCTION])

annotation class PrivilegedIntent

Some Intents are defined as "privileged" due to the sensitive nature of the data and cannot be used by Kord without enabling them.

Ready

data class Ready(val data: ReadyData, val sequence: Int?) : DispatchEvent

ReadyData

@Serializable

data class ReadyData(val version: Int, val user: DiscordUser, val privateChannels: List<DiscordChannel>, val guilds: List<DiscordUnavailableGuild>, val sessionId: String, val resumeGatewayUrl: String, val geoOrderedRtcRegions: Optional<JsonElement?> = Optional.Missing(), val guildHashes: Optional<JsonElement?> = Optional.Missing(), val application: Optional<JsonElement?> = Optional.Missing(), val traces: List<String>, val shard: Optional<DiscordShard> = Optional.Missing())

Reconnect

object Reconnect : Event

RequestGuildMembers

@PrivilegedIntent

@Serializable

data class RequestGuildMembers(val guildId: Snowflake, val query: Optional<String> = Optional.Missing(), val limit: OptionalInt = OptionalInt.Missing, val presences: OptionalBoolean = OptionalBoolean.Missing, val userIds: Optional<Set<Snowflake>> = Optional.Missing(), val nonce: Optional<String> = Optional.Missing()) : Command

A representation of the Discord Request Guild Members command.

Resume

@Serializable

data class Resume(val token: String, val sessionId: String, val sequenceNumber: Int) : Command

Resumed

@Serializable

data class Resumed(val sequence: Int?) : DispatchEvent

SubscriptionCreate

data class SubscriptionCreate(val subscription: DiscordSubscription, val sequence: Int?) : DispatchEvent

SubscriptionDelete

data class SubscriptionDelete(val subscription: DiscordSubscription, val sequence: Int?) : DispatchEvent

SubscriptionUpdate

data class SubscriptionUpdate(val subscription: DiscordSubscription, val sequence: Int?) : DispatchEvent

ThreadCreate

data class ThreadCreate(val channel: DiscordChannel, val sequence: Int?) : DispatchEvent

ThreadDelete

data class ThreadDelete(val channel: DiscordChannel, val sequence: Int?) : DispatchEvent

ThreadListSync

data class ThreadListSync(val sync: DiscordThreadListSync, val sequence: Int?) : DispatchEvent

ThreadMembersUpdate

data class ThreadMembersUpdate(val members: DiscordThreadMembersUpdate, val sequence: Int?) : DispatchEvent

ThreadMemberUpdate

data class ThreadMemberUpdate(val member: DiscordThreadMember, val sequence: Int?) : DispatchEvent

ThreadUpdate

data class ThreadUpdate(val channel: DiscordChannel, val sequence: Int?) : DispatchEvent

Ticker

class Ticker(dispatcher: CoroutineDispatcher = Dispatchers.Default) : CoroutineScope

A reusable fixed rate ticker.

TypingStart

data class TypingStart(val data: DiscordTyping, val sequence: Int?) : DispatchEvent

UnknownDispatchEvent

data class UnknownDispatchEvent(val name: String?, val data: JsonElement?, val sequence: Int?) : DispatchEvent

UpdateStatus

@Serializable

data class UpdateStatus(val since: InstantInEpochMilliseconds?, val activities: List<DiscordBotActivity>, val status: PresenceStatus, val afk: Boolean) : Command

UpdateVoiceStatus

@Serializable

data class UpdateVoiceStatus(val guildId: Snowflake, val channelId: Snowflake?, val selfMute: Boolean, val selfDeaf: Boolean) : Command

UserUpdate

data class UserUpdate(val user: DiscordUser, val sequence: Int?) : DispatchEvent

VoiceServerUpdate

data class VoiceServerUpdate(val voiceServerUpdateData: DiscordVoiceServerUpdateData, val sequence: Int?) : DispatchEvent

VoiceStateUpdate

data class VoiceStateUpdate(val voiceState: DiscordVoiceState, val sequence: Int?) : DispatchEvent

WebhooksUpdate

data class WebhooksUpdate(val webhooksUpdateData: DiscordWebhooksUpdateData, val sequence: Int?) : DispatchEvent

Properties

ALL

@PrivilegedIntent

val <Error class: unknown class>.ALL: Intents

All known Intents (as contained in Intent.entries) combined into a single Intents instance.

NON_PRIVILEGED

val <Error class: unknown class>.NON_PRIVILEGED: Intents

All known non-privileged Intents combined into a single Intents instance.

NONE

val <Error class: unknown class>.NONE: Intents

An Intents instance that contains no Intents.

PRIVILEGED

@PrivilegedIntent

val <Error class: unknown class>.PRIVILEGED: Intents

All known privileged Intents combined into a single Intents instance.

Functions

DefaultGateway

inline fun DefaultGateway(builder: DefaultGatewayBuilder.() -> Unit = {}): DefaultGateway

editPresence

inline suspend fun Gateway.editPresence(builder: PresenceBuilder.() -> Unit)

Intents

fun Intents(vararg flags: Intent): Intents

fun Intents(vararg flags: Intents): Intents

fun Intents(flags: Iterable<Intent>): Intents

@JvmName(name = "Intents0")

fun Intents(flags: Iterable<Intents>): Intents

Returns an instance of Intents that has all bits set that are set in any element of flags.

inline fun Intents(builder: Intents.Builder.() -> Unit = {}): Intents

Returns an instance of Intents built with Intents.Builder.

inline fun <T : Event> Gateway.on(scope: CoroutineScope = this, crossinline consumer: suspend T.() -> Unit): Job

Convenience method that will invoke the consumer on every event T created by Gateway.events.

requestGuildMembers

fun Gateway.requestGuildMembers(request: RequestGuildMembers): Flow<GuildMembersChunk>

Executes the request on this gateway, returning a flow of GuildMembersChunk responses.

fun Gateway.requestGuildMembers(guildId: Snowflake, builder: RequestGuildMembersBuilder.() -> Unit = { requestAllMembers() }): Flow<GuildMembersChunk>

Executes a RequestGuildMembers command configured by the builder for the given guildId on this gateway, returning a flow of GuildMembersChunk responses.

start

inline suspend fun Gateway.start(token: String, config: GatewayConfigurationBuilder.() -> Unit = {})

Starts a reconnecting gateway connection with the given parameters. This function will suspend until the lifecycle of the gateway has ended.