Package net.dv8tion.jda.internal.interactions

Class CommandDataImpl

java.lang.Object

net.dv8tion.jda.internal.interactions.CommandDataImpl

All Implemented Interfaces:

CommandData, SlashCommandData, SerializableData

public class CommandDataImpl
extends Object
implements SlashCommandData

Field Summary

Fields inherited from interface net.dv8tion.jda.api.interactions.commands.build.CommandData

MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH, MAX_OPTIONS

Constructor Summary

Constructors

Constructor	Description
CommandDataImpl(String name, String description)
CommandDataImpl(Command.Type type, String name)

Method Summary

Modifier and Type	Method	Description
CommandDataImpl	addOptions(OptionData... options)	Adds up to 25 options to this command.
CommandDataImpl	addSubcommandGroups(SubcommandGroupData... groups)	Add up to 25 Subcommand-Groups to this command.
CommandDataImpl	addSubcommands(SubcommandData... subcommands)	Add up to 25 Subcommands to this command.
void	checkDescription(String description)
void	checkName(String name)
Set<InteractionContextType>	getContexts()	The contexts in which this command can be used.
DefaultMemberPermissions	getDefaultPermissions()	Gets the DefaultMemberPermissions of this command.
String	getDescription()	The configured description
LocalizationMap	getDescriptionLocalizations()	The localizations of this command's description for various languages.
Set<IntegrationType>	getIntegrationTypes()	Gets the integration types on which this command can be installed on.
String	getName()	The current command name
LocalizationMap	getNameLocalizations()	The localizations of this command's name for various languages.
List<OptionData>	getOptions()	The options for this command.
List<SubcommandGroupData>	getSubcommandGroups()	The Subcommand Groups in this command.
List<SubcommandData>	getSubcommands()	The Subcommands in this command.
Command.Type	getType()	The Command.Type
boolean	isNSFW()	Whether this command should only be usable in NSFW (age-restricted) channels
static CommandDataImpl	of(Command.Type type, String name, String description)
void	removeAllOptions()
boolean	removeOptions(Predicate<? super OptionData> condition)	Removes all options that evaluate to true under the provided condition.
boolean	removeSubcommandGroups(Predicate<? super SubcommandGroupData> condition)	Removes all subcommand groups that evaluate to true under the provided condition.
boolean	removeSubcommands(Predicate<? super SubcommandData> condition)	Removes all subcommands that evaluate to true under the provided condition.
CommandDataImpl	setContexts(Collection<InteractionContextType> contexts)	Sets the contexts in which this command can be used (Default: Guild and Bot DMs).
CommandDataImpl	setDefaultPermissions(DefaultMemberPermissions permissions)	Sets the Permissions that a user must have in a specific channel to be able to use this command.
CommandDataImpl	setDescription(String description)	Configure the description
CommandDataImpl	setDescriptionLocalization(DiscordLocale locale, String description)	Sets a language-specific localizations of this command's description.
CommandDataImpl	setDescriptionLocalizations(Map<DiscordLocale,String> map)	Sets multiple language-specific localizations of this command's description.
CommandDataImpl	setIntegrationTypes(Collection<IntegrationType> integrationTypes)	Sets the integration types on which this command can be installed on (Default: Guilds).
CommandDataImpl	setLocalizationFunction(LocalizationFunction localizationFunction)	Sets the LocalizationFunction for this command This enables you to have the entirety of this command to be localized.
CommandDataImpl	setName(String name)	Configure the command name.
CommandDataImpl	setNameLocalization(DiscordLocale locale, String name)	Sets a language-specific localization of this command's name.
CommandDataImpl	setNameLocalizations(Map<DiscordLocale,String> map)	Sets multiple language-specific localizations of this command's name.
CommandDataImpl	setNSFW(boolean nsfw)	Sets whether this command should only be usable in NSFW (age-restricted) channels.
DataObject	toData()	Serialized DataObject for this object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.interactions.commands.build.SlashCommandData

addOption, addOption, addOption, addOptions, addSubcommandGroups, addSubcommands, removeOptionByName, removeSubcommandByName, removeSubcommandGroupByName, setContexts, setIntegrationTypes

Constructor Details

CommandDataImpl

public CommandDataImpl(@Nonnull
 String name,
 @Nonnull
 String description)

CommandDataImpl

public CommandDataImpl(@Nonnull
 Command.Type type,
 @Nonnull
 String name)

Method Details

of

public static CommandDataImpl of(@Nonnull
 Command.Type type,
 @Nonnull
 String name,
 @Nullable
 String description)

checkName

public void checkName(@Nonnull
 String name)

checkDescription

public void checkDescription(@Nonnull
 String description)

toData

@Nonnull
public DataObject toData()

Description copied from interface: SerializableData

Serialized DataObject for this object.

Specified by:

toData in interface SerializableData

Returns:

DataObject

getType

@Nonnull
public Command.Type getType()

Description copied from interface: CommandData

The Command.Type

Specified by:

getType in interface CommandData

Returns:

The Command.Type

getDefaultPermissions

@Nonnull
public DefaultMemberPermissions getDefaultPermissions()

Description copied from interface: CommandData

Gets the DefaultMemberPermissions of this command.
If no permissions have been set, this returns DefaultMemberPermissions.ENABLED.

Specified by:

getDefaultPermissions in interface CommandData

Returns:

DefaultMemberPermissions of this command.

See Also:

• DefaultMemberPermissions.ENABLED
• DefaultMemberPermissions.DISABLED

getContexts

@Nonnull
public Set<InteractionContextType> getContexts()

Description copied from interface: CommandData

The contexts in which this command can be used.

Specified by:

getContexts in interface CommandData

Returns:

The contexts in which this command can be used

getIntegrationTypes

@Nonnull
public Set<IntegrationType> getIntegrationTypes()

Description copied from interface: CommandData

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

Specified by:

getIntegrationTypes in interface CommandData

Returns:

The integration types on which this command can be installed on

isNSFW

public boolean isNSFW()

Description copied from interface: CommandData

Whether this command should only be usable in NSFW (age-restricted) channels

Specified by:

isNSFW in interface CommandData

Returns:

True, if this command is restricted to NSFW channels

See Also:

• Age-Restricted Commands FAQ

getOptions

@Nonnull
public List<OptionData> getOptions()

Description copied from interface: SlashCommandData

The options for this command.

Specified by:

getOptions in interface SlashCommandData

Returns:

Immutable list of OptionData

getSubcommands

@Nonnull
public List<SubcommandData> getSubcommands()

Description copied from interface: SlashCommandData

The Subcommands in this command.

Specified by:

getSubcommands in interface SlashCommandData

Returns:

Immutable list of SubcommandData

getSubcommandGroups

@Nonnull
public List<SubcommandGroupData> getSubcommandGroups()

Description copied from interface: SlashCommandData

The Subcommand Groups in this command.

Specified by:

getSubcommandGroups in interface SlashCommandData

Returns:

Immutable list of SubcommandGroupData

setDefaultPermissions

@Nonnull
public CommandDataImpl setDefaultPermissions(@Nonnull
 DefaultMemberPermissions permissions)

Description copied from interface: CommandData

Sets the Permissions that a user must have in a specific channel to be able to use this command.
By default, everyone can use this command (DefaultMemberPermissions.ENABLED). Additionally, a command can be disabled for everyone but admins via DefaultMemberPermissions.DISABLED.

These configurations can be overwritten by moderators in each guild. See Command.retrievePrivileges(net.dv8tion.jda.api.entities.Guild) to get moderator defined overrides.

Specified by:

setDefaultPermissions in interface CommandData

Specified by:

setDefaultPermissions in interface SlashCommandData

Parameters:

permissions - DefaultMemberPermissions representing the default permissions of this command.

Returns:

The builder instance, for chaining

See Also:

• DefaultMemberPermissions.ENABLED
• DefaultMemberPermissions.DISABLED

setContexts

@Nonnull
public CommandDataImpl setContexts(@Nonnull
 Collection<InteractionContextType> contexts)

Description copied from interface: CommandData

Sets the contexts in which this command can be used (Default: Guild and Bot DMs).
This only has an effect if this command is registered globally.

Specified by:

setContexts in interface CommandData

Specified by:

setContexts in interface SlashCommandData

Parameters:

contexts - The contexts in which this command can be used

Returns:

The builder instance, for chaining

setIntegrationTypes

@Nonnull
public CommandDataImpl setIntegrationTypes(@Nonnull
 Collection<IntegrationType> integrationTypes)

Description copied from interface: CommandData

Sets the integration types on which this command can be installed on (Default: Guilds).
This only has an effect if this command is registered globally.

Specified by:

setIntegrationTypes in interface CommandData

Specified by:

setIntegrationTypes in interface SlashCommandData

Parameters:

integrationTypes - The integration types on which this command can be installed on

Returns:

The builder instance, for chaining

setNSFW

@Nonnull
public CommandDataImpl setNSFW(boolean nsfw)

Description copied from interface: CommandData

Sets whether this command should only be usable in NSFW (age-restricted) channels.
Default: false

Note: Age-restricted commands will not show up in direct messages by default unless the user enables them in their settings.

Specified by:

setNSFW in interface CommandData

Specified by:

setNSFW in interface SlashCommandData

Parameters:

nsfw - True, to make this command nsfw

Returns:

The builder instance, for chaining

See Also:

• Age-Restricted Commands FAQ

addOptions

@Nonnull
public CommandDataImpl addOptions(@Nonnull
 OptionData... options)

Description copied from interface: SlashCommandData

Adds up to 25 options to this command.

Required options must be added before non-required options!

Specified by:

addOptions in interface SlashCommandData

Parameters:

options - The Options to add

Returns:

The builder instance, for chaining

addSubcommands

@Nonnull
public CommandDataImpl addSubcommands(@Nonnull
 SubcommandData... subcommands)

Description copied from interface: SlashCommandData

Add up to 25 Subcommands to this command.
When a subcommand or subcommand group is added, the base command itself cannot be used. Thus using SlashCommandData.addOptions(OptionData...) and SlashCommandData.addSubcommands(SubcommandData...) / SlashCommandData.addSubcommandGroups(SubcommandGroupData...) for the same command, is not supported.

Valid command layouts are as follows:

 command
 |-- subcommand
 |__ subcommand group
     |__ subcommand

 command
 |__ subcommand group
     |__ subcommand

 command
 |-- option
 |__ option
 

Having an option and subcommand simultaneously is not allowed.

Specified by:

addSubcommands in interface SlashCommandData

Parameters:

subcommands - The subcommands to add

Returns:

The builder instance, for chaining

addSubcommandGroups

@Nonnull
public CommandDataImpl addSubcommandGroups(@Nonnull
 SubcommandGroupData... groups)

Description copied from interface: SlashCommandData

Add up to 25 Subcommand-Groups to this command.
When a subcommand or subcommand group is added, the base command itself cannot be used. Thus using SlashCommandData.addOptions(OptionData...) and SlashCommandData.addSubcommands(SubcommandData...) / SlashCommandData.addSubcommandGroups(SubcommandGroupData...) for the same command, is not supported.

Valid command layouts are as follows:

 command
 |-- subcommand
 |__ subcommand group
     |__ subcommand

 command
 |__ subcommand group
     |__ subcommand

 command
 |-- option
 |__ option
 

Having an option and subcommand simultaneously is not allowed.

Specified by:

addSubcommandGroups in interface SlashCommandData

Parameters:

groups - The subcommand groups to add

Returns:

The builder instance, for chaining

setLocalizationFunction

@Nonnull
public CommandDataImpl setLocalizationFunction(@Nonnull
 LocalizationFunction localizationFunction)

Description copied from interface: CommandData

Sets the LocalizationFunction for this command
This enables you to have the entirety of this command to be localized.

Specified by:

setLocalizationFunction in interface CommandData

Specified by:

setLocalizationFunction in interface SlashCommandData

Parameters:

localizationFunction - The localization function

Returns:

The builder instance, for chaining

setName

@Nonnull
public CommandDataImpl setName(@Nonnull
 String name)

Description copied from interface: CommandData

Configure the command name.

Specified by:

setName in interface CommandData

Specified by:

setName in interface SlashCommandData

Parameters:

name - The name, 1-32 characters (lowercase and alphanumeric for Command.Type.SLASH)

Returns:

The builder instance, for chaining

setNameLocalization

@Nonnull
public CommandDataImpl setNameLocalization(@Nonnull
 DiscordLocale locale,
 @Nonnull
 String name)

Description copied from interface: CommandData

Sets a language-specific localization of this command's name.

Specified by:

setNameLocalization in interface CommandData

Specified by:

setNameLocalization in interface SlashCommandData

Parameters:

locale - The locale to associate the translated name with

name - The translated name to put

Returns:

This builder instance, for chaining

setNameLocalizations

@Nonnull
public CommandDataImpl setNameLocalizations(@Nonnull
 Map<DiscordLocale,String> map)

Description copied from interface: CommandData

Sets multiple language-specific localizations of this command's name.

Specified by:

setNameLocalizations in interface CommandData

Specified by:

setNameLocalizations in interface SlashCommandData

Parameters:

map - The map from which to transfer the translated names

Returns:

This builder instance, for chaining

setDescription

@Nonnull
public CommandDataImpl setDescription(@Nonnull
 String description)

Description copied from interface: SlashCommandData

Configure the description

Specified by:

setDescription in interface SlashCommandData

Parameters:

description - The description, 1-100 characters

Returns:

The builder, for chaining

setDescriptionLocalization

@Nonnull
public CommandDataImpl setDescriptionLocalization(@Nonnull
 DiscordLocale locale,
 @Nonnull
 String description)

Description copied from interface: SlashCommandData

Sets a language-specific localizations of this command's description.

Specified by:

setDescriptionLocalization in interface SlashCommandData

Parameters:

locale - The locale to associate the translated description with

description - The translated description to put

Returns:

This builder instance, for chaining

setDescriptionLocalizations

@Nonnull
public CommandDataImpl setDescriptionLocalizations(@Nonnull
 Map<DiscordLocale,String> map)

Description copied from interface: SlashCommandData

Sets multiple language-specific localizations of this command's description.

Specified by:

setDescriptionLocalizations in interface SlashCommandData

Parameters:

map - The map from which to transfer the translated descriptions

Returns:

This builder instance, for chaining

getName

@Nonnull
public String getName()

Description copied from interface: CommandData

The current command name

Specified by:

getName in interface CommandData

Returns:

The command name

getNameLocalizations

@Nonnull
public LocalizationMap getNameLocalizations()

Description copied from interface: CommandData

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

Specified by:

getNameLocalizations in interface CommandData

Returns:

The LocalizationMap containing the mapping from DiscordLocale to the localized name

getDescription

@Nonnull
public String getDescription()

Description copied from interface: SlashCommandData

The configured description

Specified by:

getDescription in interface SlashCommandData

Returns:

The description

getDescriptionLocalizations

@Nonnull
public LocalizationMap getDescriptionLocalizations()

Description copied from interface: SlashCommandData

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

Specified by:

getDescriptionLocalizations in interface SlashCommandData

Returns:

The LocalizationMap containing the mapping from DiscordLocale to the localized description

removeOptions

public boolean removeOptions(@Nonnull
 Predicate<? super OptionData> condition)

Description copied from interface: SlashCommandData

Removes all options that evaluate to true under the provided condition.
This will not affect options within subcommands. Use SubcommandData.removeOptions(Predicate) instead.

Example: Remove all options

 command.removeOptions(option -> true);
 

Example: Remove all options that are required

 command.removeOptions(option -> option.isRequired());
 

Specified by:

removeOptions in interface SlashCommandData

Parameters:

condition - The removal condition (must not throw)

Returns:

True, if any options were removed

removeSubcommands

public boolean removeSubcommands(@Nonnull
 Predicate<? super SubcommandData> condition)

Description copied from interface: SlashCommandData

Removes all subcommands that evaluate to true under the provided condition.
This will not apply to subcommands within subcommand groups. Use SubcommandGroupData.removeSubcommand(Predicate) instead.

Example: Remove all subcommands

 command.removeSubcommands(subcommand -> true);
 

Specified by:

removeSubcommands in interface SlashCommandData

Parameters:

condition - The removal condition (must not throw)

Returns:

True, if any subcommands were removed

removeSubcommandGroups

public boolean removeSubcommandGroups(@Nonnull
 Predicate<? super SubcommandGroupData> condition)

Description copied from interface: SlashCommandData

Removes all subcommand groups that evaluate to true under the provided condition.

Example: Remove all subcommand groups

 command.removeSubcommandGroups(group -> true);
 

Specified by:

removeSubcommandGroups in interface SlashCommandData

Parameters:

condition - The removal condition (must not throw)

Returns:

True, if any subcommand groups were removed

removeAllOptions

public void removeAllOptions()