kord-extensions/dev.kordex.core.commands/CommandContext

CommandContext

abstract class CommandContext(val command: Command, val eventObj: Event, val commandName: Key, val cache: MutableStringKeyedMap<Any>) : KordExKoinComponent, TranslatableContext

Light wrapper class representing the context for a command's action.

This is what this refers to in a command action body. You shouldn't have to instantiate this yourself.

Parameters

command

Respective command for this context object.

eventObj

Event that triggered this command.

commandName

Command name given by the user to invoke the command - lower-cased.

cache

Data cache map shared with the defined checks.

Inheritors

ApplicationCommandContext

DummyAutocompleteCommandContext

ChatCommandContext

Constructors

constructor(command: Command, eventObj: Event, commandName: Key, cache: MutableStringKeyedMap<Any>)

Properties

open val cache: MutableStringKeyedMap<Any>

open val command: Command

open val commandName: Key

open val eventObj: Event

open override var resolvedLocale: Locale?

Cached locale variable, stored and retrieved by getLocale.

val sentry: SentryContext

Current Sentry context, containing breadcrumbs and other goodies.

Functions

abstract suspend fun getChannel(): ChannelBehavior

Extract channel information from event data.

abstract suspend 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.

abstract suspend fun getMember(): MemberBehavior?

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

abstract suspend fun getUser(): UserBehavior?

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

abstract suspend 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.