Class Command.Subcommand
java.lang.Object
net.dv8tion.jda.api.interactions.commands.Command.Subcommand
- All Implemented Interfaces:
Formattable
,IMentionable
,ISnowflake
,ICommandReference
- Enclosing interface:
- Command
An Subcommand for a command.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
The description of this subcommand.The localizations of this subcommand's description forvarious languages
.Returns the full command name, including possible subcommand name and subcommand group name.long
The Snowflake id of this entity.getName()
The name of this subcommand.The localizations of this subcommands's name forvarious languages
.@Unmodifiable List<Command.Option>
The options for this subcommand, or the subcommands within this group.int
hashCode()
toString()
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
-
Subcommand
-
-
Method Details
-
getIdLong
public long getIdLong()The Snowflake id of this entity. This is unique to every entity and will never change.This will return the ID of the top level command
- Specified by:
getIdLong
in interfaceISnowflake
- Returns:
- Long containing the Id.
-
getName
The name of this subcommand.- Specified by:
getName
in interfaceICommandReference
- Returns:
- The name
-
getNameLocalizations
The localizations of this subcommands's name forvarious languages
.- Returns:
- The
LocalizationMap
containing the mapping fromDiscordLocale
to the localized name
-
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 interfaceICommandReference
- Returns:
- the full command name
- When used on a normal base command, the full name is the name itself, as in the name
-
getDescription
The description of this subcommand.- Returns:
- The description
-
getDescriptionLocalizations
The localizations of this subcommand's description forvarious languages
.- Returns:
- The
LocalizationMap
containing the mapping fromDiscordLocale
to the localized description
-
getOptions
The options for this subcommand, or the subcommands within this group.- Returns:
- Immutable list of Options
-
hashCode
public int hashCode() -
equals
-
toString
-