MessageSelectMenuBuilder¶
Inherits: MessageComponentBuilder < Reference < Object
Description¶
Helper class to build message select menus.
- Select menus must be sent inside an Action Row.
- An Action Row can contain only one select menu.
- An Action Row containing a select menu cannot also contain buttons.
Methods¶
return type | signature |
---|---|
MessageSelectMenuBuilder | add_option ( MessageSelectOptionBuilder option ) |
MessageSelectMenuBuilder | with_placeholder ( String placeholder ) |
MessageSelectMenuBuilder | min_values ( int min_values ) |
MessageSelectMenuBuilder | max_values ( int max_values ) |
MessageSelectMenuBuilder | disabled ( bool value ) |
Constants¶
-
int MAX_OPTIONS = 25
Maximum number of options in a select menu.
-
int PLACEHOLDER_MAX_LENGTH = 150
Maximum number of characters in a text input placeholder.
-
int MAX_VALUES = 25
Maximum number of items that can be chosen.
-
int MIN_VALUES = 0
Minimum number of items that can be chosen.
Method Descriptions¶
-
MessageSelectMenuBuilder MessageSelectMenuBuilder ( String custom_id )
Constructs a new
MessageSelectMenuBuilder
instance with acustom_id
.
-
MessageSelectMenuBuilder add_option ( MessageSelectOptionBuilder option )
Adds an
option
to the select menu.
-
MessageSelectMenuBuilder with_placeholder ( String placeholder )
Sets a placeholder text to show if nothing is selected.
-
MessageSelectMenuBuilder min_values ( int min_values )
Sets the minimum number of items that must be chosen, default to
1
.
-
MessageSelectMenuBuilder max_values ( int max_values )
Sets the maximum number of items that can be chosen, default to
1
.
-
MessageSelectMenuBuilder disabled ( bool value )
Disables the select menu.