kord-extensions/dev.kordex.core.commands.application.slash/SlashGroup

SlashGroup

class SlashGroup(val name: Key, val parent: SlashCommand<*, *, *>) : KordExKoinComponent

Slash command group, containing other slash commands.

Parameters

name

Slash command group name

parent

Parent slash command that this group belongs to

Constructors

SlashGroup

constructor(name: Key, parent: SlashCommand<*, *, *>)

Properties

description

lateinit var description: Key

Command group description, which is required and shown on Discord.

descriptionTranslationCache

val descriptionTranslationCache: MutableMap<Locale, String>

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

localisedDescription

val localisedDescription: Localised<String>

A Localised version of description.

localisedName

val localisedName: Localised<String>

A Localised version of name.

name

val name: Key

parent

val parent: SlashCommand<*, *, *>

subCommands

val subCommands: MutableList<SlashCommand<*, *, *>>

List of subcommands belonging to this group.

Functions

ephemeralSubCommand

fun <T : Arguments, M : ModalForm> SlashGroup.ephemeralSubCommand(commandObj: EphemeralSlashCommand<T, M>): EphemeralSlashCommand<T, M>

Function for registering a custom ephemeral slash command object, for subcommands.

suspend fun SlashGroup.ephemeralSubCommand(body: suspend EphemeralSlashCommand<Arguments, ModalForm>.() -> Unit): EphemeralSlashCommand<Arguments, ModalForm>

DSL function for easily registering an ephemeral subcommand, without arguments.

suspend fun <T : Arguments> SlashGroup.ephemeralSubCommand(arguments: () -> T, body: suspend EphemeralSlashCommand<T, ModalForm>.() -> Unit): EphemeralSlashCommand<T, ModalForm>

suspend fun <T : Arguments, M : ModalForm> SlashGroup.ephemeralSubCommand(arguments: () -> T, modal: () -> M, body: suspend EphemeralSlashCommand<T, M>.() -> Unit): EphemeralSlashCommand<T, M>

DSL function for easily registering an ephemeral subcommand, with arguments.

@JvmName(name = "ephemeralSubCommand1")

suspend fun <M : ModalForm> SlashGroup.ephemeralSubCommand(modal: () -> M, body: suspend EphemeralSlashCommand<Arguments, M>.() -> Unit): EphemeralSlashCommand<Arguments, M>

DSL function for easily registering an ephemeral subcommand, with a modal.

getKoin

open override fun getKoin(): Koin

Get the associated Koin instance.

getTranslatedDescription

fun getTranslatedDescription(locale: Locale): String

Return this group's description translated for the given locale, cached as required.

publicSubCommand

fun <T : Arguments, M : ModalForm> SlashGroup.publicSubCommand(commandObj: PublicSlashCommand<T, M>): PublicSlashCommand<T, M>

Function for registering a custom public slash command object, for subcommands.

suspend fun SlashGroup.publicSubCommand(body: suspend PublicSlashCommand<Arguments, ModalForm>.() -> Unit): PublicSlashCommand<Arguments, ModalForm>

DSL function for easily registering a public subcommand, without arguments.

suspend fun <T : Arguments> SlashGroup.publicSubCommand(arguments: () -> T, body: suspend PublicSlashCommand<T, ModalForm>.() -> Unit): PublicSlashCommand<T, ModalForm>

suspend fun <T : Arguments, M : ModalForm> SlashGroup.publicSubCommand(arguments: () -> T, modal: () -> M, body: suspend PublicSlashCommand<T, M>.() -> Unit): PublicSlashCommand<T, M>

DSL function for easily registering a public subcommand, with arguments.

@JvmName(name = "publicSubCommand1")

suspend fun <M : ModalForm> SlashGroup.publicSubCommand(modal: () -> M, body: suspend PublicSlashCommand<Arguments, M>.() -> Unit): PublicSlashCommand<Arguments, M>

DSL function for easily registering a public subcommand, with a modal.

validate

fun validate()

Validate this command group, ensuring it has everything it needs.