Package net.dv8tion.jda.api.interactions.commands

Interface Command

All Superinterfaces:

Formattable, ICommandReference, IMentionable, ISnowflake

public interface Command
extends ISnowflake, ICommandReference

Represents a Discord slash-command.
This can be used to edit or delete the command.

See Also:

• Guild.retrieveCommandById(String)
• Guild.retrieveCommands()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Command.Choice	Predefined choice used for options.
static class	Command.Option	An Option for a command.
static class	Command.Subcommand	An Subcommand for a command.
static class	Command.SubcommandGroup	An Subcommand Group for a command.
static enum	Command.Type	Possible command types

Method Summary

Modifier and Type	Method	Description
RestAction<Void>	delete()	Delete this command.
CommandEditAction	editCommand()	Edit this command.
default String	getApplicationId()	The id of the application this command belongs to.
long	getApplicationIdLong()	The id of the application this command belongs to.
EnumSet<InteractionContextType>	getContexts()	The contexts in which this command can be used.
DefaultMemberPermissions	getDefaultPermissions()	The DefaultMemberPermissions of this command.
String	getDescription()	The description of this command.
LocalizationMap	getDescriptionLocalizations()	The localizations of this command's description for various languages.
EnumSet<IntegrationType>	getIntegrationTypes()	Gets the integration types on which this command can be installed on.
JDA	getJDA()	Returns the JDA instance of this Command
String	getName()	The name of this command.
LocalizationMap	getNameLocalizations()	The localizations of this command's name for various languages.
@Unmodifiable List<Command.Option>	getOptions()	The Options of this command.
@Unmodifiable List<Command.SubcommandGroup>	getSubcommandGroups()	The SubcommandGroups of this command.
@Unmodifiable List<Command.Subcommand>	getSubcommands()	The Subcommands of this command.
default OffsetDateTime	getTimeModified()	The time this command was updated last.
Command.Type	getType()	The Command.Type of command
long	getVersion()	The version of this command.
boolean	isGuildOnly()	Deprecated. Replaced with getContexts()
boolean	isNSFW()	Whether this command is restricted to NSFW (age-restricted) channels.
RestAction<List<IntegrationPrivilege>>	retrievePrivileges(Guild guild)	Retrieves the IntegrationPrivileges for this command.

Methods inherited from interface net.dv8tion.jda.api.interactions.commands.ICommandReference

getAsMention, getFullCommandName

Methods inherited from interface net.dv8tion.jda.api.entities.IMentionable

formatTo

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getIdLong, getTimeCreated

Method Details

delete

@Nonnull
@CheckReturnValue
RestAction<Void> delete()

Delete this command.

Returns:

RestAction

Throws:

IllegalStateException - If this command is not owned by this bot

editCommand

@Nonnull
@CheckReturnValue
CommandEditAction editCommand()

Edit this command.
This can be used to change the command attributes such as name or description.

Returns:

CommandEditAction

Throws:

IllegalStateException - If this command is not owned by this bot

retrievePrivileges

@Nonnull
@CheckReturnValue
RestAction<List<IntegrationPrivilege>> retrievePrivileges(@Nonnull
 Guild guild)

Retrieves the IntegrationPrivileges for this command.
This is a shortcut for Guild.retrieveIntegrationPrivilegesById(String).

Moderators of a guild can modify these privileges through the Integrations Menu

If there is no command with the provided ID, this RestAction fails with ErrorResponse.UNKNOWN_COMMAND

Parameters:

guild - The target guild from which to retrieve the privileges

Returns:

RestAction - Type: List of IntegrationPrivilege

Throws:

IllegalArgumentException - If the guild is null

getJDA

@Nonnull
JDA getJDA()

Returns the JDA instance of this Command

Returns:

the corresponding JDA instance

getType

@Nonnull
Command.Type getType()

The Command.Type of command

Returns:

The command type

getName

@Nonnull
String getName()

The name of this command.

Specified by:

getName in interface ICommandReference

Returns:

The name

getNameLocalizations

@Nonnull
LocalizationMap getNameLocalizations()

The localizations of this command's name for various languages.

Returns:

The LocalizationMap containing the mapping from DiscordLocale to the localized name

getDescription

@Nonnull
String getDescription()

The description of this command.

Returns:

The description, empty for context menu commands

getDescriptionLocalizations

@Nonnull
LocalizationMap getDescriptionLocalizations()

The localizations of this command's description for various languages.

Returns:

The LocalizationMap containing the mapping from DiscordLocale to the localized description

getOptions

@Nonnull
@Unmodifiable List<Command.Option> getOptions()

The Options of this command.

Returns:

Immutable list of command options

getSubcommands

@Nonnull
@Unmodifiable List<Command.Subcommand> getSubcommands()

The Subcommands of this command.

Returns:

Immutable list of subcommands

getSubcommandGroups

@Nonnull
@Unmodifiable List<Command.SubcommandGroup> getSubcommandGroups()

The SubcommandGroups of this command.

Returns:

Immutable list of subcommand groups

getApplicationIdLong

long getApplicationIdLong()

The id of the application this command belongs to.

Returns:

The application id

getApplicationId

@Nonnull
default String getApplicationId()

The id of the application this command belongs to.

Returns:

The application id

getVersion

long getVersion()

The version of this command.
This changes when a command is updated through upsertCommand, updateCommands, or editCommandById
Useful for checking if command cache is outdated

Returns:

The version of the command as a snowflake id.

See Also:

• getTimeModified()

getTimeModified

@Nonnull
default OffsetDateTime getTimeModified()

The time this command was updated last.

Returns:

Time this command was updated last.

See Also:

• getVersion()

getDefaultPermissions

@Nonnull
DefaultMemberPermissions getDefaultPermissions()

The DefaultMemberPermissions of this command.
If this command has no default permission set, this returns DefaultMemberPermissions.ENABLED.

Returns:

The DefaultMemberPermissions of this command.

isGuildOnly

@Deprecated
@ReplaceWith("getContexts().equals(EnumSet.of(InteractionContextType.GUILD))")
boolean isGuildOnly()

Deprecated.

Replaced with getContexts()

Whether the command can only be used inside a guild.
Always true for guild commands.

Returns:

True, if this command is restricted to guilds.

getContexts

@Nonnull
EnumSet<InteractionContextType> getContexts()

The contexts in which this command can be used.

Returns:

The contexts in which this command can be used

getIntegrationTypes

@Nonnull
EnumSet<IntegrationType> getIntegrationTypes()

Gets the integration types on which this command can be installed on.

Returns:

The integration types on which this command can be installed on

isNSFW

boolean isNSFW()

Whether this command is restricted to NSFW (age-restricted) channels.

Returns:

True, if this command is NSFW

See Also:

• Age-Restricted Commands FAQ