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

Interface Command

All Superinterfaces:

ISnowflake

public interface Command
extends ISnowflake

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.
String	getDescription()	The description of this command.
JDA	getJDA()	Returns the JDA instance of this Command
String	getName()	The name of this command.
List<Command.Option>	getOptions()	The Options of this command.
List<Command.SubcommandGroup>	getSubcommandGroups()	The SubcommandGroups of this command.
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	isDefaultEnabled()	Whether this command is enabled for everyone by default.
RestAction<List<CommandPrivilege>>	retrievePrivileges(Guild guild)	Retrieves the CommandPrivileges for this command.
RestAction<List<CommandPrivilege>>	updatePrivileges(Guild guild, Collection<? extends CommandPrivilege> privileges)	Updates the list of CommandPrivileges for this command.
RestAction<List<CommandPrivilege>>	updatePrivileges(Guild guild, CommandPrivilege... privileges)	Updates the list of CommandPrivileges for this command.

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

getId, getIdLong, getTimeCreated

Method Details

delete

@Nonnull
@CheckReturnValue
RestAction<Void> delete()

Delete this command.
If this is a global command it may take up to 1 hour to vanish from all clients.

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<CommandPrivilege>> retrievePrivileges(@Nonnull
 Guild guild)

Retrieves the CommandPrivileges for this command.
This is a shortcut for Guild.retrieveCommandPrivilegesById(String).

These privileges are used to restrict who can use commands through Role/User whitelists/blacklists.

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 CommandPrivilege

Throws:

IllegalArgumentException - If the guild is null

updatePrivileges

@Nonnull
@CheckReturnValue
RestAction<List<CommandPrivilege>> updatePrivileges(@Nonnull
 Guild guild,
 @Nonnull
 Collection<? extends CommandPrivilege> privileges)

Updates the list of CommandPrivileges for this command.
Note that commands are enabled by default for all members of a guild, which means you can only blacklist roles and members using this method. To change this behavior, use CommandData.setDefaultEnabled(boolean) on your command.

These privileges are used to restrict who can use commands through Role/User whitelists/blacklists.

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

Parameters:

guild - The target guild from which to update the privileges

privileges - Complete list of CommandPrivileges for this command

Returns:

RestAction - Type: List or CommandPrivilege The updated list of privileges for this command.

Throws:

IllegalArgumentException - If null is provided

IllegalStateException - If this command is not owned by this bot

updatePrivileges

@Nonnull
@CheckReturnValue
RestAction<List<CommandPrivilege>> updatePrivileges(@Nonnull
 Guild guild,
 @Nonnull
 CommandPrivilege... privileges)

Updates the list of CommandPrivileges for this command.
Note that commands are enabled by default for all members of a guild, which means you can only blacklist roles and members using this method. To change this behavior, use CommandData.setDefaultEnabled(boolean) on your command.

These privileges are used to restrict who can use commands through Role/User whitelists/blacklists.

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

Parameters:

guild - The target guild from which to update the privileges

privileges - Complete list of CommandPrivileges for this command

Returns:

RestAction - Type: List or CommandPrivilege The updated list of privileges for this command.

Throws:

IllegalArgumentException - If null is provided

IllegalStateException - If this command is not owned by this bot

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.

Returns:

The name

getDescription

@Nonnull
String getDescription()

The description of this command.

Returns:

The description, empty for context menu commands

isDefaultEnabled

boolean isDefaultEnabled()

Whether this command is enabled for everyone by default.

Returns:

True, if everyone can use this command by default.

getOptions

@Nonnull
List<Command.Option> getOptions()

The Options of this command.

Returns:

Immutable list of command options

getSubcommands

@Nonnull
List<Command.Subcommand> getSubcommands()

The Subcommands of this command.

Returns:

Immutable list of subcommands

getSubcommandGroups

@Nonnull
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()