kord-extensions/dev.kordex.core.commands.application.user/UserCommand

UserCommand

abstract class UserCommand<C : UserCommandContext<C, M>, M : ModalForm>(extension: Extension, val modal: () -> M? = null) : ApplicationCommand<UserCommandInteractionCreateEvent>

User context command, for right-click actions on users.

Parameters

modal

Callable returning a ModalForm object, if any

Inheritors

EphemeralUserCommand

PublicUserCommand

Constructors

UserCommand

constructor(extension: Extension, modal: () -> M? = null)

Properties

allowByDefault

open var allowByDefault: Boolean

Whether to allow everyone to use this command by default.

allowInDms

open var allowInDms: Boolean

Enables or disables the command in DMs.

body

lateinit var body: suspend C.(M?) -> Unit

Command body, to be called when the command is executed.

defaultMemberPermissions

open var defaultMemberPermissions: Permissions?

Default set of Permissions required to use the command on a guild.

extension

val extension: Extension

The extension object this command belongs to.

kord

val kord: Kord

Kord instance, backing the ExtensibleBot.

localisedName

val localisedName: Localised<String>

A Localised version of name. Lower-cased if this is a slash command.

locking

open override var locking: Boolean

Set this to true to lock command execution with a Mutex.

modal

open val modal: () -> M? = null

mutex

open override var mutex: Mutex?

Mutex object to use for locking.

name

open lateinit var name: Key

The name of this command, for invocation and help commands.

nameTranslationCache

open val nameTranslationCache: MutableMap<Locale, String>

Translation cache, so we don't have to look up translations every time.

registry

val registry: ApplicationCommandRegistry

Quick access to the command registry.

requiredPerms

open override val requiredPerms: MutableSet<Permission>

Permissions required to be able to run this command.

sentry

val sentry: SentryAdapter

Sentry adapter, for easy access to Sentry functions.

settings

val settings: ExtensibleBotBuilder

Bot settings object.

translationsProvider

val translationsProvider: TranslationsProvider

Translations provider, for retrieving translations.

type

open override val type: ApplicationCommandType

Discord-side command type, for matching up.

Functions

action

fun action(action: suspend C.(M?) -> Unit)

Call this to supply a command body, to be called when the command is executed.

call

abstract suspend override fun call(event: UserCommandInteractionCreateEvent, cache: MutableStringKeyedMap<Any>)

Override this to implement your command's calling logic. Check subtypes for examples!

check

open fun check(vararg checks: CheckWithCache<UserCommandInteractionCreateEvent>)

Define a check which must pass for the command to be executed.

open fun check(check: CheckWithCache<UserCommandInteractionCreateEvent>)

Overloaded check function to allow for DSL syntax.

checkBotPerms

open suspend fun checkBotPerms(context: CommandContext)

Checks whether the bot has the specified required permissions, throwing if it doesn't.

doCall

open suspend fun doCall(event: UserCommandInteractionCreateEvent)

Called in order to execute the command.

emitEventAsync

open suspend fun emitEventAsync(event: CommandEvent<*, *>): Job

Quick shortcut for emitting a command event without blocking.

firstSentryBreadcrumb

open suspend fun firstSentryBreadcrumb(context: C)

If enabled, adds the initial Sentry breadcrumb to the given context.

getKoin

open override fun getKoin(): Koin

Get the associated Koin instance.

guild

open fun guild(guild: Snowflake?)

Specify a specific guild for this application command to be locked to.

handleError

open suspend fun handleError(context: C, t: Throwable)

A general way to handle errors thrown during the course of a command's execution.

localise

fun localise(key: Key, lowerCase: Boolean = false): Localised<String>

Localises a property by its key for this command.

lock

open suspend fun lock()

Lock the mutex, if locking is enabled - suspending until it's unlocked.

requireBotPermissions

fun requireBotPermissions(perms: Permissions)

fun requireBotPermissions(vararg perms: Permission)

If your bot requires permissions to be able to execute the command, add them using this function.

requirePermission

fun requirePermission(vararg permissions: Permission)

This will register a requirement for permissions with Discord.

respondText

abstract suspend fun respondText(context: C, message: Key, failureType: FailureReason<*>)

Override this to implement a way to respond to the user, regardless of whatever happens.

runChecks

open suspend override fun runChecks(event: UserCommandInteractionCreateEvent, cache: MutableStringKeyedMap<Any>): Boolean

Override this in order to implement any subclass-specific checks.

runStandardChecks

open suspend fun runStandardChecks(event: UserCommandInteractionCreateEvent, cache: MutableStringKeyedMap<Any>): Boolean

Runs standard checks that can be handled in a generic way, without worrying about subclass-specific checks.

unlock

open fun unlock()

Unlock the mutex, if it's locked.

validate

open override fun validate()

An internal function used to ensure that all of a command's required arguments are present and correct.

withLock

open suspend fun <T> withLock(body: suspend () -> T)

Lock the mutex (if locking is enabled), call the supplied callable, and unlock.