kord-extensions/dev.kordex.core.commands.application/ApplicationCommandContext

ApplicationCommandContext

abstract class ApplicationCommandContext(val genericEvent: ApplicationCommandInteractionCreateEvent, val genericCommand: ApplicationCommand<*>, val cache: MutableStringKeyedMap<Any>) : CommandContext

Base class representing the shared functionality for an application command's context.

Parameters

genericEvent

Generic event object to populate data from.

genericCommand

Generic command object that this context belongs to.

Inheritors

MessageCommandContext

SlashCommandContext

UserCommandContext

Constructors

ApplicationCommandContext

constructor(genericEvent: ApplicationCommandInteractionCreateEvent, genericCommand: ApplicationCommand<*>, cache: MutableStringKeyedMap<Any>)

Properties

val appPermissions: Permissions?

The permissions applicable to your bot in this execution context (guild, roles, channels), or null if this command wasn't executed on a guild.

val botSettings: ExtensibleBotBuilder

Current bot setting object.

open val cache: MutableStringKeyedMap<Any>

open lateinit var channel: MessageChannelBehavior

Channel this command was executed within.

open val command: Command

open val commandName: Key

open val eventObj: Event

val genericCommand: ApplicationCommand<*>

val genericEvent: ApplicationCommandInteractionCreateEvent

open var guild: GuildBehavior?

Guild this command was executed within, if any.

open var member: MemberBehavior?

Member that executed this command, if on a guild.

open override var resolvedLocale: Locale?

Cached locale variable, stored and retrieved by getLocale.

val sentry: SentryContext

Current Sentry context, containing breadcrumbs and other goodies.

open lateinit var user: UserBehavior

User that executed this command.

Functions

open suspend override fun getChannel(): MessageChannelBehavior

Extract channel information from event data, if that context is available.

open suspend override fun getGuild(): GuildBehavior?

Extract guild information from event data, if that context is available.

open override fun getKoin(): Koin

Get the associated Koin instance.

open suspend override fun getLocale(): Locale

Resolve the locale for this context, storing it in resolvedLocale.

open suspend override fun getMember(): MemberBehavior?

Extract member information from event data, if that context is available.

open suspend override fun getUser(): UserBehavior

Extract user information from event data, if that context is available.

open suspend override fun populate()

Called before processing, used to populate any extra variables from event data.

waitForResponse

suspend fun CommandContext.waitForResponse(timeout: Long, filter: suspend MessageCreateEvent.() -> Boolean = { true }): Message?

Wait for a message by the user that invoked this command, in the channel it was invoked in, using the given timeout (in milliseconds) and extra filter function.