Package org.javacord.api.entity.message.component

Interface SelectMenu

All Superinterfaces:

Component, LowLevelComponent, Specializable<LowLevelComponent>

public interface SelectMenu
extends LowLevelComponent

Method Summary

Modifier and Type	Method	Description
static SelectMenu	create(java.lang.String customId, java.lang.String placeholder, int minimumValues, int maximumValues, java.util.List<SelectMenuOption> options)	Deprecated. Use createStringMenu(String, String, int, int, List) instead.
static SelectMenu	create(java.lang.String customId, java.lang.String placeholder, int minimumValues, int maximumValues, java.util.List<SelectMenuOption> options, boolean isDisabled)	Deprecated. Use createStringMenu(String, String, int, int, List, boolean) instead.
static SelectMenu	create(java.lang.String customId, java.lang.String placeholder, java.util.List<SelectMenuOption> options)	Deprecated. Use createStringMenu(String, String, List) )} instead.
static SelectMenu	create(java.lang.String customId, java.lang.String placeholder, java.util.List<SelectMenuOption> options, boolean isDisabled)	Deprecated. Use createStringMenu(String, String, List, boolean) instead.
static SelectMenu	create(java.lang.String customId, java.util.List<SelectMenuOption> options)	Deprecated. Use createStringMenu(String, List) instead.
static SelectMenu	create(java.lang.String customId, java.util.List<SelectMenuOption> options, boolean isDisabled)	Deprecated. Use createStringMenu(String, List, boolean) instead.
static SelectMenu	createChannelMenu(java.lang.String customId)	Creates a new select menu with the given values.
static SelectMenu	createChannelMenu(java.lang.String customId, java.lang.Iterable<ChannelType> channelTypes)	Creates a new select menu with the given values.
static SelectMenu	createChannelMenu(java.lang.String customId, java.lang.Iterable<ChannelType> channelTypes, boolean isDisabled)	Creates a new select menu with the given values.
static SelectMenu	createChannelMenu(java.lang.String customId, java.lang.String placeholder, int minimumValues, int maximumValues, java.lang.Iterable<ChannelType> channelTypes)	Creates a new select menu with the given values.
static SelectMenu	createChannelMenu(java.lang.String customId, java.lang.String placeholder, int minimumValues, int maximumValues, java.lang.Iterable<ChannelType> channelTypes, boolean isDisabled)	Creates a new select menu with the given values.
static SelectMenu	createChannelMenu(java.lang.String customId, java.lang.String placeholder, java.lang.Iterable<ChannelType> channelTypes)	Creates a new select menu with the given values.
static SelectMenu	createChannelMenu(java.lang.String customId, java.lang.String placeholder, java.lang.Iterable<ChannelType> channelTypes, boolean isDisabled)	Creates a new select menu with the given values.
static SelectMenu	createMentionableMenu(java.lang.String customId)	Creates a new select menu with the given values.
static SelectMenu	createMentionableMenu(java.lang.String customId, boolean isDisabled)	Creates a new select menu with the given values.
static SelectMenu	createMentionableMenu(java.lang.String customId, java.lang.String placeholder)	Creates a new select menu with the given values.
static SelectMenu	createMentionableMenu(java.lang.String customId, java.lang.String placeholder, boolean isDisabled)	Creates a new select menu with the given values.
static SelectMenu	createMentionableMenu(java.lang.String customId, java.lang.String placeholder, int minimumValues, int maximumValues)	Creates a new select menu with the given values.
static SelectMenu	createMentionableMenu(java.lang.String customId, java.lang.String placeholder, int minimumValues, int maximumValues, boolean isDisabled)	Creates a new select menu with the given values.
static SelectMenu	createRoleMenu(java.lang.String customId)	Creates a new select menu with the given values.
static SelectMenu	createRoleMenu(java.lang.String customId, boolean isDisabled)	Creates a new select menu with the given values.
static SelectMenu	createRoleMenu(java.lang.String customId, java.lang.String placeholder)	Creates a new select menu with the given values.
static SelectMenu	createRoleMenu(java.lang.String customId, java.lang.String placeholder, boolean isDisabled)	Creates a new select menu with the given values.
static SelectMenu	createRoleMenu(java.lang.String customId, java.lang.String placeholder, int minimumValues, int maximumValues)	Creates a new select menu with the given values.
static SelectMenu	createRoleMenu(java.lang.String customId, java.lang.String placeholder, int minimumValues, int maximumValues, boolean isDisabled)	Creates a new select menu with the given values.
static SelectMenu	createStringMenu(java.lang.String customId, java.lang.String placeholder, int minimumValues, int maximumValues, java.util.List<SelectMenuOption> options)	Creates a new select menu with the given values.
static SelectMenu	createStringMenu(java.lang.String customId, java.lang.String placeholder, int minimumValues, int maximumValues, java.util.List<SelectMenuOption> options, boolean isDisabled)	Creates a new select menu with the given values.
static SelectMenu	createStringMenu(java.lang.String customId, java.lang.String placeholder, java.util.List<SelectMenuOption> options)	Creates a new select menu with the given values.
static SelectMenu	createStringMenu(java.lang.String customId, java.lang.String placeholder, java.util.List<SelectMenuOption> options, boolean isDisabled)	Creates a new select menu with the given values.
static SelectMenu	createStringMenu(java.lang.String customId, java.util.List<SelectMenuOption> options)	Creates a new select menu with the given values.
static SelectMenu	createStringMenu(java.lang.String customId, java.util.List<SelectMenuOption> options, boolean isDisabled)	Creates a new select menu with the given values.
static SelectMenu	createUserMenu(java.lang.String customId)	Creates a new select menu with the given values.
static SelectMenu	createUserMenu(java.lang.String customId, boolean isDisabled)	Creates a new select menu with the given values.
static SelectMenu	createUserMenu(java.lang.String customId, java.lang.String placeholder)	Creates a new select menu with the given values.
static SelectMenu	createUserMenu(java.lang.String customId, java.lang.String placeholder, boolean isDisabled)	Creates a new select menu with the given values.
static SelectMenu	createUserMenu(java.lang.String customId, java.lang.String placeholder, int minimumValues, int maximumValues)	Creates a new select menu with the given values.
static SelectMenu	createUserMenu(java.lang.String customId, java.lang.String placeholder, int minimumValues, int maximumValues, boolean isDisabled)	Creates a new select menu with the given values.
java.util.EnumSet<ChannelType>	getChannelTypes()	Get the channel types of this select menu if it's of type ComponentType.SELECT_MENU_CHANNEL.
java.lang.String	getCustomId()	Get the select menu's custom id.
int	getMaximumValues()	Gets the maximum amount of options which can be selected.
int	getMinimumValues()	Gets the minimum amount of options which must be selected.
java.util.List<SelectMenuOption>	getOptions()	Get the select menu's options.
java.util.Optional<java.lang.String>	getPlaceholder()	Get the select menu's placeholder id.
boolean	isDisabled()	If the select menu is disabled.

Methods inherited from interface org.javacord.api.entity.message.component.Component

getType

Methods inherited from interface org.javacord.api.entity.message.component.LowLevelComponent

asButton, asSelectMenu, asTextInput, isButton, isSelectMenu, isTextInput

Methods inherited from interface org.javacord.api.util.Specializable

as

Method Detail

getChannelTypes

java.util.EnumSet<ChannelType> getChannelTypes()

Get the channel types of this select menu if it's of type ComponentType.SELECT_MENU_CHANNEL.

Returns:

The channel types if this select menu is restricted to any.

getPlaceholder

java.util.Optional<java.lang.String> getPlaceholder()

Get the select menu's placeholder id.

Returns:

The select menu's placeholder id.

getCustomId

java.lang.String getCustomId()

Get the select menu's custom id.

Returns:

The select menu's custom id.

getMinimumValues

int getMinimumValues()

Gets the minimum amount of options which must be selected.

Returns:

The select menu's minimum values.

getMaximumValues

int getMaximumValues()

Gets the maximum amount of options which can be selected.

Returns:

The select menu's maximum values.

getOptions

java.util.List<SelectMenuOption> getOptions()

Get the select menu's options.

Returns:

The select menu's options.

isDisabled

boolean isDisabled()

If the select menu is disabled.

Returns:

Is disabled.

create

@Deprecated
static SelectMenu create(java.lang.String customId,
                         java.util.List<SelectMenuOption> options)

Deprecated.

Use createStringMenu(String, List) instead.

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

options - The select menu options.

Returns:

The created select menu.

create

@Deprecated
static SelectMenu create(java.lang.String customId,
                         java.util.List<SelectMenuOption> options,
                         boolean isDisabled)

Deprecated.

Use createStringMenu(String, List, boolean) instead.

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

options - The select menu options.

isDisabled - Set if the menu should be disabled.

Returns:

The created select menu.

create

@Deprecated
static SelectMenu create(java.lang.String customId,
                         java.lang.String placeholder,
                         java.util.List<SelectMenuOption> options)

Deprecated.

Use createStringMenu(String, String, List) )} instead.

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu.

options - The select menu options.

Returns:

The created select menu.

create

@Deprecated
static SelectMenu create(java.lang.String customId,
                         java.lang.String placeholder,
                         java.util.List<SelectMenuOption> options,
                         boolean isDisabled)

Deprecated.

Use createStringMenu(String, String, List, boolean) instead.

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu.

options - The select menu options.

isDisabled - Set if the menu should be disabled.

Returns:

The created select menu.

create

@Deprecated
static SelectMenu create(java.lang.String customId,
                         java.lang.String placeholder,
                         int minimumValues,
                         int maximumValues,
                         java.util.List<SelectMenuOption> options)

Deprecated.

Use createStringMenu(String, String, int, int, List) instead.

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu

minimumValues - The minimum amount of options which must be selected.

maximumValues - The maximum amount of options which can be selected.

options - The select menu options.

Returns:

The created select menu.

create

@Deprecated
static SelectMenu create(java.lang.String customId,
                         java.lang.String placeholder,
                         int minimumValues,
                         int maximumValues,
                         java.util.List<SelectMenuOption> options,
                         boolean isDisabled)

Deprecated.

Use createStringMenu(String, String, int, int, List, boolean) instead.

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu

minimumValues - The minimum amount of options which must be selected.

maximumValues - The maximum amount of options which can be selected.

options - The select menu options.

isDisabled - Set if the menu should be disabled.

Returns:

The created select menu.

createStringMenu

static SelectMenu createStringMenu(java.lang.String customId,
                                   java.util.List<SelectMenuOption> options)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

options - The select menu options.

Returns:

The created select menu.

createStringMenu

static SelectMenu createStringMenu(java.lang.String customId,
                                   java.util.List<SelectMenuOption> options,
                                   boolean isDisabled)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

options - The select menu options.

isDisabled - Set if the menu should be disabled.

Returns:

The created select menu.

createStringMenu

static SelectMenu createStringMenu(java.lang.String customId,
                                   java.lang.String placeholder,
                                   java.util.List<SelectMenuOption> options)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu.

options - The select menu options.

Returns:

The created select menu.

createStringMenu

static SelectMenu createStringMenu(java.lang.String customId,
                                   java.lang.String placeholder,
                                   java.util.List<SelectMenuOption> options,
                                   boolean isDisabled)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu.

options - The select menu options.

isDisabled - Set if the menu should be disabled.

Returns:

The created select menu.

createStringMenu

static SelectMenu createStringMenu(java.lang.String customId,
                                   java.lang.String placeholder,
                                   int minimumValues,
                                   int maximumValues,
                                   java.util.List<SelectMenuOption> options)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu

minimumValues - The minimum amount of options which must be selected.

maximumValues - The maximum amount of options which can be selected.

options - The select menu options.

Returns:

The created select menu.

createStringMenu

static SelectMenu createStringMenu(java.lang.String customId,
                                   java.lang.String placeholder,
                                   int minimumValues,
                                   int maximumValues,
                                   java.util.List<SelectMenuOption> options,
                                   boolean isDisabled)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu

minimumValues - The minimum amount of options which must be selected.

maximumValues - The maximum amount of options which can be selected.

options - The select menu options.

isDisabled - Set if the menu should be disabled.

Returns:

The created select menu.

createChannelMenu

static SelectMenu createChannelMenu(java.lang.String customId)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

Returns:

The created select menu.

createChannelMenu

static SelectMenu createChannelMenu(java.lang.String customId,
                                    java.lang.Iterable<ChannelType> channelTypes)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

channelTypes - The channel types which should be available in the select menu.

Returns:

The created select menu.

createChannelMenu

static SelectMenu createChannelMenu(java.lang.String customId,
                                    java.lang.Iterable<ChannelType> channelTypes,
                                    boolean isDisabled)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

channelTypes - The channel types which should be available in the select menu.

isDisabled - Set if the menu should be disabled.

Returns:

The created select menu.

createChannelMenu

static SelectMenu createChannelMenu(java.lang.String customId,
                                    java.lang.String placeholder,
                                    java.lang.Iterable<ChannelType> channelTypes)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu.

channelTypes - The channel types which should be available in the select menu.

Returns:

The created select menu.

createChannelMenu

static SelectMenu createChannelMenu(java.lang.String customId,
                                    java.lang.String placeholder,
                                    java.lang.Iterable<ChannelType> channelTypes,
                                    boolean isDisabled)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu.

channelTypes - The channel types which should be available in the select menu.

isDisabled - Set if the menu should be disabled.

Returns:

The created select menu.

createChannelMenu

static SelectMenu createChannelMenu(java.lang.String customId,
                                    java.lang.String placeholder,
                                    int minimumValues,
                                    int maximumValues,
                                    java.lang.Iterable<ChannelType> channelTypes)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu

minimumValues - The minimum amount of options which must be selected.

maximumValues - The maximum amount of options which can be selected.

channelTypes - The channel types which should be available in the select menu.

Returns:

The created select menu.

createChannelMenu

static SelectMenu createChannelMenu(java.lang.String customId,
                                    java.lang.String placeholder,
                                    int minimumValues,
                                    int maximumValues,
                                    java.lang.Iterable<ChannelType> channelTypes,
                                    boolean isDisabled)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu

minimumValues - The minimum amount of options which must be selected.

maximumValues - The maximum amount of options which can be selected.

channelTypes - The channel types which should be available in the select menu.

isDisabled - Set if the menu should be disabled.

Returns:

The created select menu.

createRoleMenu

static SelectMenu createRoleMenu(java.lang.String customId)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

Returns:

The created select menu.

createRoleMenu

static SelectMenu createRoleMenu(java.lang.String customId,
                                 boolean isDisabled)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

isDisabled - Set if the menu should be disabled.

Returns:

The created select menu.

createRoleMenu

static SelectMenu createRoleMenu(java.lang.String customId,
                                 java.lang.String placeholder)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu.

Returns:

The created select menu.

createRoleMenu

static SelectMenu createRoleMenu(java.lang.String customId,
                                 java.lang.String placeholder,
                                 boolean isDisabled)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu.

isDisabled - Set if the menu should be disabled.

Returns:

The created select menu.

createRoleMenu

static SelectMenu createRoleMenu(java.lang.String customId,
                                 java.lang.String placeholder,
                                 int minimumValues,
                                 int maximumValues)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu

minimumValues - The minimum amount of options which must be selected.

maximumValues - The maximum amount of options which can be selected.

Returns:

The created select menu.

createRoleMenu

static SelectMenu createRoleMenu(java.lang.String customId,
                                 java.lang.String placeholder,
                                 int minimumValues,
                                 int maximumValues,
                                 boolean isDisabled)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu

minimumValues - The minimum amount of options which must be selected.

maximumValues - The maximum amount of options which can be selected.

isDisabled - Set if the menu should be disabled.

Returns:

The created select menu.

createMentionableMenu

static SelectMenu createMentionableMenu(java.lang.String customId)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

Returns:

The created select menu.

createMentionableMenu

static SelectMenu createMentionableMenu(java.lang.String customId,
                                        boolean isDisabled)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

isDisabled - Set if the menu should be disabled.

Returns:

The created select menu.

createMentionableMenu

static SelectMenu createMentionableMenu(java.lang.String customId,
                                        java.lang.String placeholder)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu.

Returns:

The created select menu.

createMentionableMenu

static SelectMenu createMentionableMenu(java.lang.String customId,
                                        java.lang.String placeholder,
                                        boolean isDisabled)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu.

isDisabled - Set if the menu should be disabled.

Returns:

The created select menu.

createMentionableMenu

static SelectMenu createMentionableMenu(java.lang.String customId,
                                        java.lang.String placeholder,
                                        int minimumValues,
                                        int maximumValues)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu

minimumValues - The minimum amount of options which must be selected.

maximumValues - The maximum amount of options which can be selected.

Returns:

The created select menu.

createMentionableMenu

static SelectMenu createMentionableMenu(java.lang.String customId,
                                        java.lang.String placeholder,
                                        int minimumValues,
                                        int maximumValues,
                                        boolean isDisabled)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu

minimumValues - The minimum amount of options which must be selected.

maximumValues - The maximum amount of options which can be selected.

isDisabled - Set if the menu should be disabled.

Returns:

The created select menu.

createUserMenu

static SelectMenu createUserMenu(java.lang.String customId)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

Returns:

The created select menu.

createUserMenu

static SelectMenu createUserMenu(java.lang.String customId,
                                 boolean isDisabled)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

isDisabled - Set if the menu should be disabled.

Returns:

The created select menu.

createUserMenu

static SelectMenu createUserMenu(java.lang.String customId,
                                 java.lang.String placeholder)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu.

Returns:

The created select menu.

createUserMenu

static SelectMenu createUserMenu(java.lang.String customId,
                                 java.lang.String placeholder,
                                 boolean isDisabled)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu.

isDisabled - Set if the menu should be disabled.

Returns:

The created select menu.

createUserMenu

static SelectMenu createUserMenu(java.lang.String customId,
                                 java.lang.String placeholder,
                                 int minimumValues,
                                 int maximumValues)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu

minimumValues - The minimum amount of options which must be selected.

maximumValues - The maximum amount of options which can be selected.

Returns:

The created select menu.

createUserMenu

static SelectMenu createUserMenu(java.lang.String customId,
                                 java.lang.String placeholder,
                                 int minimumValues,
                                 int maximumValues,
                                 boolean isDisabled)

Creates a new select menu with the given values.

Parameters:

customId - The custom ID for the select menu.

placeholder - The placeholder for the select menu

minimumValues - The minimum amount of options which must be selected.

maximumValues - The maximum amount of options which can be selected.

isDisabled - Set if the menu should be disabled.

Returns:

The created select menu.