Package net.dv8tion.jda.internal.interactions.command

Class CommandImpl

java.lang.Object

net.dv8tion.jda.internal.interactions.command.CommandImpl

All Implemented Interfaces:

Formattable, IMentionable, ISnowflake, Command, ICommandReference

public class CommandImpl
extends Object
implements Command

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.interactions.commands.Command

Command.Choice, Command.Option, Command.Subcommand, Command.SubcommandGroup, Command.Type

Field Summary

Fields

Modifier and Type	Field	Description
static final Predicate<DataObject>	GROUP_TEST
static final Predicate<DataObject>	OPTION_TEST
static final EnumSet<OptionType>	OPTIONS
static final Predicate<DataObject>	SUBCOMMAND_TEST

Constructor Summary

Constructors

Constructor	Description
CommandImpl(JDAImpl api, Guild guild, DataObject json)

Method Summary

Modifier and Type	Method	Description
RestAction<Void>	delete()	Delete this command.
CommandEditAction	editCommand()	Edit this command.
boolean	equals(Object obj)
long	getApplicationIdLong()	The id of the application this command belongs to.
String	getAsMention()	Retrieve a Mention for this Entity.
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.
String	getFullCommandName()	Returns the full command name, including possible subcommand name and subcommand group name.
long	getIdLong()	The Snowflake id of this entity.
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.
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.
Command.Type	getType()	The Command.Type of command
long	getVersion()	The version of this command.
int	hashCode()
boolean	isNSFW()	Whether this command is restricted to NSFW (age-restricted) channels.
static <T> List<T>	parseOptions(DataObject json, Predicate<DataObject> test, Function<DataObject,T> transform)
RestAction<List<IntegrationPrivilege>>	retrievePrivileges(Guild guild)	Retrieves the IntegrationPrivileges for this command.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

getApplicationId, getTimeModified

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

formatTo

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

getId, getTimeCreated

Field Details

OPTIONS

public static final EnumSet<OptionType> OPTIONS

OPTION_TEST

public static final Predicate<DataObject> OPTION_TEST

SUBCOMMAND_TEST

public static final Predicate<DataObject> SUBCOMMAND_TEST

GROUP_TEST

public static final Predicate<DataObject> GROUP_TEST

Constructor Details

CommandImpl

public CommandImpl(JDAImpl api,
 Guild guild,
 DataObject json)

Method Details

parseOptions

public static <T> List<T> parseOptions(DataObject json,
 Predicate<DataObject> test,
 Function<DataObject,T> transform)

delete

@Nonnull
public RestAction<Void> delete()

Description copied from interface: Command

Delete this command.

Specified by:

delete in interface Command

Returns:

RestAction

editCommand

@Nonnull
public CommandEditAction editCommand()

Description copied from interface: Command

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

Specified by:

editCommand in interface Command

Returns:

CommandEditAction

retrievePrivileges

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

Description copied from interface: Command

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

Specified by:

retrievePrivileges in interface Command

Parameters:

guild - The target guild from which to retrieve the privileges

Returns:

RestAction - Type: List of IntegrationPrivilege

getJDA

@Nonnull
public JDA getJDA()

Description copied from interface: Command

Returns the JDA instance of this Command

Specified by:

getJDA in interface Command

Returns:

the corresponding JDA instance

getType

@Nonnull
public Command.Type getType()

Description copied from interface: Command

The Command.Type of command

Specified by:

getType in interface Command

Returns:

The command type

getName

@Nonnull
public String getName()

Description copied from interface: Command

The name of this command.

Specified by:

getName in interface Command

Specified by:

getName in interface ICommandReference

Returns:

The name

getNameLocalizations

@Nonnull
public LocalizationMap getNameLocalizations()

Description copied from interface: Command

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

Specified by:

getNameLocalizations in interface Command

Returns:

The LocalizationMap containing the mapping from DiscordLocale to the localized name

getFullCommandName

@Nonnull
public String getFullCommandName()

Description copied from interface: ICommandReference

Returns the full command name, including possible subcommand name and subcommand group name.
This is the name shown on messages or when writing the command in the text input.

Examples:

• When used on a normal base command, the full name is the name itself, as in the name "ban" is equal to the full name "ban".
• When used on a subcommand "ban", of the base command "mod", the full name resolves to "mod ban"
• When the subcommand is part of a subcommand group, "action" it resolves to "mod action ban"

Specified by:

getFullCommandName in interface ICommandReference

Returns:

the full command name

getDescription

@Nonnull
public String getDescription()

Description copied from interface: Command

The description of this command.

Specified by:

getDescription in interface Command

Returns:

The description, empty for context menu commands

getDescriptionLocalizations

@Nonnull
public LocalizationMap getDescriptionLocalizations()

Description copied from interface: Command

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

Specified by:

getDescriptionLocalizations in interface Command

Returns:

The LocalizationMap containing the mapping from DiscordLocale to the localized description

getOptions

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

Description copied from interface: Command

The Options of this command.

Specified by:

getOptions in interface Command

Returns:

Immutable list of command options

getSubcommands

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

Description copied from interface: Command

The Subcommands of this command.

Specified by:

getSubcommands in interface Command

Returns:

Immutable list of subcommands

getSubcommandGroups

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

Description copied from interface: Command

The SubcommandGroups of this command.

Specified by:

getSubcommandGroups in interface Command

Returns:

Immutable list of subcommand groups

getApplicationIdLong

public long getApplicationIdLong()

Description copied from interface: Command

The id of the application this command belongs to.

Specified by:

getApplicationIdLong in interface Command

Returns:

The application id

getVersion

public long getVersion()

Description copied from interface: Command

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

Specified by:

getVersion in interface Command

Returns:

The version of the command as a snowflake id.

See Also:

• Command.getTimeModified()

getDefaultPermissions

@Nonnull
public DefaultMemberPermissions getDefaultPermissions()

Description copied from interface: Command

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

Specified by:

getDefaultPermissions in interface Command

Returns:

The DefaultMemberPermissions of this command.

getContexts

@Nonnull
public EnumSet<InteractionContextType> getContexts()

Description copied from interface: Command

The contexts in which this command can be used.

Specified by:

getContexts in interface Command

Returns:

The contexts in which this command can be used

getIntegrationTypes

@Nonnull
public EnumSet<IntegrationType> getIntegrationTypes()

Description copied from interface: Command

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

Specified by:

getIntegrationTypes in interface Command

Returns:

The integration types on which this command can be installed on

isNSFW

public boolean isNSFW()

Description copied from interface: Command

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

Specified by:

isNSFW in interface Command

Returns:

True, if this command is NSFW

See Also:

• Age-Restricted Commands FAQ

getIdLong

public long getIdLong()

Description copied from interface: ISnowflake

The Snowflake id of this entity. This is unique to every entity and will never change.

Specified by:

getIdLong in interface ISnowflake

Returns:

Long containing the Id.

getAsMention

@Nonnull
public String getAsMention()

Description copied from interface: ICommandReference

Retrieve a Mention for this Entity. For the public Role (@everyone), this will return the literal string "@everyone".

This will only work on slash commands!

Specified by:

getAsMention in interface ICommandReference

Specified by:

getAsMention in interface IMentionable

Returns:

A resolvable mention.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object