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

Class StringSelectMenu.Builder

java.lang.Object

net.dv8tion.jda.api.interactions.components.selections.SelectMenu.Builder<StringSelectMenu,StringSelectMenu.Builder>

net.dv8tion.jda.api.interactions.components.selections.StringSelectMenu.Builder

Enclosing interface:

StringSelectMenu

public static class StringSelectMenu.Builder
extends SelectMenu.Builder<StringSelectMenu,StringSelectMenu.Builder>

A preconfigured builder for the creation of string select menus.

Method Summary

Modifier and Type	Method	Description
StringSelectMenu.Builder	addOption(String label, String value)	Adds up to 25 possible options to this select menu.
StringSelectMenu.Builder	addOption(String label, String value, String description)	Adds up to 25 possible options to this select menu.
StringSelectMenu.Builder	addOption(String label, String value, String description, Emoji emoji)	Adds up to 25 possible options to this select menu.
StringSelectMenu.Builder	addOption(String label, String value, Emoji emoji)	Adds up to 25 possible options to this select menu.
StringSelectMenu.Builder	addOptions(Collection<? extends SelectOption> options)	Adds up to 25 possible options to this select menu.
StringSelectMenu.Builder	addOptions(SelectOption... options)	Adds up to 25 possible options to this select menu.
StringSelectMenu	build()	Creates a new StringSelectMenu instance if all requirements are satisfied.
List<SelectOption>	getOptions()	Modifiable list of options currently configured in this builder.
StringSelectMenu.Builder	setDefaultOptions(Collection<? extends SelectOption> values)	Configures which of the currently applied options should be selected by default.
StringSelectMenu.Builder	setDefaultOptions(SelectOption... values)	Configures which of the currently applied options should be selected by default.
StringSelectMenu.Builder	setDefaultValues(String... values)	Configures which of the currently applied options should be selected by default.
StringSelectMenu.Builder	setDefaultValues(Collection<String> values)	Configures which of the currently applied options should be selected by default.

Methods inherited from class net.dv8tion.jda.api.interactions.components.selections.SelectMenu.Builder

getId, getMaxValues, getMinValues, getPlaceholder, isDisabled, setDisabled, setId, setMaxValues, setMinValues, setPlaceholder, setRequiredRange

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

addOptions

@Nonnull
public StringSelectMenu.Builder addOptions(@Nonnull
 SelectOption... options)

Adds up to 25 possible options to this select menu.

Parameters:

options - The SelectOptions to add

Returns:

The same builder instance for chaining

Throws:

IllegalArgumentException - If the total amount of options is greater than 25 or null is provided

See Also:

• SelectOption.of(String, String)

addOptions

@Nonnull
public StringSelectMenu.Builder addOptions(@Nonnull
 Collection<? extends SelectOption> options)

Adds up to 25 possible options to this select menu.

Parameters:

options - The SelectOptions to add

Returns:

The same builder instance for chaining

Throws:

IllegalArgumentException - If the total amount of options is greater than 25 or null is provided

See Also:

• SelectOption.of(String, String)

addOption

@Nonnull
public StringSelectMenu.Builder addOption(@Nonnull
 String label,
 @Nonnull
 String value)

Adds up to 25 possible options to this select menu.

Parameters:

label - The label for the option, up to 100 characters

value - The value for the option used to indicate which option was selected with SelectMenuInteraction.getValues(), up to 100 characters

Returns:

The same builder instance for chaining

Throws:

IllegalArgumentException - If the total amount of options is greater than 25, invalid null is provided, or any of the individual parameter requirements are violated.

addOption

@Nonnull
public StringSelectMenu.Builder addOption(@Nonnull
 String label,
 @Nonnull
 String value,
 @Nonnull
 Emoji emoji)

Adds up to 25 possible options to this select menu.

Parameters:

label - The label for the option, up to 100 characters

value - The value for the option used to indicate which option was selected with SelectMenuInteraction.getValues(), up to 100 characters

emoji - The Emoji shown next to this option, or null

Returns:

The same builder instance for chaining

Throws:

IllegalArgumentException - If the total amount of options is greater than 25, invalid null is provided, or any of the individual parameter requirements are violated.

addOption

@Nonnull
public StringSelectMenu.Builder addOption(@Nonnull
 String label,
 @Nonnull
 String value,
 @Nonnull
 String description)

Adds up to 25 possible options to this select menu.

Parameters:

label - The label for the option, up to 100 characters

value - The value for the option used to indicate which option was selected with SelectMenuInteraction.getValues(), up to 100 characters

description - The description explaining the meaning of this option in more detail, up to 50 characters

Returns:

The same builder instance for chaining

Throws:

IllegalArgumentException - If the total amount of options is greater than 25, invalid null is provided, or any of the individual parameter requirements are violated.

addOption

@Nonnull
public StringSelectMenu.Builder addOption(@Nonnull
 String label,
 @Nonnull
 String value,
 @Nullable
 String description,
 @Nullable
 Emoji emoji)

Adds up to 25 possible options to this select menu.

Parameters:

label - The label for the option, up to 100 characters

value - The value for the option used to indicate which option was selected with SelectMenuInteraction.getValues(), up to 100 characters

description - The description explaining the meaning of this option in more detail, up to 50 characters

emoji - The Emoji shown next to this option, or null

Returns:

The same builder instance for chaining

Throws:

IllegalArgumentException - If the total amount of options is greater than 25, invalid null is provided, or any of the individual parameter requirements are violated.

getOptions

@Nonnull
public List<SelectOption> getOptions()

Modifiable list of options currently configured in this builder.

Returns:

The list of SelectOptions

setDefaultValues

@Nonnull
public StringSelectMenu.Builder setDefaultValues(@Nonnull
 Collection<String> values)

Configures which of the currently applied options should be selected by default.

Parameters:

values - The option values

Returns:

The same builder instance for chaining

Throws:

IllegalArgumentException - If null is provided

setDefaultValues

@Nonnull
public StringSelectMenu.Builder setDefaultValues(@Nonnull
 String... values)

Configures which of the currently applied options should be selected by default.

Parameters:

values - The option values

Returns:

The same builder instance for chaining

Throws:

IllegalArgumentException - If null is provided

setDefaultOptions

@Nonnull
public StringSelectMenu.Builder setDefaultOptions(@Nonnull
 Collection<? extends SelectOption> values)

Configures which of the currently applied options should be selected by default.

Parameters:

values - The SelectOptions

Returns:

The same builder instance for chaining

Throws:

IllegalArgumentException - If null is provided

setDefaultOptions

@Nonnull
public StringSelectMenu.Builder setDefaultOptions(@Nonnull
 SelectOption... values)

Configures which of the currently applied options should be selected by default.

Parameters:

values - The SelectOptions

Returns:

The same builder instance for chaining

Throws:

IllegalArgumentException - If null is provided

build

@Nonnull
public StringSelectMenu build()

Creates a new StringSelectMenu instance if all requirements are satisfied.
A select menu may not have more than 25 options at once.

The values for SelectMenu.Builder.setMinValues(int) and SelectMenu.Builder.setMaxValues(int) are bounded by the length of getOptions(). This means they will automatically be adjusted to not be greater than getOptions().size(). You can use this to your advantage to easily make a select menu with unlimited options by setting it to SelectMenu.OPTIONS_MAX_AMOUNT.

Specified by:

build in class SelectMenu.Builder<StringSelectMenu,StringSelectMenu.Builder>

Returns:

The new StringSelectMenu instance

Throws:

IllegalArgumentException -

• If SelectMenu.Builder.getMinValues() is greater than SelectMenu.Builder.getMaxValues()
• If no options are provided
• If more than 25 options are provided