kord-extensions/dev.kordex.core.commands.application.message/EphemeralMessageCommandContext

EphemeralMessageCommandContext

class EphemeralMessageCommandContext<M : ModalForm>(val event: MessageCommandInteractionCreateEvent, val command: MessageCommand<EphemeralMessageCommandContext<M>, M>, val interactionResponse: EphemeralMessageInteractionResponseBehavior, cache: MutableStringKeyedMap<Any>) : MessageCommandContext<EphemeralMessageCommandContext<M>, M> , EphemeralInteractionContext

Ephemeral-only message command context.

Constructors

constructor(event: MessageCommandInteractionCreateEvent, command: MessageCommand<EphemeralMessageCommandContext<M>, M>, interactionResponse: EphemeralMessageInteractionResponseBehavior, cache: MutableStringKeyedMap<Any>)

Properties

appPermissions

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.

botSettings

val botSettings: ExtensibleBotBuilder

Current bot setting object.

cache

open val cache: MutableStringKeyedMap<Any>

channel

open lateinit var channel: MessageChannelBehavior

Channel this command was executed within.

command

open override val command: MessageCommand<EphemeralMessageCommandContext<M>, M>

commandName

open val commandName: Key

event

open override val event: MessageCommandInteractionCreateEvent

eventObj

open val eventObj: Event

genericCommand

val genericCommand: ApplicationCommand<*>

genericEvent

val genericEvent: ApplicationCommandInteractionCreateEvent

guild

open var guild: GuildBehavior?

Guild this command was executed within, if any.

interactionResponse

open override val interactionResponse: EphemeralMessageInteractionResponseBehavior

Current interaction response being worked with.

member

open var member: MemberBehavior?

Member that executed this command, if on a guild.

resolvedLocale

open override var resolvedLocale: Locale?

Cached locale variable, stored and retrieved by getLocale.

sentry

val sentry: SentryContext

Current Sentry context, containing breadcrumbs and other goodies.

targetMessages

val targetMessages: Collection<Message>

Messages that this message command is being executed against.

user

open lateinit var user: UserBehavior

User that executed this command.

Functions

edit

open suspend override fun edit(builder: suspend InteractionResponseModifyBuilder.() -> Unit): EphemeralMessageInteractionResponse

Edit the original interaction response.

editingPaginator

open override fun editingPaginator(defaultGroup: Key, locale: Locale?, builder: PaginatorBuilder.() -> Unit): EphemeralResponsePaginator

Create a paginator that edits the original interaction response.

getChannel

open suspend override fun getChannel(): MessageChannelBehavior

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

getGuild

open suspend override fun getGuild(): GuildBehavior?

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

getKoin

open override fun getKoin(): Koin

Get the associated Koin instance.

getLocale

open suspend override fun getLocale(): Locale

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

getMember

open suspend override fun getMember(): MemberBehavior?

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

getUser

open suspend override fun getUser(): UserBehavior

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

populate

open suspend override fun populate()

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

respond

open suspend override fun respond(builder: suspend FollowupMessageCreateBuilder.() -> Unit): EphemeralFollowupMessage

Create a follow-up response.

respondingPaginator

open suspend override fun respondingPaginator(defaultGroup: Key, locale: Locale?, builder: suspend PaginatorBuilder.() -> Unit): PublicFollowUpPaginator

Create a paginator that creates a follow-up message, and edits that.

respondOpposite

open suspend override fun respondOpposite(builder: suspend FollowupMessageCreateBuilder.() -> Unit): PublicFollowupMessage

Create a follow-up response using the opposite interaction type.

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.