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

Interface CommandData

All Superinterfaces:

SerializableData

All Known Subinterfaces:

CommandCreateAction, SlashCommandData

public interface CommandData
extends SerializableData

Builder for Application Commands.
Use the factory methods provided by Commands to create instances of this interface.

See Also:

• Commands

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_DESCRIPTION_LENGTH	The maximum length the description of a command can be.
static final int	MAX_NAME_LENGTH	The maximum length the name of a command can be.
static final int	MAX_OPTIONS	The maximum amount of options/subcommands/groups that can be added to a command or subcommand.

Method Summary

Modifier and Type	Method	Description
static CommandData	fromCommand(Command command)	Converts the provided Command into a CommandData instance.
static CommandData	fromData(DataObject object)	Parses the provided serialization back into an CommandData instance.
@UnmodifiableView Set<InteractionContextType>	getContexts()	The contexts in which this command can be used.
DefaultMemberPermissions	getDefaultPermissions()	Gets the DefaultMemberPermissions of this command.
@UnmodifiableView 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.
Command.Type	getType()	The Command.Type
boolean	isGuildOnly()	Deprecated. Replaced with getContexts()
boolean	isNSFW()	Whether this command should only be usable in NSFW (age-restricted) channels
CommandData	setContexts(Collection<InteractionContextType> contexts)	Sets the contexts in which this command can be used (Default: Guild and Bot DMs).
default CommandData	setContexts(InteractionContextType... contexts)	Sets the contexts in which this command can be used (Default: Guild and Bot DMs).
CommandData	setDefaultPermissions(DefaultMemberPermissions permission)	Sets the Permissions that a user must have in a specific channel to be able to use this command.
CommandData	setGuildOnly(boolean guildOnly)	Deprecated. Replaced with setContexts(InteractionContextType...)
CommandData	setIntegrationTypes(Collection<IntegrationType> integrationTypes)	Sets the integration types on which this command can be installed on (Default: Guilds).
default CommandData	setIntegrationTypes(IntegrationType... integrationTypes)	Sets the integration types on which this command can be installed on (Default: Guilds).
CommandData	setLocalizationFunction(LocalizationFunction localizationFunction)	Sets the LocalizationFunction for this command This enables you to have the entirety of this command to be localized.
CommandData	setName(String name)	Configure the command name.
CommandData	setNameLocalization(DiscordLocale locale, String name)	Sets a language-specific localization of this command's name.
CommandData	setNameLocalizations(Map<DiscordLocale,String> map)	Sets multiple language-specific localizations of this command's name.
CommandData	setNSFW(boolean nsfw)	Sets whether this command should only be usable in NSFW (age-restricted) channels.

Methods inherited from interface net.dv8tion.jda.api.utils.data.SerializableData

toData

Field Details

MAX_NAME_LENGTH

static final int MAX_NAME_LENGTH

The maximum length the name of a command can be. (32)

See Also:

• Constant Field Values

MAX_DESCRIPTION_LENGTH

static final int MAX_DESCRIPTION_LENGTH

The maximum length the description of a command can be. (100)

See Also:

• Constant Field Values

MAX_OPTIONS

static final int MAX_OPTIONS

The maximum amount of options/subcommands/groups that can be added to a command or subcommand. (25)

See Also:

• Constant Field Values

Method Details

setLocalizationFunction

@Nonnull
CommandData setLocalizationFunction(@Nonnull
 LocalizationFunction localizationFunction)

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

Parameters:

localizationFunction - The localization function

Returns:

The builder instance, for chaining

Throws:

IllegalArgumentException - If the localization function is null

setName

@Nonnull
CommandData setName(@Nonnull
 String name)

Configure the command name.

Parameters:

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

Returns:

The builder instance, for chaining

Throws:

IllegalArgumentException - If the name is not between 1-32 characters long, or not lowercase and alphanumeric for slash commands

setNameLocalization

@Nonnull
CommandData setNameLocalization(@Nonnull
 DiscordLocale locale,
 @Nonnull
 String name)

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

Parameters:

locale - The locale to associate the translated name with

name - The translated name to put

Returns:

This builder instance, for chaining

Throws:

IllegalArgumentException -

• If the locale is null
• If the name is null
• If the locale is DiscordLocale.UNKNOWN
• If the name does not pass the corresponding name check

setNameLocalizations

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

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

Parameters:

map - The map from which to transfer the translated names

Returns:

This builder instance, for chaining

Throws:

IllegalArgumentException -

• If the map is null
• If the map contains an DiscordLocale.UNKNOWN key
• If the map contains a name which does not pass the corresponding name check

setDefaultPermissions

@Nonnull
CommandData setDefaultPermissions(@Nonnull
 DefaultMemberPermissions permission)

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.

Parameters:

permission - DefaultMemberPermissions representing the default permissions of this command.

Returns:

The builder instance, for chaining

See Also:

• DefaultMemberPermissions.ENABLED
• DefaultMemberPermissions.DISABLED

setGuildOnly

@Nonnull
@Deprecated
@ReplaceWith("setContexts(InteractionContextType.GUILD)")
CommandData setGuildOnly(boolean guildOnly)

Deprecated.

Replaced with setContexts(InteractionContextType...)

Sets whether this command is only usable in a guild (Default: false).
This only has an effect if this command is registered globally.

Parameters:

guildOnly - Whether to restrict this command to guilds

Returns:

The builder instance, for chaining

setContexts

@Nonnull
default CommandData setContexts(@Nonnull
 InteractionContextType... contexts)

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.

Parameters:

contexts - The contexts in which this command can be used

Returns:

The builder instance, for chaining

Throws:

IllegalArgumentException - If null or no interaction context types were passed

setContexts

@Nonnull
CommandData setContexts(@Nonnull
 Collection<InteractionContextType> contexts)

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.

Parameters:

contexts - The contexts in which this command can be used

Returns:

The builder instance, for chaining

Throws:

IllegalArgumentException - If null or no interaction context types were passed

setIntegrationTypes

@Nonnull
default CommandData setIntegrationTypes(@Nonnull
 IntegrationType... integrationTypes)

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.

Parameters:

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

Returns:

The builder instance, for chaining

Throws:

IllegalArgumentException - If null or no integration types were passed

setIntegrationTypes

@Nonnull
CommandData setIntegrationTypes(@Nonnull
 Collection<IntegrationType> integrationTypes)

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.

Parameters:

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

Returns:

The builder instance, for chaining

Throws:

IllegalArgumentException - If null or no integration types were passed

setNSFW

@Nonnull
CommandData setNSFW(boolean nsfw)

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.

Parameters:

nsfw - True, to make this command nsfw

Returns:

The builder instance, for chaining

See Also:

• Age-Restricted Commands FAQ

getName

@Nonnull
String getName()

The current command name

Returns:

The command name

getNameLocalizations

@Nonnull
LocalizationMap getNameLocalizations()

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

Returns:

The LocalizationMap containing the mapping from DiscordLocale to the localized name

getType

@Nonnull
Command.Type getType()

The Command.Type

Returns:

The Command.Type

getDefaultPermissions

@Nonnull
DefaultMemberPermissions getDefaultPermissions()

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

Returns:

DefaultMemberPermissions of this command.

See Also:

• DefaultMemberPermissions.ENABLED
• DefaultMemberPermissions.DISABLED

isGuildOnly

@Deprecated
@ReplaceWith("getContexts().equals(EnumSet.of(InteractionContextType.GUILD))")
boolean isGuildOnly()

Deprecated.

Replaced with getContexts()

Whether the command can only be used inside a guild.
Always true for guild commands.

Returns:

True, if this command is restricted to guilds.

getContexts

@Nonnull
@UnmodifiableView Set<InteractionContextType> getContexts()

The contexts in which this command can be used.

Returns:

The contexts in which this command can be used

getIntegrationTypes

@Nonnull
@UnmodifiableView Set<IntegrationType> getIntegrationTypes()

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

Returns:

The integration types on which this command can be installed on

isNSFW

boolean isNSFW()

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

Returns:

True, if this command is restricted to NSFW channels

See Also:

• Age-Restricted Commands FAQ

fromCommand

@Nonnull
static CommandData fromCommand(@Nonnull
 Command command)

Converts the provided Command into a CommandData instance.

Parameters:

command - The command to convert

Returns:

An instance of CommandData

Throws:

IllegalArgumentException - If null is provided or the command has illegal configuration

See Also:

• SlashCommandData.fromCommand(Command)

fromData

@Nonnull
static CommandData fromData(@Nonnull
 DataObject object)

Parses the provided serialization back into an CommandData instance.
This is the reverse function for SerializableData.toData().

Parameters:

object - The serialized DataObject representing the command

Returns:

The parsed CommandData instance, which can be further configured through setters

Throws:

ParsingException - If the serialized object is missing required fields

IllegalArgumentException - If any of the values are failing the respective checks such as length

See Also:

• SlashCommandData.fromData(DataObject)
• Commands.fromList(Collection)