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

Class SubcommandGroupData

java.lang.Object

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

All Implemented Interfaces:

SerializableData

public class SubcommandGroupData
extends Object
implements SerializableData

Builder for a Slash-Command group.

Constructor Summary

Constructors

Constructor	Description
SubcommandGroupData(String name, String description)	Create an group builder.

Method Summary

Modifier and Type	Method	Description
SubcommandGroupData	addSubcommands(Collection<? extends SubcommandData> subcommands)	Add up to 25 Subcommands to this group.
SubcommandGroupData	addSubcommands(SubcommandData... subcommands)	Add up to 25 Subcommands to this group.
static SubcommandGroupData	fromData(DataObject json)	Parses the provided serialization back into an SubcommandGroupData instance.
static SubcommandGroupData	fromGroup(Command.SubcommandGroup group)	Converts the provided Command.SubcommandGroup into a SubcommandGroupData instance.
String	getDescription()	The description for this subcommand group
String	getName()	The name for this subcommand group
List<SubcommandData>	getSubcommands()	The Subcommands in this group.
SubcommandGroupData	setDescription(String description)	Configure the description
SubcommandGroupData	setName(String name)	Configure the name
DataObject	toData()	Serialized DataObject for this object.

Methods inherited from class java.lang.Object

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

Constructor Details

SubcommandGroupData

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

Create an group builder.

Parameters:

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

description - The group 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 Details

setName

@Nonnull
public SubcommandGroupData setName(@Nonnull
 String name)

Configure the name

Parameters:

name - The lowercase alphanumeric (with dash) name, 1-32 characters

Returns:

The SubcommandGroupData instance, for chaining

Throws:

IllegalArgumentException - If the name is null, not alphanumeric, or not between 1-32 characters

setDescription

@Nonnull
public SubcommandGroupData setDescription(@Nonnull
 String description)

Configure the description

Parameters:

description - The description, 1-100 characters

Returns:

The SubcommandGroupData instance, for chaining

Throws:

IllegalArgumentException - If the name is null or not between 1-100 characters

getName

@Nonnull
public String getName()

The name for this subcommand group

Returns:

The name

getDescription

@Nonnull
public String getDescription()

The description for this subcommand group

Returns:

The description

getSubcommands

@Nonnull
public List<SubcommandData> getSubcommands()

The Subcommands in this group.
These subcommand instances are reconstructed, which means that any modifications will not be reflected in the backing state.

Returns:

Immutable list of SubcommandData

addSubcommands

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

Add up to 25 Subcommands to this group.

Parameters:

subcommands - The subcommands to add

Returns:

The SubcommandGroupData instance, for chaining

Throws:

IllegalArgumentException - If null, more than 25 subcommands, or duplicate subcommand names are provided.

addSubcommands

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

Add up to 25 Subcommands to this group.

Parameters:

subcommands - The subcommands to add

Returns:

The SubcommandGroupData instance, for chaining

Throws:

IllegalArgumentException - If null, more than 25 subcommands, or duplicate subcommand names are provided.

toData

@Nonnull
public DataObject toData()

Description copied from interface: SerializableData

Serialized DataObject for this object.

Specified by:

toData in interface SerializableData

Returns:

DataObject

fromData

@Nonnull
public static SubcommandGroupData fromData(@Nonnull
 DataObject json)

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

Parameters:

json - The serialized DataObject representing the group

Returns:

The parsed SubcommandGroupData 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

fromGroup

@Nonnull
public static SubcommandGroupData fromGroup(@Nonnull
 Command.SubcommandGroup group)

Converts the provided Command.SubcommandGroup into a SubcommandGroupData instance.

Parameters:

group - The subcommand group to convert

Returns:

An instance of SubcommandGroupData

Throws:

IllegalArgumentException - If null is provided or the subcommand group has illegal configuration