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

Class CommandData

java.lang.Object

net.dv8tion.jda.api.interactions.commands.build.BaseCommand<CommandData>

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

All Implemented Interfaces:

SerializableData

public class CommandData
extends BaseCommand<CommandData>
implements SerializableData

Builder for a Slash-Command.

Constructor Summary

Constructors

Constructor	Description
CommandData(String name, String description)	Create an command builder.

Method Summary

Modifier and Type	Method	Description
CommandData	addOption(OptionType type, String name, String description)	Adds an option to this command.
CommandData	addOption(OptionType type, String name, String description, boolean required)	Adds an option to this command.
CommandData	addOptions(Collection<? extends OptionData> options)	Adds up to 25 options to this command.
CommandData	addOptions(OptionData... options)	Adds up to 25 options to this command.
CommandData	addSubcommandGroups(Collection<? extends SubcommandGroupData> groups)	Add up to 25 Subcommand-Groups to this command.
CommandData	addSubcommandGroups(SubcommandGroupData... groups)	Add up to 25 Subcommand-Groups to this command.
CommandData	addSubcommands(Collection<? extends SubcommandData> subcommands)	Add up to 25 Subcommands to this command.
CommandData	addSubcommands(SubcommandData... subcommands)	Add up to 25 Subcommands to this command.
static CommandData	fromData(DataObject object)	Parses the provided serialization back into an CommandData instance.
static List<CommandData>	fromList(Collection<? extends DataObject> collection)	Parses the provided serialization back into an CommandData instance.
static List<CommandData>	fromList(DataArray array)	Parses the provided serialization back into an CommandData instance.
List<SubcommandGroupData>	getSubcommandGroups()	The Subcommand Groups in this command.
List<SubcommandData>	getSubcommands()	The Subcommands in this command.
CommandData	setDefaultEnabled(boolean enabled)	Whether this command is available to everyone by default.
DataObject	toData()	Serialized DataObject for this object.

Methods inherited from class net.dv8tion.jda.api.interactions.commands.build.BaseCommand

getDescription, getName, getOptions, setDescription, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandData

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

Create an command builder.

Parameters:

name - The command name, 1-32 lowercase alphanumeric characters

description - The command description, 1-100 characters

Throws:

IllegalArgumentException - If any of the following requirements are not met

• The name must be lowercase alphanumeric (with dash), 1-32 characters long
• The description must be 1-100 characters long

Method Detail

toData

@Nonnull
public DataObject toData()

Description copied from interface: SerializableData

Serialized DataObject for this object.

Specified by:

toData in interface SerializableData

Overrides:

toData in class BaseCommand<CommandData>

Returns:

DataObject

getSubcommands

@Nonnull
public List<SubcommandData> getSubcommands()

The Subcommands in this command.

Returns:

Immutable list of SubcommandData

getSubcommandGroups

@Nonnull
public List<SubcommandGroupData> getSubcommandGroups()

The Subcommand Groups in this command.

Returns:

Immutable list of SubcommandGroupData

setDefaultEnabled

@Nonnull
public CommandData setDefaultEnabled(boolean enabled)

Whether this command is available to everyone by default.
If this is disabled, you need to explicitly whitelist users and roles per guild.

Parameters:

enabled - True, if this command is enabled by default for everyone. (Default: true)

Returns:

The CommandData instance, for chaining

addOptions

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

Adds up to 25 options to this command.

Required options must be added before non-required options!

Parameters:

options - The Options to add

Returns:

The CommandData instance, for chaining

Throws:

IllegalArgumentException -

• If you try to mix subcommands/options/groups in one command.
• If the option type is OptionType.SUB_COMMAND or OptionType.SUB_COMMAND_GROUP.
• If this option is required and you already added a non-required option.
• If more than 25 options are provided.
• If null is provided

addOptions

@Nonnull
public CommandData addOptions(@Nonnull
                              Collection<? extends OptionData> options)

Adds up to 25 options to this command.

Required options must be added before non-required options!

Parameters:

options - The Options to add

Returns:

The CommandData instance, for chaining

Throws:

IllegalArgumentException -

• If you try to mix subcommands/options/groups in one command.
• If the option type is OptionType.SUB_COMMAND or OptionType.SUB_COMMAND_GROUP.
• If this option is required and you already added a non-required option.
• If more than 25 options are provided.
• If null is provided

addOption

@Nonnull
public CommandData addOption(@Nonnull
                             OptionType type,
                             @Nonnull
                             String name,
                             @Nonnull
                             String description,
                             boolean required)

Adds an option to this command.

Required options must be added before non-required options!

Parameters:

type - The OptionType

name - The lowercase option name, 1-32 characters

description - The option description, 1-100 characters

required - Whether this option is required (See OptionData.setRequired(boolean))

Returns:

The CommandData instance, for chaining

Throws:

IllegalArgumentException -

• If you try to mix subcommands/options/groups in one command.
• If the option type is OptionType.SUB_COMMAND or OptionType.SUB_COMMAND_GROUP.
• If this option is required and you already added a non-required option.
• If more than 25 options are provided.
• If null is provided

addOption

@Nonnull
public CommandData addOption(@Nonnull
                             OptionType type,
                             @Nonnull
                             String name,
                             @Nonnull
                             String description)

Adds an option to this command.
The option is set to be non-required! You can use addOption(OptionType, String, String, boolean) to add a required option instead.

Required options must be added before non-required options!

Parameters:

type - The OptionType

name - The lowercase option name, 1-32 characters

description - The option description, 1-100 characters

Returns:

The CommandData instance, for chaining

Throws:

IllegalArgumentException -

• If you try to mix subcommands/options/groups in one command.
• If the option type is OptionType.SUB_COMMAND or OptionType.SUB_COMMAND_GROUP.
• If this option is required and you already added a non-required option.
• If more than 25 options are provided.
• If null is provided

addSubcommands

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

Add up to 25 Subcommands to this command.

Parameters:

subcommands - The subcommands to add

Returns:

The CommandData instance, for chaining

Throws:

IllegalArgumentException - If null is provided, or more than 25 subcommands are provided. Also throws if you try to mix subcommands/options/groups in one command.

addSubcommands

@Nonnull
public CommandData addSubcommands(@Nonnull
                                  Collection<? extends SubcommandData> subcommands)

Add up to 25 Subcommands to this command.

Parameters:

subcommands - The subcommands to add

Returns:

The CommandData instance, for chaining

Throws:

IllegalArgumentException - If null is provided, or more than 25 subcommands are provided. Also throws if you try to mix subcommands/options/groups in one command.

addSubcommandGroups

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

Add up to 25 Subcommand-Groups to this command.

Parameters:

groups - The subcommand groups to add

Returns:

The CommandData instance, for chaining

Throws:

IllegalArgumentException - If null is provided, or more than 25 subcommand groups are provided. Also throws if you try to mix subcommands/options/groups in one command.

addSubcommandGroups

@Nonnull
public CommandData addSubcommandGroups(@Nonnull
                                       Collection<? extends SubcommandGroupData> groups)

Add up to 25 Subcommand-Groups to this command.

Parameters:

groups - The subcommand groups to add

Returns:

The CommandData instance, for chaining

Throws:

IllegalArgumentException - If null is provided, or more than 25 subcommand groups are provided. Also throws if you try to mix subcommands/options/groups in one command.

fromData

@Nonnull
public static CommandData fromData(@Nonnull
                                   DataObject object)

Parses the provided serialization back into an CommandData instance.
This is the reverse function for 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

fromList

@Nonnull
public static List<CommandData> fromList(@Nonnull
                                         DataArray array)

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

Parameters:

array - Array of serialized DataObject representing the commands

Returns:

The parsed CommandData instances, 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

fromList

@Nonnull
public static List<CommandData> fromList(@Nonnull
                                         Collection<? extends DataObject> collection)

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

Parameters:

collection - Collection of serialized DataObject representing the commands

Returns:

The parsed CommandData instances, 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