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 aoptionwhich supportsauto-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.
-
-
Constructor Summary
Constructors Constructor Description CommandAutoCompleteInteractionEvent(JDA api, long responseNumber, CommandAutoCompleteInteraction interaction)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description longgetCommandIdLong()The command id.Command.TypegetCommandType()TheTypeof command this interaction is for.AutoCompleteQuerygetFocusedOption()The focused option which the user is typing.CommandAutoCompleteInteractiongetInteraction()TheInteractioninstance.StringgetName()The command name.List<OptionMapping>getOptions()The options provided by the user when this command was executed.StringgetSubcommandGroup()The subcommand group name.StringgetSubcommandName()The subcommand name.AutoCompleteCallbackActionreplyChoices(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
getChannel, getGuild, getGuildLocale, getIdLong, getMember, getToken, getTypeRaw, getUser, getUserLocale, isAcknowledged
-
Methods inherited from class net.dv8tion.jda.api.events.Event
getJDA, getResponseNumber
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.dv8tion.jda.api.interactions.commands.CommandInteractionPayload
getCommandId, getCommandPath, getCommandString, getOption, getOption, getOption, getOption, getOptionsByName, getOptionsByType
-
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
getChannel, getChannelType, getGuild, getGuildChannel, getGuildLocale, getJDA, getMember, getMessageChannel, getNewsChannel, getPrivateChannel, getTextChannel, getThreadChannel, getToken, getType, getTypeRaw, getUser, getUserLocale, getVoiceChannel, isAcknowledged, isFromGuild
-
Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake
getId, getIdLong, getTimeCreated
-
-
-
-
Constructor Detail
-
CommandAutoCompleteInteractionEvent
public CommandAutoCompleteInteractionEvent(@Nonnull JDA api, long responseNumber, @Nonnull CommandAutoCompleteInteraction interaction)
-
-
Method Detail
-
getInteraction
@Nonnull public CommandAutoCompleteInteraction getInteraction()
Description copied from class:GenericInteractionCreateEventTheInteractioninstance.
Note that this event is a delegate which implements the same interface.- Overrides:
getInteractionin classGenericAutoCompleteInteractionEvent- Returns:
- The
Interaction
-
getFocusedOption
@Nonnull public AutoCompleteQuery getFocusedOption()
Description copied from interface:CommandAutoCompleteInteractionThe focused option which the user is typing.This is not validated by the Discord API and may contain invalid/incomplete inputs.
- Specified by:
getFocusedOptionin interfaceCommandAutoCompleteInteraction- Returns:
- The focused
AutoCompleteQuery
-
getCommandType
@Nonnull public Command.Type getCommandType()
Description copied from interface:CommandInteractionPayloadTheTypeof command this interaction is for.- Specified by:
getCommandTypein interfaceCommandInteractionPayload- Returns:
- The command type
-
getName
@Nonnull public String getName()
Description copied from interface:CommandInteractionPayloadThe command name.
This can be useful for abstractions.Note that commands can have these following structures:
/name subcommandGroup subcommandName/name subcommandName/name
CommandInteractionPayload.getCommandPath()to simplify your checks.- Specified by:
getNamein interfaceCommandInteractionPayload- Returns:
- The command name
-
getSubcommandName
@Nullable public String getSubcommandName()
Description copied from interface:CommandInteractionPayloadThe subcommand name.
This can be useful for abstractions.Note that commands can have these following structures:
/name subcommandGroup subcommandName/name subcommandName/name
CommandInteractionPayload.getCommandPath()to simplify your checks.- Specified by:
getSubcommandNamein interfaceCommandInteractionPayload- Returns:
- The subcommand name, or null if this is not a subcommand
-
getSubcommandGroup
@Nullable public String getSubcommandGroup()
Description copied from interface:CommandInteractionPayloadThe subcommand group name.
This can be useful for abstractions.Note that commands can have these following structures:
/name subcommandGroup subcommandName/name subcommandName/name
CommandInteractionPayload.getCommandPath()to simplify your checks.- Specified by:
getSubcommandGroupin interfaceCommandInteractionPayload- Returns:
- The subcommand group name, or null if this is not a subcommand group
-
getCommandIdLong
public long getCommandIdLong()
Description copied from interface:CommandInteractionPayloadThe command id.
This is the id generated when a command is created viaGuild.updateCommands()or similar.It is usually preferred to discriminate commands by the
command namesinstead.- Specified by:
getCommandIdLongin interfaceCommandInteractionPayload- Returns:
- The command id
-
getOptions
@Nonnull public List<OptionMapping> getOptions()
Description copied from interface:CommandInteractionPayloadThe 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:
getOptionsin interfaceCommandInteractionPayload- Returns:
- The options passed for this command
- See Also:
CommandInteractionPayload.getOption(String)
-
replyChoices
@Nonnull public AutoCompleteCallbackAction replyChoices(@Nonnull Collection<Command.Choice> choices)
Description copied from interface:IAutoCompleteCallbackReply 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:
replyChoicesin interfaceIAutoCompleteCallback- Overrides:
replyChoicesin classGenericAutoCompleteInteractionEvent- Parameters:
choices- The choice suggestions to present to the user, 0-OptionData.MAX_CHOICESchoices- Returns:
AutoCompleteCallbackAction
-
-