kord-core/dev.kord.core/Kord

Kord

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

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

Constructors

Kord

constructor(resources: ClientResources, cache: DataCache, gateway: MasterGateway, rest: RestClient, selfId: Snowflake, eventFlow: MutableSharedFlow<Event>, dispatcher: CoroutineDispatcher, interceptor: GatewayEventInterceptor)

Types

Companion

object Companion

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. By default a strategy from EntitySupplyStrategy.rest.

events

val events: SharedFlow<Event>

The events emitted from the gateway. Call Kord.login to start receiving events.

gateway

val gateway: MasterGateway

guilds

val guilds: Flow<Guild>

nitroStickerPacks

val nitroStickerPacks: Flow<StickerPack>

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.

Functions

createGlobalApplicationCommands

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

createGlobalChatInputCommand

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

createGlobalMessageCommand

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

createGlobalUserCommand

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

createGuild

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: GuildMultiApplicationCommandBuilder.() -> 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

editPresence

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

Requests to edit the presence of the bot user configured by the builder. The new presence will be shown on all shards. Use MasterGateway.gateways or Event.gateway to set the presence of a single shard.

editSelf

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

equals

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

getApplicationInfo

suspend fun getApplicationInfo(): Application

getApplicationRoleConnectionMetadataRecords

suspend fun getApplicationRoleConnectionMetadataRecords(): List<ApplicationRoleConnectionMetadata>

Requests the ApplicationRoleConnectionMetadata objects for this Application.

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.

getEntitlements

inline fun getEntitlements(strategy: EntitySupplyStrategy<*> = resources.defaultStrategy, builder: EntitlementsListRequestBuilder.() -> Unit = {}): Flow<Entitlement>

Requests to get all Entitlements for this application.

getGlobalApplicationCommand

suspend fun getGlobalApplicationCommand(commandId: Snowflake): GlobalApplicationCommand

getGlobalApplicationCommandOf

@JvmName(name = "getGlobalApplicationCommandOfJvmInlineReplacement")

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

getGlobalApplicationCommandOfOrNull

@JvmName(name = "getGlobalApplicationCommandOfOrNullJvmInlineReplacement")

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

getGlobalApplicationCommandOrNull

suspend fun getGlobalApplicationCommandOrNull(commandId: Snowflake): GlobalApplicationCommand?

getGlobalApplicationCommands

fun getGlobalApplicationCommands(withLocalizations: Boolean? = null): Flow<GlobalApplicationCommand>

getGuild

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

Requests the Guild with the given id.

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, withLocalizations: Boolean? = null): Flow<GuildApplicationCommand>

getGuildOrNull

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

Requests the Guild with the given id, returns null when the guild isn't present.

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 = true, withExpiration: Boolean = true, scheduledEventId: Snowflake? = null): Invite

Requests to get the Invite represented by the code.

getInviteOrNull

suspend fun getInviteOrNull(code: String, withCounts: Boolean = true, withExpiration: Boolean = true, scheduledEventId: Snowflake? = null): Invite?

Requests to get the Invite represented by the code, returns null if the Invite isn't present.

getSelf

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

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

getSkus

suspend fun getSkus(): List<Sku>

Requests to get all Skus for this application.

getSticker

suspend fun getSticker(id: Snowflake): Sticker

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<*> = resources.defaultStrategy): Webhook?

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

hashCode

open override fun hashCode(): Int

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

Logs in to the configured Gateways. Suspends until logout or shutdown is called.

logout

suspend fun logout()

Logs out to the configured Gateways.

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.

shutdown

suspend fun shutdown()

Logs out of all connected Gateways and frees all resources.

toString

open override fun toString(): String

updateApplicationRoleConnectionMetadataRecords

inline suspend fun updateApplicationRoleConnectionMetadataRecords(builder: ApplicationRoleConnectionMetadataRecordsBuilder.() -> Unit): List<ApplicationRoleConnectionMetadata>

Requests to update the ApplicationRoleConnectionMetadata objects for this Application.

with

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