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

Class CommandAutoCompleteInteractionEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

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

net.dv8tion.jda.api.events.interaction.GenericAutoCompleteInteractionEvent

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

All Implemented Interfaces:

ISnowflake, GenericEvent, IAutoCompleteCallback, CommandAutoCompleteInteraction, CommandInteractionPayload, Interaction

public class CommandAutoCompleteInteractionEvent
extends GenericAutoCompleteInteractionEvent
implements CommandAutoCompleteInteraction

Indicates that a user is typing in an option which supports auto-complete.

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.

See Also:

• CommandAutoCompleteInteraction
• IAutoCompleteCallback

Constructor Summary

Constructors

Constructor	Description
CommandAutoCompleteInteractionEvent(JDA api, long responseNumber, CommandAutoCompleteInteraction interaction)

Method Summary

Modifier and Type	Method	Description
MessageChannelUnion	getChannel()	The channel this interaction happened in.
long	getCommandIdLong()	The command id.
Command.Type	getCommandType()	The Type of command this interaction is for.
AutoCompleteQuery	getFocusedOption()	The focused option which the user is typing.
CommandAutoCompleteInteraction	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.
AutoCompleteCallbackAction	replyChoices(Collection<Command.Choice> choices)	Reply with up to 25 choices which can be picked from by the user.

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

getChannelIdLong, getContext, getEntitlements, getGuild, getGuildLocale, getIdLong, getIntegrationOwners, 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.CommandAutoCompleteInteraction

getGuildChannel

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.callbacks.IAutoCompleteCallback

replyChoice, replyChoice, replyChoice, replyChoiceDoubles, replyChoiceDoubles, replyChoiceLongs, replyChoiceLongs, replyChoices, replyChoiceStrings, replyChoiceStrings

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

getChannelId, getChannelIdLong, getChannelType, getContext, getEntitlements, getGuild, getGuildLocale, getIntegrationOwners, getJDA, getMember, getMessageChannel, getToken, getType, getTypeRaw, getUser, getUserLocale, isAcknowledged, isFromAttachedGuild, isFromGuild

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

getId, getIdLong, getTimeCreated

Constructor Details

CommandAutoCompleteInteractionEvent

public CommandAutoCompleteInteractionEvent(@Nonnull
 JDA api,
 long responseNumber,
 @Nonnull
 CommandAutoCompleteInteraction interaction)

Method Details

getInteraction

@Nonnull
public CommandAutoCompleteInteraction 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 GenericAutoCompleteInteractionEvent

Returns:

The Interaction

getFocusedOption

@Nonnull
public AutoCompleteQuery getFocusedOption()

Description copied from interface: CommandAutoCompleteInteraction

The focused option which the user is typing.

This is not validated by the Discord API and may contain invalid/incomplete inputs.

Specified by:

getFocusedOption in interface CommandAutoCompleteInteraction

Returns:

The focused AutoCompleteQuery

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)

replyChoices

@Nonnull
@CheckReturnValue
public AutoCompleteCallbackAction replyChoices(@Nonnull
 Collection<Command.Choice> choices)

Description copied from interface: IAutoCompleteCallback

Reply with up to 25 choices which can be picked from by the user.
The user may continue writing inputs instead of using one of your choices.

Specified by:

replyChoices in interface IAutoCompleteCallback

Overrides:

replyChoices in class GenericAutoCompleteInteractionEvent

Parameters:

choices - The choice suggestions to present to the user, 0-25 choices

Returns:

AutoCompleteCallbackAction

getChannel

@Nonnull
public MessageChannelUnion getChannel()

Description copied from interface: Interaction

The channel this interaction happened in.

Specified by:

getChannel in interface CommandAutoCompleteInteraction

Specified by:

getChannel in interface Interaction

Overrides:

getChannel in class GenericInteractionCreateEvent

Returns:

The channel or null if the channel is not provided