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

Class SelectMenuBuilder

java.lang.Object

org.javacord.api.entity.message.component.SelectMenuBuilder

All Implemented Interfaces:

ComponentBuilder, LowLevelComponentBuilder

public class SelectMenuBuilder
extends java.lang.Object
implements LowLevelComponentBuilder

Constructor Summary

Constructors

Constructor	Description
SelectMenuBuilder(ComponentType type, java.lang.String customId)	Create a new SelectMenuBuilder.

Method Summary

Modifier and Type	Method	Description
SelectMenuBuilder	addChannelType(ChannelType channelType)	Add a channel type to the select menu.
SelectMenuBuilder	addChannelTypes(java.lang.Iterable<ChannelType> channelTypes)	Adds all given channel types to the select menu.
SelectMenuBuilder	addOption(SelectMenuOption selectMenuOption)	Add an option to the select menu.
SelectMenuBuilder	addOptions(java.util.List<SelectMenuOption> selectMenuOptions)	Adds all given options to the select menu.
SelectMenu	build()	Creates a SelectMenu instance with the given values.
SelectMenuBuilder	copy(SelectMenu selectMenu)	Create a copy of an existing select menu.
SelectMenuBuilderDelegate	getDelegate()	Get the builder delegate.
ComponentType	getType()	Get the type of component being built.
SelectMenuBuilder	removeAllOptions()	Removes all options from the select menu.
SelectMenuBuilder	removeOption(SelectMenuOption selectMenuOption)	Remove an option from the select menu.
SelectMenuBuilder	setCustomId(java.lang.String customId)	Set the custom ID for the select menu.
SelectMenuBuilder	setDisabled(boolean isDisabled)	Set if the select menu should be disabled.
SelectMenuBuilder	setMaximumValues(int maximumValues)	Set the maximum amount of options which can be selected.
SelectMenuBuilder	setMinimumValues(int minimumValues)	Set the minimum amount of options which must be selected.
SelectMenuBuilder	setPlaceholder(java.lang.String placeholder)	Set the placeholder for the select menu.

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectMenuBuilder

public SelectMenuBuilder(ComponentType type,
                         java.lang.String customId)

Create a new SelectMenuBuilder.

Parameters:

type - The type of SelectMenu to create.

customId - The custom id of the SelectMenu.

Method Detail

getType

public ComponentType getType()

Description copied from interface: ComponentBuilder

Get the type of component being built.

Specified by:

getType in interface ComponentBuilder

Returns:

The type of component being built.

getDelegate

public SelectMenuBuilderDelegate getDelegate()

Description copied from interface: ComponentBuilder

Get the builder delegate.

Specified by:

getDelegate in interface ComponentBuilder

Returns:

The builder delegate.

setPlaceholder

public SelectMenuBuilder setPlaceholder(java.lang.String placeholder)

Set the placeholder for the select menu.

Parameters:

placeholder - The placeholder.

Returns:

The builder.

setMinimumValues

public SelectMenuBuilder setMinimumValues(int minimumValues)

Set the minimum amount of options which must be selected.

Parameters:

minimumValues - The minimum values.

Returns:

The builder.

setMaximumValues

public SelectMenuBuilder setMaximumValues(int maximumValues)

Set the maximum amount of options which can be selected.

Parameters:

maximumValues - The maximum values.

Returns:

The builder.

setCustomId

public SelectMenuBuilder setCustomId(java.lang.String customId)

Set the custom ID for the select menu.

Parameters:

customId - The custom ID.

Returns:

The builder.

addChannelType

public SelectMenuBuilder addChannelType(ChannelType channelType)

Add a channel type to the select menu.

Only usable with ComponentType.SELECT_MENU_CHANNEL.

Parameters:

channelType - The channel type to add.

Returns:

The builder.

addChannelTypes

public SelectMenuBuilder addChannelTypes(java.lang.Iterable<ChannelType> channelTypes)

Adds all given channel types to the select menu.

Only usable with ComponentType.SELECT_MENU_CHANNEL.

Parameters:

channelTypes - The channel types to add.

Returns:

The builder.

addOption

public SelectMenuBuilder addOption(SelectMenuOption selectMenuOption)

Add an option to the select menu.

Only usable with ComponentType.SELECT_MENU_STRING.

Parameters:

selectMenuOption - The option.

Returns:

The builder.

removeOption

public SelectMenuBuilder removeOption(SelectMenuOption selectMenuOption)

Remove an option from the select menu.

Only usable with ComponentType.SELECT_MENU_STRING.

Parameters:

selectMenuOption - The option.

Returns:

The builder.

addOptions

public SelectMenuBuilder addOptions(java.util.List<SelectMenuOption> selectMenuOptions)

Adds all given options to the select menu.

Only usable with ComponentType.SELECT_MENU_STRING.

Parameters:

selectMenuOptions - The options.

Returns:

The builder.

removeAllOptions

public SelectMenuBuilder removeAllOptions()

Removes all options from the select menu.

Only usable with ComponentType.SELECT_MENU_STRING.

Returns:

The builder.

setDisabled

public SelectMenuBuilder setDisabled(boolean isDisabled)

Set if the select menu should be disabled.

Parameters:

isDisabled - Is disabled.

Returns:

The builder.

copy

public SelectMenuBuilder copy(SelectMenu selectMenu)

Create a copy of an existing select menu.

Parameters:

selectMenu - The select menu to copy.

Returns:

The select menu builder.

build

public SelectMenu build()

Creates a SelectMenu instance with the given values.

Returns:

The created select menu instance.