Interface SelectMenu
- All Superinterfaces:
ActionComponent,Component,ItemComponent,SerializableData
Represents a select menu in a message.
This is an interactive component and usually located within an
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.
Examples
public void onSlashCommandInteraction(SlashCommandInteractionEvent event) {
if (!event.getName().equals("class")) return;
SelectMenu menu = SelectMenu.create("menu:class")
.setPlaceholder("Choose your class") // shows the placeholder indicating what this menu is for
.setRequireRange(1, 1) // only one can be selected
.addOption("Arcane Mage", "mage-arcane")
.addOption("Fire Mage", "mage-fire")
.addOption("Frost Mage", "mage-frost")
.build();
event.reply("Please pick your class below")
.setEphemeral(true)
.addActionRow(menu)
.queue();
}
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic classA preconfigured builder for the creation of select menus.Nested classes/interfaces inherited from interface net.dv8tion.jda.api.interactions.components.Component
Component.Type -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe maximum length a select menu id can havestatic final intThe maximum amount of options a select menu can havestatic final intThe maximum length a select menu placeholder can have -
Method Summary
Modifier and TypeMethodDescriptiondefault SelectMenuReturns a copy of this component withActionComponent.isDisabled()set to true.default SelectMenuReturns a copy of this component withActionComponent.isDisabled()set to false.static SelectMenu.BuilderCreates a newSelectMenu.Builderfor a select menu with the provided custom id.default SelectMenu.BuilderCreates a new preconfiguredSelectMenu.Builderwith the same settings used for this select menu.static SelectMenu.BuilderfromData(DataObject data) Inverse function forSerializableData.toData()which parses the serialized select menu data.intThe maximum amount of values a user can select at once.intThe minimum amount of values a user has to select.An unmodifiable list of up to 25 available options to choose from.Placeholder which is displayed when no selections have been made yet.default SelectMenuwithDisabled(boolean disabled) Returns a copy of this component withActionComponent.isDisabled()set to the provided value.Methods inherited from interface net.dv8tion.jda.api.interactions.components.ActionComponent
getId, isDisabledMethods inherited from interface net.dv8tion.jda.api.interactions.components.ItemComponent
getMaxPerRow, isMessageCompatible, isModalCompatibleMethods inherited from interface net.dv8tion.jda.api.utils.data.SerializableData
toData
-
Field Details
-
ID_MAX_LENGTH
static final int ID_MAX_LENGTHThe maximum length a select menu id can have- See Also:
-
PLACEHOLDER_MAX_LENGTH
static final int PLACEHOLDER_MAX_LENGTHThe maximum length a select menu placeholder can have- See Also:
-
OPTIONS_MAX_AMOUNT
static final int OPTIONS_MAX_AMOUNTThe maximum amount of options a select menu can have- See Also:
-
-
Method Details
-
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
-
getOptions
An unmodifiable list of up to 25 available options to choose from.- Returns:
- The
SelectOptionsthis menu provides - See Also:
-
asDisabled
Description copied from interface:ActionComponentReturns a copy of this component withActionComponent.isDisabled()set to true.- Specified by:
asDisabledin interfaceActionComponent- Returns:
- New disabled component instance
-
asEnabled
Description copied from interface:ActionComponentReturns a copy of this component withActionComponent.isDisabled()set to false.- Specified by:
asEnabledin interfaceActionComponent- Returns:
- New enabled component instance
-
withDisabled
Description copied from interface:ActionComponentReturns a copy of this component withActionComponent.isDisabled()set to the provided value.- Specified by:
withDisabledin interfaceActionComponent- Parameters:
disabled- True, if this component should be disabled- Returns:
- New enabled/disabled component instance
-
createCopy
Creates a new preconfiguredSelectMenu.Builderwith 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.Builderused to create the select menu
-
create
Creates a newSelectMenu.Builderfor a select menu with the provided custom id.- Parameters:
customId- The id used to identify this menu withActionComponent.getId()for component interactions- Returns:
- The
SelectMenu.Builderused to create the select menu - Throws:
IllegalArgumentException- If the provided id is null, empty, or longer than 100 characters
-
fromData
Inverse function forSerializableData.toData()which parses the serialized select menu data.
Returns aSelectMenu.Builderwhich allows for further configuration.- Parameters:
data- The serialized select menu data- Returns:
- The parsed SelectMenu Builder instance
- Throws:
ParsingException- If the data representation is invalidIllegalArgumentException- If some part of the data has an invalid length or null is provided
-