io.github.freya022.botcommands.api.commands.application.ApplicationCommandInfo.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of BotCommands Show documentation

A Kotlin-first (and Java) framework that makes creating Discord bots a piece of cake, using the JDA library.

The newest version!

package io.github.freya022.botcommands.api.commands.application

import io.github.freya022.botcommands.api.commands.*
import io.github.freya022.botcommands.api.commands.application.options.ApplicationCommandOption
import io.github.freya022.botcommands.api.commands.application.options.ApplicationCommandParameter
import io.github.freya022.botcommands.api.commands.application.slash.SlashSubcommandGroupInfo
import io.github.freya022.botcommands.api.commands.application.slash.SlashSubcommandInfo
import io.github.freya022.botcommands.api.commands.application.slash.TopLevelSlashCommandInfo
import io.github.freya022.botcommands.api.core.Executable
import io.github.freya022.botcommands.api.core.entities.InputUser
import net.dv8tion.jda.api.entities.channel.middleman.MessageChannel

/**
 * Represents an application command of any kind.
 */
interface ApplicationCommandInfo : CommandInfo, Executable,
                                   ICommandParameterContainer, ICommandOptionContainer,
                                   IFilterContainer {
    /**
     * Retrieves the top-level command owning this application command.
     */
    val topLevelInstance: TopLevelApplicationCommandInfo

    override val parameters: List

    override val discordOptions: List

    @Deprecated("For removal, confusing on whether it searches nested parameters, prefer using collection operations on 'parameters' instead, make an extension or an utility method")
    override fun getParameter(declaredName: String): ApplicationCommandParameter?

    /**
     * Returns the full command name of this application command, separate with spaces.
     *
     * Examples for `/docs search jda`:
     * - [TopLevelSlashCommandInfo] == `docs`
     * - [SlashSubcommandInfo] == `docs search jda`
     * - [SlashSubcommandGroupInfo] == `docs search`
     */
    val fullCommandName: String get() = path.getFullPath(' ')

    /**
     * Returns a [Usability] instance, representing whether this application command can be used.
     */
    fun getUsability(inputUser: InputUser, channel: MessageChannel): Usability
}