Package xyz.dynxsty.dih4jda.interactions.commands.application

Class SlashCommand

java.lang.Object

xyz.dynxsty.dih4jda.interactions.commands.RestrictedCommand

xyz.dynxsty.dih4jda.interactions.commands.application.ApplicationCommand<net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent,net.dv8tion.jda.api.interactions.commands.build.SlashCommandData>

xyz.dynxsty.dih4jda.interactions.commands.application.BaseApplicationCommand<net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent,net.dv8tion.jda.api.interactions.commands.build.SlashCommandData>

xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand

All Implemented Interfaces:

ExecutableCommand<net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent>

public abstract class SlashCommand
extends BaseApplicationCommand<net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent,net.dv8tion.jda.api.interactions.commands.build.SlashCommandData>

Represents a single Slash Command.

Since:

v1.5

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SlashCommand.Subcommand	Model class which represents a single Subcommand.
static class	SlashCommand.SubcommandGroup	Model class which represents a single subcommand group.

Nested classes/interfaces inherited from class xyz.dynxsty.dih4jda.interactions.commands.RestrictedCommand

RestrictedCommand.Cooldown

Method Summary

Modifier and Type	Method	Description
final void	addSubcommandGroups(SlashCommand.SubcommandGroup... groups)	Adds SlashCommand.SubcommandGroups to this SlashCommand.
final void	addSubcommands(SlashCommand.Subcommand... classes)	Adds SlashCommand.Subcommands to this SlashCommand.
net.dv8tion.jda.api.interactions.commands.Command	asCommand()	Gets the corresponding JDA entity for this command.
void	execute(net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event)	The method that gets called once the command gets executed.
final SlashCommand.SubcommandGroup[]	getSubcommandGroups()	Returns an array of all SlashCommand.SubcommandGroups this command contains.
final SlashCommand.Subcommand[]	getSubcommands()	Returns an array of all SlashCommand.Subcommands this command contains.

Methods inherited from class xyz.dynxsty.dih4jda.interactions.commands.application.BaseApplicationCommand

getQueueableGuilds, getRegistrationType, setQueueableGuilds, setRegistrationType

Methods inherited from class xyz.dynxsty.dih4jda.interactions.commands.application.ApplicationCommand

getCommandData, setCommandData

Methods inherited from class xyz.dynxsty.dih4jda.interactions.commands.RestrictedCommand

applyCooldown, getCommandCooldown, getRequiredGuilds, getRequiredPermissions, getRequiredRoles, getRequiredUsers, hasCooldown, retrieveCooldown, setCommandCooldown, setRequiredGuilds, setRequiredPermissions, setRequiredRoles, setRequiredUsers

Methods inherited from class java.lang.Object

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

Method Details

getSubcommands

@Nonnull
public final SlashCommand.Subcommand[] getSubcommands()

Returns an array of all SlashCommand.Subcommands this command contains.

Returns:

An SlashCommand.Subcommand-array.

addSubcommands

public final void addSubcommands(@Nonnull
 SlashCommand.Subcommand... classes)

Adds SlashCommand.Subcommands to this SlashCommand.

Parameters:

classes - Instances of the SlashCommand.Subcommands to add.

getSubcommandGroups

@Nonnull
public final SlashCommand.SubcommandGroup[] getSubcommandGroups()

Returns an array of all SlashCommand.SubcommandGroups this command contains.

Returns:

An SlashCommand.SubcommandGroup-array.

addSubcommandGroups

public final void addSubcommandGroups(@Nonnull
 SlashCommand.SubcommandGroup... groups)

Adds SlashCommand.SubcommandGroups to this SlashCommand.

Parameters:

groups - Instances of the SlashCommand.SubcommandGroup class.

execute

public void execute(@Nonnull
 net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event)

Description copied from interface: ExecutableCommand

The method that gets called once the command gets executed.

Parameters:

event - the command that is getting passed.

asCommand

@Nonnull
public net.dv8tion.jda.api.interactions.commands.Command asCommand()

Gets the corresponding JDA entity for this command. If the command was not cached or queued before (e.g. when using sharding), this may return null.

Returns:

The Command corresponding to this class.