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

Interface SelectMenu

All Superinterfaces:

ActionComponent, ActionRowChildComponent, Component, ICustomId, IDisableable, LabelChildComponent

All Known Subinterfaces:

EntitySelectMenu, StringSelectMenu

public interface SelectMenu
extends ActionComponent, ActionRowChildComponent, LabelChildComponent

Represents a select menu in a message.
This is an interactive component and usually located within an ActionRow. One select menu fills up an entire action row by itself. You cannot have an action row with other components if a select menu is present in the same row.

The selections a user makes are only visible within their current client session. Other users cannot see the choices selected, and they will disappear when the client restarts or the message is reloaded.

This is a generic interface for all types of select menus.
You can use EntitySelectMenu.create(String, Collection) to create a select menu of Discord entities such as users.
Alternatively, you can use StringSelectMenu.create(String) to create a select menu of up to 25 pre-defined strings to pick from.

See Also:

• StringSelectMenu
• EntitySelectMenu
• SelectMenuInteraction

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SelectMenu.Builder<T extends SelectMenu,B extends SelectMenu.Builder<T,B>>	A preconfigured builder for the creation of select menus.

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.components.Component

Component.Type

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ID_MAX_LENGTH	The maximum length a select menu id can have
static final int	OPTIONS_MAX_AMOUNT	The maximum amount of options a select menu can have
static final int	PLACEHOLDER_MAX_LENGTH	The maximum length a select menu placeholder can have

Method Summary

Modifier and Type	Method	Description
default SelectMenu	asDisabled()	Returns a copy of this component with ActionComponent.isDisabled() set to true.
default SelectMenu	asEnabled()	Returns a copy of this component with ActionComponent.isDisabled() set to false.
SelectMenu.Builder<? extends SelectMenu,? extends SelectMenu.Builder<?,?>>	createCopy()	Creates a new preconfigured SelectMenu.Builder with the same settings used for this select menu.
String	getCustomId()	An unique component ID or null.
int	getMaxValues()	The maximum amount of values a user can select at once.
int	getMinValues()	The minimum amount of values a user has to select.
String	getPlaceholder()	Placeholder which is displayed when no selections have been made yet.
Boolean	isRequired()	Whether the user must populate this select menu in Modals, or null if not set.
SelectMenu	withDisabled(boolean disabled)	Returns a copy of this component with ActionComponent.isDisabled() set to the provided value.
SelectMenu	withUniqueId(int uniqueId)	Creates a new component with the provided numeric ID.

Methods inherited from interface net.dv8tion.jda.api.components.ActionComponent

isDisabled

Methods inherited from interface net.dv8tion.jda.api.components.Component

getType, getUniqueId, isMessageCompatible, isModalCompatible

Methods inherited from interface net.dv8tion.jda.api.components.attribute.IDisableable

isEnabled

Field Details

ID_MAX_LENGTH

static final int ID_MAX_LENGTH

The maximum length a select menu id can have

See Also:

• Constant Field Values

PLACEHOLDER_MAX_LENGTH

static final int PLACEHOLDER_MAX_LENGTH

The maximum length a select menu placeholder can have

See Also:

• Constant Field Values

OPTIONS_MAX_AMOUNT

static final int OPTIONS_MAX_AMOUNT

The maximum amount of options a select menu can have

See Also:

• Constant Field Values

Method Details

withDisabled

@Nonnull
SelectMenu withDisabled(boolean disabled)

Description copied from interface: ActionComponent

Returns a copy of this component with ActionComponent.isDisabled() set to the provided value.

Note: Components in modals cannot be disabled.

Specified by:

withDisabled in interface ActionComponent

Specified by:

withDisabled in interface IDisableable

Parameters:

disabled - True, if this component should be disabled

Returns:

New enabled/disabled component instance

See Also:

• ComponentTree.replace(ComponentReplacer)

asDisabled

@Nonnull
default SelectMenu asDisabled()

Description copied from interface: ActionComponent

Returns a copy of this component with ActionComponent.isDisabled() set to true.

Note: Components in modals cannot be disabled.

Specified by:

asDisabled in interface ActionComponent

Specified by:

asDisabled in interface IDisableable

Returns:

New disabled component instance

See Also:

• ComponentTree.replace(ComponentReplacer)

asEnabled

@Nonnull
default SelectMenu asEnabled()

Description copied from interface: ActionComponent

Returns a copy of this component with ActionComponent.isDisabled() set to false.

Specified by:

asEnabled in interface ActionComponent

Specified by:

asEnabled in interface IDisableable

Returns:

New enabled component instance

See Also:

• ComponentTree.replace(ComponentReplacer)

withUniqueId

@Nonnull
SelectMenu withUniqueId(int uniqueId)

Description copied from interface: Component

Creates a new component with the provided numeric ID.
If no ID is set, Discord will generate IDs incrementally starting from 1 and will not use existing IDs from the same message/modal.

Specified by:

withUniqueId in interface ActionComponent

Specified by:

withUniqueId in interface ActionRowChildComponent

Specified by:

withUniqueId in interface Component

Specified by:

withUniqueId in interface ICustomId

Specified by:

withUniqueId in interface IDisableable

Specified by:

withUniqueId in interface LabelChildComponent

Parameters:

uniqueId - The new ID; must be higher or equal to 1

Returns:

The new component

getCustomId

@Nonnull
String getCustomId()

Description copied from interface: ICustomId

An unique component ID or null.
Some components such as link buttons don't have this.

Custom IDs can contain custom data, this is typically used to pass data between a slash command and your button listener.

While this ID is unique and can be retrieved with ComponentInteraction.getComponentId(), you should use Component.getUniqueId() to identify a component in a single message, such as when replacing components using ComponentTree or IReplaceable.replace(ComponentReplacer).

Specified by:

getCustomId in interface ICustomId

Returns:

The component ID or null if not present

See Also:

• ComponentInteraction.getComponentId()
• Component.getUniqueId()

getPlaceholder

@Nullable
String getPlaceholder()

Placeholder which is displayed when no selections have been made yet.

Returns:

The placeholder or null

getMinValues

int getMinValues()

The minimum amount of values a user has to select.

Returns:

The min values

getMaxValues

int getMaxValues()

The maximum amount of values a user can select at once.

Returns:

The max values

isRequired

@Nullable
Boolean isRequired()

Whether the user must populate this select menu in Modals, or null if not set.

This attribute is completely separate from the value range, for example, you can have an optional select menu with the range set to [2 ; 5], meaning you accept either 0 options, or, at least 2 but at most 5.

Returns:

Whether this menu must be populated, or null

createCopy

@Nonnull
@CheckReturnValue
SelectMenu.Builder<? extends SelectMenu,? extends SelectMenu.Builder<?,?>> createCopy()

Creates a new preconfigured SelectMenu.Builder with the same settings used for this select menu.
This can be useful to create an updated version of this menu without needing to rebuild it from scratch.

Returns:

The SelectMenu.Builder used to create the select menu