Package net.dv8tion.jda.api.events.interaction.command

Class GenericCommandInteractionEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

net.dv8tion.jda.api.events.interaction.GenericInteractionCreateEvent

net.dv8tion.jda.api.events.interaction.command.GenericCommandInteractionEvent

All Implemented Interfaces:

ISnowflake, GenericEvent, IDeferrableCallback, IModalCallback, IPremiumRequiredReplyCallback, IReplyCallback, CommandInteraction, CommandInteractionPayload, Interaction

Direct Known Subclasses:

GenericContextInteractionEvent, SlashCommandInteractionEvent

public class GenericCommandInteractionEvent
extends GenericInteractionCreateEvent
implements CommandInteraction

Indicates that a CommandInteraction was used.

Requirements
To receive these events, you must unset the Interactions Endpoint URL in your application dashboard. You can simply remove the URL for this endpoint in your settings at the Discord Developers Portal.

Constructor Summary

Constructors

Constructor	Description
GenericCommandInteractionEvent(JDA api, long responseNumber, CommandInteraction interaction)

Method Summary

Modifier and Type	Method	Description
ReplyCallbackAction	deferReply()	Acknowledge this interaction and defer the reply to a later time.
long	getCommandIdLong()	The command id.
Command.Type	getCommandType()	The Type of command this interaction is for.
InteractionHook	getHook()	The InteractionHook which can be used to send deferred replies or followup messages.
CommandInteraction	getInteraction()	The Interaction instance.
String	getName()	The command name.
List<OptionMapping>	getOptions()	The options provided by the user when this command was executed.
String	getSubcommandGroup()	The subcommand group name.
String	getSubcommandName()	The subcommand name.
boolean	isGuildCommand()	Whether the used command is a guild command.
ModalCallbackAction	replyModal(Modal modal)	Acknowledgement of this interaction with a Modal.
PremiumRequiredCallbackAction	replyWithPremiumRequired()

Methods inherited from class net.dv8tion.jda.api.events.interaction.GenericInteractionCreateEvent

getChannel, getChannelIdLong, getEntitlements, getGuild, getGuildLocale, getIdLong, getMember, getToken, getTypeRaw, getUser, getUserLocale, isAcknowledged

Methods inherited from class net.dv8tion.jda.api.events.Event

getJDA, getRawData, getResponseNumber, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.dv8tion.jda.api.interactions.commands.CommandInteractionPayload

getCommandId, getCommandString, getFullCommandName, getOption, getOption, getOption, getOption, getOptionsByName, getOptionsByType, isGlobalCommand

Methods inherited from interface net.dv8tion.jda.api.interactions.Interaction

getChannel, getChannelId, getChannelIdLong, getChannelType, getEntitlements, getGuild, getGuildChannel, getGuildLocale, getJDA, getMember, getMessageChannel, getToken, getType, getTypeRaw, getUser, getUserLocale, isAcknowledged, isFromGuild

Methods inherited from interface net.dv8tion.jda.api.interactions.callbacks.IReplyCallback

deferReply, reply, reply, replyComponents, replyComponents, replyEmbeds, replyEmbeds, replyFiles, replyFiles, replyFormat

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getIdLong, getTimeCreated

Constructor Details

GenericCommandInteractionEvent

public GenericCommandInteractionEvent(@Nonnull
 JDA api,
 long responseNumber,
 @Nonnull
 CommandInteraction interaction)

Method Details

getInteraction

@Nonnull
public CommandInteraction getInteraction()

Description copied from class: GenericInteractionCreateEvent

The Interaction instance.
Note that this event is a delegate which implements the same interface.

Overrides:

getInteraction in class GenericInteractionCreateEvent

Returns:

The Interaction

getCommandType

@Nonnull
public Command.Type getCommandType()

Description copied from interface: CommandInteractionPayload

The Type of command this interaction is for.

Specified by:

getCommandType in interface CommandInteractionPayload

Returns:

The command type

getName

@Nonnull
public String getName()

Description copied from interface: CommandInteractionPayload

The command name.
This can be useful for abstractions.

Note that commands can have these following structures:

• /name subcommandGroup subcommandName
• /name subcommandName
• /name

You can use CommandInteractionPayload.getFullCommandName() to simplify your checks.

Specified by:

getName in interface CommandInteractionPayload

Returns:

The command name

getSubcommandName

@Nullable
public String getSubcommandName()

Description copied from interface: CommandInteractionPayload

The subcommand name.
This can be useful for abstractions.

Note that commands can have these following structures:

• /name subcommandGroup subcommandName
• /name subcommandName
• /name

You can use CommandInteractionPayload.getFullCommandName() to simplify your checks.

Specified by:

getSubcommandName in interface CommandInteractionPayload

Returns:

The subcommand name, or null if this is not a subcommand

getSubcommandGroup

@Nullable
public String getSubcommandGroup()

Description copied from interface: CommandInteractionPayload

The subcommand group name.
This can be useful for abstractions.

Note that commands can have these following structures:

• /name subcommandGroup subcommandName
• /name subcommandName
• /name

You can use CommandInteractionPayload.getFullCommandName() to simplify your checks.

Specified by:

getSubcommandGroup in interface CommandInteractionPayload

Returns:

The subcommand group name, or null if this is not a subcommand group

getCommandIdLong

public long getCommandIdLong()

Description copied from interface: CommandInteractionPayload

The command id.
This is the id generated when a command is created via Guild.updateCommands() or similar.

It is usually preferred to discriminate commands by the command names instead.

Specified by:

getCommandIdLong in interface CommandInteractionPayload

Returns:

The command id

isGuildCommand

public boolean isGuildCommand()

Description copied from interface: CommandInteractionPayload

Whether the used command is a guild command.

Guild commands can be created with Guild.upsertCommand(CommandData).

Specified by:

isGuildCommand in interface CommandInteractionPayload

Returns:

True, if the used command is a guild command

getOptions

@Nonnull
public List<OptionMapping> getOptions()

Description copied from interface: CommandInteractionPayload

The options provided by the user when this command was executed.
Each option has a name and value.

For CommandAutoCompleteInteraction, this might be incomplete and unvalidated. Auto-complete interactions happen on incomplete command inputs and are not validated.

Specified by:

getOptions in interface CommandInteractionPayload

Returns:

The options passed for this command

See Also:

• CommandInteractionPayload.getOption(String)

getHook

@Nonnull
public InteractionHook getHook()

Description copied from interface: IDeferrableCallback

The InteractionHook which can be used to send deferred replies or followup messages.

Specified by:

getHook in interface IDeferrableCallback

Returns:

The interaction hook

deferReply

@Nonnull
public ReplyCallbackAction deferReply()

Description copied from interface: IReplyCallback

Acknowledge this interaction and defer the reply to a later time.
This will send a <Bot> is thinking... message in chat that will be updated later through either InteractionHook.editOriginal(String) or WebhookClient.sendMessage(String).

You can use deferReply(true) to send a deferred ephemeral reply. If your initial deferred message is not ephemeral it cannot be made ephemeral later. Your first message to the InteractionHook will inherit whether the message is ephemeral or not from this deferred reply.

You only have 3 seconds to acknowledge an interaction!
When the acknowledgement is sent after the interaction expired, you will receive ErrorResponse.UNKNOWN_INTERACTION.

Use IReplyCallback.reply(String) to reply directly.

Specified by:

deferReply in interface IReplyCallback

Returns:

ReplyCallbackAction

replyModal

@Nonnull
public ModalCallbackAction replyModal(@Nonnull
 Modal modal)

Description copied from interface: IModalCallback

Acknowledgement of this interaction with a Modal.

This will open a popup on the target user's Discord client.

Interactions can only be acknowledged once.

You only have 3 seconds to acknowledge an interaction!
When the acknowledgement is sent after the interaction expired, you will receive ErrorResponse.UNKNOWN_INTERACTION.

Specified by:

replyModal in interface IModalCallback

Parameters:

modal - The Modal to send

Returns:

ModalCallbackAction

replyWithPremiumRequired

@Nonnull
public PremiumRequiredCallbackAction replyWithPremiumRequired()

Specified by:

replyWithPremiumRequired in interface IPremiumRequiredReplyCallback