Package net.dv8tion.jda.api.interactions.components.selections

Interface SelectionMenuInteraction

All Superinterfaces:

ComponentInteraction, Interaction, ISnowflake

All Known Implementing Classes:

SelectionMenuEvent

public interface SelectionMenuInteraction
extends ComponentInteraction

Component Interaction for a SelectionMenu.

See Also:

SelectionMenuEvent

Method Summary

Modifier and Type	Method	Description
default RestAction<java.lang.Void>	editSelectionMenu(SelectionMenu newMenu)	Update the selection menu with a new selection menu instance.
SelectionMenu	getComponent()	The Component instance.
default java.util.List<SelectOption>	getSelectedOptions()	If available, this will resolve the selected values to the representative SelectOption instances.
default SelectionMenu	getSelectionMenu()	The SelectionMenu this interaction belongs to.
java.util.List<java.lang.String>	getValues()	The selected values.

Methods inherited from interface net.dv8tion.jda.api.interactions.components.ComponentInteraction

deferEdit, editComponents, editComponents, editMessage, editMessage, editMessageEmbeds, editMessageEmbeds, editMessageFormat, getChannel, getComponentId, getComponentType, getMessage, getMessageId, getMessageIdLong

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

deferReply, deferReply, getChannelType, getGuild, getGuildChannel, getHook, getJDA, getMember, getMessageChannel, getPrivateChannel, getTextChannel, getToken, getType, getTypeRaw, getUser, getVoiceChannel, isAcknowledged, isFromGuild, reply, reply, replyEmbeds, replyEmbeds, replyFormat

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

getId, getIdLong, getTimeCreated

Method Detail

getComponent

@Nullable
SelectionMenu getComponent()

Description copied from interface: ComponentInteraction

The Component instance.
This is null on interactions for ephemeral messages.

Specified by:

getComponent in interface ComponentInteraction

Returns:

The Component, or null if this message is ephemeral

getSelectionMenu

@Nullable
default SelectionMenu getSelectionMenu()

The SelectionMenu this interaction belongs to.
This is null for ephemeral messages!

Returns:

The SelectionMenu

See Also:

ComponentInteraction.getComponentId()

getSelectedOptions

@Nullable
default java.util.List<SelectOption> getSelectedOptions()

If available, this will resolve the selected values to the representative SelectOption instances.
This is null if the message is ephemeral.

Returns:

List of the selected options or null if this message is ephemeral

getValues

@Nonnull
java.util.List<java.lang.String> getValues()

The selected values. These are defined in the individual SelectOptions.

Returns:

List of SelectOption.getValue()

editSelectionMenu

@Nonnull
@CheckReturnValue
default RestAction<java.lang.Void> editSelectionMenu(@Nullable
                                                     SelectionMenu newMenu)

Update the selection menu with a new selection menu instance.

If this interaction is already acknowledged this will use Interaction.getHook() and otherwise ComponentInteraction.editComponents(Collection) directly to acknowledge the interaction.

Parameters:

newMenu - The new selection menu to use, or null to remove this menu from the message entirely

Returns:

RestAction

Throws:

java.lang.IllegalStateException - If this interaction was triggered by a selection menu on an ephemeral message.

See Also:

SelectionMenu.createCopy(), SelectionMenu.create(String)