Interface StringSelectMenu
- All Superinterfaces:
ActionComponent
,Component
,ItemComponent
,SelectMenu
,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;
StringSelectMenu menu = StringSelectMenu.create("menu:class")
.setPlaceholder("Choose your class") // shows the placeholder indicating what this menu is for
.setRequiredRange(1, 1) // exactly one must be selected
.addOption("Arcane Mage", "mage-arcane")
.addOption("Fire Mage", "mage-fire")
.addOption("Frost Mage", "mage-frost")
.setDefaultValues("mage-fire") // default to fire mage
.build();
event.reply("Please pick your class below")
.setEphemeral(true)
.addActionRow(menu)
.queue();
}
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic class
A preconfigured builder for the creation of string select menus.Nested classes/interfaces inherited from interface net.dv8tion.jda.api.interactions.components.Component
Component.Type
-
Field Summary
Fields inherited from interface net.dv8tion.jda.api.interactions.components.selections.SelectMenu
ID_MAX_LENGTH, OPTIONS_MAX_AMOUNT, PLACEHOLDER_MAX_LENGTH
-
Method Summary
Modifier and TypeMethodDescriptiondefault StringSelectMenu
Returns a copy of this component withActionComponent.isDisabled()
set to true.default StringSelectMenu
Returns a copy of this component withActionComponent.isDisabled()
set to false.static StringSelectMenu.Builder
Creates a newStringSelectMenu.Builder
for a select menu with the provided custom id.default StringSelectMenu.Builder
Creates a new preconfiguredStringSelectMenu.Builder
with the same settings used for this select menu.An unmodifiable list of up to 25 available options to choose from.default StringSelectMenu
withDisabled
(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, isDisabled
Methods inherited from interface net.dv8tion.jda.api.interactions.components.ItemComponent
getMaxPerRow, isMessageCompatible, isModalCompatible
Methods inherited from interface net.dv8tion.jda.api.interactions.components.selections.SelectMenu
getMaxValues, getMinValues, getPlaceholder
Methods inherited from interface net.dv8tion.jda.api.utils.data.SerializableData
toData
-
Method Details
-
asDisabled
Description copied from interface:ActionComponent
Returns a copy of this component withActionComponent.isDisabled()
set to true.- Specified by:
asDisabled
in interfaceActionComponent
- Returns:
- New disabled component instance
-
asEnabled
Description copied from interface:ActionComponent
Returns a copy of this component withActionComponent.isDisabled()
set to false.- Specified by:
asEnabled
in interfaceActionComponent
- Returns:
- New enabled component instance
-
withDisabled
Description copied from interface:ActionComponent
Returns a copy of this component withActionComponent.isDisabled()
set to the provided value.- Specified by:
withDisabled
in interfaceActionComponent
- Parameters:
disabled
- True, if this component should be disabled- Returns:
- New enabled/disabled component instance
-
getOptions
An unmodifiable list of up to 25 available options to choose from.- Returns:
- The
SelectOptions
this menu provides - See Also:
-
createCopy
Creates a new preconfiguredStringSelectMenu.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.- Specified by:
createCopy
in interfaceSelectMenu
- Returns:
- The
StringSelectMenu.Builder
used to create the select menu
-
create
Creates a newStringSelectMenu.Builder
for a select menu with the provided custom id.- Parameters:
customId
- The id used to identify this menu withActionComponent.getId()
for component interactions- Returns:
- The
StringSelectMenu.Builder
used to create the select menu - Throws:
IllegalArgumentException
- If the provided id is null, empty, or longer than 100 characters
-