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

Class EntitySelectMenu.Builder

java.lang.Object

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

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

Enclosing interface:

EntitySelectMenu

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

A preconfigured builder for the creation of entity select menus.

Method Summary

Modifier and Type	Method	Description
EntitySelectMenu	build()	Creates a new EntitySelectMenu instance if all requirements are satisfied.
EntitySelectMenu.Builder	setChannelTypes(Collection<ChannelType> types)	The ChannelTypes that should be supported by this menu.
EntitySelectMenu.Builder	setChannelTypes(ChannelType... types)	The ChannelTypes that should be supported by this menu.
EntitySelectMenu.Builder	setDefaultValues(Collection<? extends EntitySelectMenu.DefaultValue> values)	The default values that will be shown to the user.
EntitySelectMenu.Builder	setDefaultValues(EntitySelectMenu.DefaultValue... values)	The default values that will be shown to the user.
EntitySelectMenu.Builder	setEntityTypes(Collection<EntitySelectMenu.SelectTarget> types)	The SelectTargets that should be supported by this menu.
EntitySelectMenu.Builder	setEntityTypes(EntitySelectMenu.SelectTarget type, EntitySelectMenu.SelectTarget... types)	The SelectTargets that should be supported by this menu.

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

setEntityTypes

@Nonnull
public EntitySelectMenu.Builder setEntityTypes(@Nonnull
 Collection<EntitySelectMenu.SelectTarget> types)

The SelectTargets that should be supported by this menu.

Parameters:

types - The supported SelectTargets (1-2)

Returns:

The current Builder instance

Throws:

IllegalArgumentException - If the provided targets are null, empty, or invalid.

setEntityTypes

@Nonnull
public EntitySelectMenu.Builder setEntityTypes(@Nonnull
 EntitySelectMenu.SelectTarget type,
 @Nonnull
 EntitySelectMenu.SelectTarget... types)

The SelectTargets that should be supported by this menu.

Parameters:

type - The first supported EntitySelectMenu.SelectTarget

types - Additional supported SelectTargets

Returns:

The current Builder instance

Throws:

IllegalArgumentException - If the provided targets are null or invalid.

setChannelTypes

@Nonnull
public EntitySelectMenu.Builder setChannelTypes(@Nonnull
 Collection<ChannelType> types)

The ChannelTypes that should be supported by this menu.
This is only relevant for menus that allow CHANNEL targets.

Parameters:

types - The supported ChannelTypes (empty to allow all types)

Returns:

The current Builder instance

Throws:

IllegalArgumentException - If the provided types are null or not guild types

setChannelTypes

@Nonnull
public EntitySelectMenu.Builder setChannelTypes(@Nonnull
 ChannelType... types)

The ChannelTypes that should be supported by this menu.
This is only relevant for menus that allow CHANNEL targets.

Parameters:

types - The supported ChannelTypes (empty to allow all types)

Returns:

The current Builder instance

Throws:

IllegalArgumentException - If the provided types are null or not guild types

setDefaultValues

@Nonnull
public EntitySelectMenu.Builder setDefaultValues(@Nonnull
 EntitySelectMenu.DefaultValue... values)

The default values that will be shown to the user.

Parameters:

values - The default values (up to 25)

Returns:

The current Builder instance

Throws:

IllegalArgumentException - If null is provided, more than 25 values are provided, or any of the value types is incompatible with the configured entity types.

setDefaultValues

@Nonnull
public EntitySelectMenu.Builder setDefaultValues(@Nonnull
 Collection<? extends EntitySelectMenu.DefaultValue> values)

The default values that will be shown to the user.

Parameters:

values - The default values (up to 25)

Returns:

The current Builder instance

Throws:

IllegalArgumentException - If null is provided, more than 25 values are provided, or any of the value types is incompatible with the configured entity types.

build

@Nonnull
public EntitySelectMenu build()

Creates a new EntitySelectMenu instance if all requirements are satisfied.

Specified by:

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

Returns:

The new EntitySelectMenu instance

Throws:

IllegalArgumentException - Throws if SelectMenu.Builder.getMinValues() is greater than SelectMenu.Builder.getMaxValues()