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

Interface SelectMenu

All Superinterfaces:

Component, LowLevelComponent

public interface SelectMenu
extends LowLevelComponent

Method Summary

Modifier and Type	Method	Description
static SelectMenu	create(String customId, String placeholder, int minimumValues, int maximumValues, List<SelectMenuOption> options)	Creates a new select menu with the given values.
static SelectMenu	create(String customId, String placeholder, int minimumValues, int maximumValues, List<SelectMenuOption> options, boolean isDisabled)	Creates a new select menu with the given values.
static SelectMenu	create(String customId, String placeholder, List<SelectMenuOption> options)	Creates a new select menu with the given values.
static SelectMenu	create(String customId, String placeholder, List<SelectMenuOption> options, boolean isDisabled)	Creates a new select menu with the given values.
static SelectMenu	create(String customId, List<SelectMenuOption> options)	Creates a new select menu with the given values.
static SelectMenu	create(String customId, List<SelectMenuOption> options, boolean isDisabled)	Creates a new select menu with the given values.
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.
List<SelectMenuOption>	getOptions()	Get the select menu's options.
Optional<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

Method Detail

getPlaceholder

Optional<String> getPlaceholder()

Get the select menu's placeholder id.

Returns:

The select menu's placeholder id.

getCustomId

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

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

static SelectMenu create(String customId,
                         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.

create

static SelectMenu create(String customId,
                         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.

create

static SelectMenu create(String customId,
                         String placeholder,
                         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.

create

static SelectMenu create(String customId,
                         String placeholder,
                         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.

create

static SelectMenu create(String customId,
                         String placeholder,
                         int minimumValues,
                         int maximumValues,
                         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.

create

static SelectMenu create(String customId,
                         String placeholder,
                         int minimumValues,
                         int maximumValues,
                         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.