Interface SelectMenuInteraction<T, S extends SelectMenu>

Type Parameters:

T - The select menu value type

S - The type of select menu

All Superinterfaces:

ComponentInteraction, ICustomIdInteraction, IDeferrableCallback, IMessageEditCallback, IModalCallback, Interaction, IReplyCallback, ISnowflake

All Known Subinterfaces:

EntitySelectInteraction, StringSelectInteraction

All Known Implementing Classes:

EntitySelectInteractionEvent, GenericSelectMenuInteractionEvent, StringSelectInteractionEvent

public interface SelectMenuInteraction<T, S extends SelectMenu>
extends ComponentInteraction

Component Interaction for a SelectMenu.

See Also:

• GenericSelectMenuInteractionEvent
• EntitySelectInteraction
• StringSelectInteraction

Method Summary

Modifier and Type	Method	Description
default RestAction<Void>	editSelectMenu(SelectMenu newMenu)	Update the select menu with a new select menu instance.
S	getComponent()	The ActionComponent instance.
default S	getSelectMenu()	The SelectMenu this interaction belongs to.
List<T>	getValues()	The provided selection.

Methods inherited from interface ComponentInteraction

getChannel, getComponentId, getComponentType, getCustomId, getGuildChannel, getMessage, getMessageId, getMessageIdLong, getUniqueId

Methods inherited from interface IDeferrableCallback

getHook

Methods inherited from interface IMessageEditCallback

deferEdit, editComponents, editComponents, editComponents, editMessage, editMessage, editMessageAttachments, editMessageAttachments, editMessageEmbeds, editMessageEmbeds, editMessageFormat

Methods inherited from interface IModalCallback

replyModal

Methods inherited from interface Interaction

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

Methods inherited from interface IReplyCallback

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

Methods inherited from interface ISnowflake

getId, getIdLong, getTimeCreated

Method Details

getComponent

@Nonnull
S getComponent()

Description copied from interface: ComponentInteraction

The ActionComponent instance.

Specified by:

getComponent in interface ComponentInteraction

Returns:

The ActionComponent

getSelectMenu

@Nonnull
default S getSelectMenu()

The SelectMenu this interaction belongs to.

Returns:

The SelectMenu

See Also:

• ComponentInteraction.getComponentId()

getValues

@Nonnull
List<T> getValues()

The provided selection.

Returns:

List of T

editSelectMenu

@Nonnull
@CheckReturnValue
default RestAction<Void> editSelectMenu(@Nullable
 SelectMenu newMenu)

Update the select menu with a new select menu instance.

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

Parameters:

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

Returns:

RestAction