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

Class SlashCommandReference

java.lang.Object

net.dv8tion.jda.api.interactions.commands.SlashCommandReference

All Implemented Interfaces:

Formattable, IMentionable, ISnowflake, ICommandReference

public class SlashCommandReference
extends Object
implements ICommandReference

Represents a slash command mention, such as </ban soft:1021082477038678126>

Constructor Summary

Constructors

Constructor	Description
SlashCommandReference(String name, String subcommandGroup, String subcommand, long id)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getFullCommandName()	Returns the full command name, including possible subcommand name and subcommand group name.
long	getIdLong()	The Snowflake id of this entity.
String	getName()	Returns the name of the slash command.
String	getSubcommandGroup()	Returns the subcommand group of the slash command
String	getSubcommandName()	Returns the subcommand of the slash command
int	hashCode()
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.ICommandReference

getAsMention

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

formatTo

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

getId, getTimeCreated

Constructor Details

SlashCommandReference

public SlashCommandReference(@Nonnull
 String name,
 @Nullable
 String subcommandGroup,
 @Nullable
 String subcommand,
 long id)

Method Details

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.

getName

@Nonnull
public String getName()

Description copied from interface: ICommandReference

Returns the name of the slash command.
If used on a subcommand, it returns the subcommand name. And when used on a subcommand group, it returns the group name.
You can use ICommandReference.getFullCommandName() to get the full name including base command and group.

Specified by:

getName in interface ICommandReference

Returns:

the name of the slash command

getSubcommandName

@Nullable
public String getSubcommandName()

Returns the subcommand of the slash command

Returns:

the subcommand of the slash command

getSubcommandGroup

@Nullable
public String getSubcommandGroup()

Returns the subcommand group of the slash command

Returns:

the subcommand group of the slash command

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

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object