Kord

class Kord(resources: ClientResources, cache: DataCache, gateway: MasterGateway, rest: RestClient, selfId: Snowflake, eventFlow: MutableSharedFlow<Event>, dispatcher: CoroutineDispatcher, interceptorBuilder: () -> GatewayEventInterceptor) : CoroutineScope

The central adapter between other Kord modules and source of core events.

Constructors

Kord

fun Kord(resources: ClientResources, cache: DataCache, gateway: MasterGateway, rest: RestClient, selfId: Snowflake, eventFlow: MutableSharedFlow<Event>, dispatcher: CoroutineDispatcher, interceptorBuilder: () -> GatewayEventInterceptor = { DefaultGatewayEventInterceptor(cache) })

Types

Companion

object Companion

Functions

bulkEditApplicationCommandPermissions

inline suspend fun bulkEditApplicationCommandPermissions(guildId: Snowflake, builder: ApplicationCommandPermissionsBulkModifyBuilder.() -> Unit)

createGlobalApplicationCommands

inline suspend fun createGlobalApplicationCommands(builder: MultiApplicationCommandBuilder.() -> Unit): Flow<GlobalApplicationCommand>

createGlobalChatInputCommand

inline suspend fun createGlobalChatInputCommand(name: String, description: String, builder: ChatInputCreateBuilder.() -> Unit = {}): GlobalChatInputCommand

createGlobalMessageCommand

inline suspend fun createGlobalMessageCommand(name: String, builder: MessageCommandCreateBuilder.() -> Unit = {}): GlobalMessageCommand

createGlobalUserCommand

inline suspend fun createGlobalUserCommand(name: String, builder: UserCommandCreateBuilder.() -> Unit = {}): GlobalUserCommand

createGuild

@DeprecatedSinceKord(version = 0.7.0)

inline suspend fun createGuild(builder: GuildCreateBuilder.() -> Unit): Guild

Requests to create a new Guild configured through the builder.

inline suspend fun createGuild(name: String, builder: GuildCreateBuilder.() -> Unit): Guild

Requests to create a new Guild configured through the builder.

createGuildApplicationCommands

inline suspend fun createGuildApplicationCommands(guildId: Snowflake, builder: MultiApplicationCommandBuilder.() -> Unit): Flow<GuildApplicationCommand>

createGuildChatInputCommand

inline suspend fun createGuildChatInputCommand(guildId: Snowflake, name: String, description: String, builder: ChatInputCreateBuilder.() -> Unit = {}): GuildChatInputCommand

createGuildMessageCommand

inline suspend fun createGuildMessageCommand(guildId: Snowflake, name: String, builder: MessageCommandCreateBuilder.() -> Unit = {}): GuildMessageCommand

createGuildUserCommand

inline suspend fun createGuildUserCommand(guildId: Snowflake, name: String, builder: UserCommandCreateBuilder.() -> Unit = {}): GuildUserCommand

editApplicationCommandPermissions

inline suspend fun editApplicationCommandPermissions(guildId: Snowflake, commandId: Snowflake, builder: ApplicationCommandPermissionsModifyBuilder.() -> Unit)

editPresence

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

Requests to edit the presence of the bot user configured by the builder.

editSelf

suspend fun editSelf(builder: CurrentUserModifyBuilder.() -> Unit): User

equals

open operator override fun equals(other: Any?): Boolean

getApplicationInfo

suspend fun getApplicationInfo(): ApplicationInfo

getChannel

suspend fun getChannel(id: Snowflake, strategy: EntitySupplyStrategy<*> = resources.defaultStrategy): Channel?

Requests to get the Channel with the id through the strategy, returns null if the Channel isn't present.

getChannelOf

inline suspend fun <T : Channel> getChannelOf(id: Snowflake, strategy: EntitySupplyStrategy<*> = resources.defaultStrategy): T?

Requests to get the Channel as type T through the strategy, returns null if the Channel isn't present or is not of type T.

getGlobalApplicationCommand

suspend fun getGlobalApplicationCommand(commandId: Snowflake): GlobalApplicationCommand

getGlobalApplicationCommandOf

suspend fun <T> getGlobalApplicationCommandOf(commandId: Snowflake): T

getGlobalApplicationCommandOfOrNull

suspend fun <T> getGlobalApplicationCommandOfOrNull(commandId: Snowflake): T?

getGlobalApplicationCommandOrNull

suspend fun getGlobalApplicationCommandOrNull(commandId: Snowflake): GlobalApplicationCommand?

getGuild

suspend fun getGuild(id: Snowflake, strategy: EntitySupplyStrategy<*> = resources.defaultStrategy): Guild?

getGuildApplicationCommand

suspend fun getGuildApplicationCommand(guildId: Snowflake, commandId: Snowflake): GuildApplicationCommand

getGuildApplicationCommandOf

inline suspend fun <T : GuildApplicationCommand> getGuildApplicationCommandOf(guildId: Snowflake, commandId: Snowflake): T

getGuildApplicationCommandOfOrNull

inline suspend fun <T : GuildApplicationCommand> getGuildApplicationCommandOfOrNull(guildId: Snowflake, commandId: Snowflake): T?

getGuildApplicationCommandOrNull

suspend fun getGuildApplicationCommandOrNull(guildId: Snowflake, commandId: Snowflake): GuildApplicationCommand?

getGuildApplicationCommands

fun getGuildApplicationCommands(guildId: Snowflake): Flow<GuildApplicationCommand>

getGuildPreview

suspend fun getGuildPreview(guildId: Snowflake, strategy: EntitySupplyStrategy<*> = resources.defaultStrategy): GuildPreview

Requests to get the GuildPreview of a guild with the guildId through the strategy, returns null if the GuildPreview isn't present.

getGuildPreviewOrNull

suspend fun getGuildPreviewOrNull(guildId: Snowflake, strategy: EntitySupplyStrategy<*> = resources.defaultStrategy): GuildPreview?

Requests to get the GuildPreview of a guild with the guildId through the strategy, returns null if the GuildPreview isn't present.

getInvite

suspend fun getInvite(code: String, withCounts: Boolean): Invite?

Requests to get the Invite with code through the EntitySupplyStrategy.rest.

getSelf

suspend fun getSelf(strategy: EntitySupplyStrategy<*> = resources.defaultStrategy): User

Requests to get the User that represents this bot account through the strategy,

getUser

suspend fun getUser(id: Snowflake, strategy: EntitySupplyStrategy<*> = resources.defaultStrategy): User?

Requests to get the User that with the id through the strategy,

getWebhook

suspend fun getWebhook(id: Snowflake, strategy: EntitySupplyStrategy<*> = resources.defaultStrategy): Webhook

Requests to get the Webhook in this guild.

getWebhookOrNull

suspend fun getWebhookOrNull(id: Snowflake, strategy: EntitySupplyStrategy<*> = resources.defaultStrategy): Webhook?

Requests to get the Webhook in this guild with an authentication token, returns null if the webhook was not present.

getWebhookWithToken

suspend fun getWebhookWithToken(id: Snowflake, token: String, strategy: EntitySupplyStrategy<*> = resources.defaultStrategy): Webhook

Requests to get the Webhook in this guild with an authentication token.

getWebhookWithTokenOrNull

suspend fun getWebhookWithTokenOrNull(id: Snowflake, token: String, strategy: EntitySupplyStrategy<*>): Webhook?

Requests to get the Webhook in this guild with an authentication token, returns null if the webhook was not present.

inline suspend fun login(builder: LoginBuilder.() -> Unit = {})

Logs in to the configured Gateways.

logout

suspend fun logout()

Logs out to the configured Gateways.

shutdown

suspend fun shutdown()

Logs out of all connected Gateways and frees all resources.

toString

open override fun toString(): String

with

fun <T : EntitySupplier> with(strategy: EntitySupplyStrategy<T>): T

Properties

cache

val cache: DataCache

coroutineContext

open override val coroutineContext: CoroutineContext

defaultSupplier

val defaultSupplier: EntitySupplier

The default supplier, obtained through Kord's resources and configured through KordBuilder.defaultStrategy.

events

val events: SharedFlow<Event>

The events emitted from the gateway.

gateway

val gateway: MasterGateway

globalCommands

val globalCommands: Flow<GlobalApplicationCommand>

Global commands made by the bot under this Kord instance.

guilds

val guilds: Flow<Guild>

regions

val regions: Flow<Region>

resources

val resources: ClientResources

rest

val rest: RestClient

selfId

val selfId: Snowflake

unsafe

val unsafe: Unsafe

A reference to all exposed unsafe entity constructors for this instance.

Extensions

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

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

Sources

jvm source