Package net.dv8tion.jda.internal.components.selections

Class SelectMenuImpl

java.lang.Object

net.dv8tion.jda.internal.components.AbstractComponentImpl

net.dv8tion.jda.internal.components.selections.SelectMenuImpl

All Implemented Interfaces:

ActionComponent, ActionRowChildComponent, ActionRowChildComponentUnion, IDisableable, Component, IComponentUnion, SelectMenu, SerializableData

Direct Known Subclasses:

EntitySelectMenuImpl, StringSelectMenuImpl

public abstract class SelectMenuImpl
extends AbstractComponentImpl
implements SelectMenu, ActionRowChildComponentUnion

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.components.Component

Component.Type

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.components.selections.SelectMenu

SelectMenu.Builder<T extends SelectMenu,B extends SelectMenu.Builder<T,B>>

Field Summary

Fields inherited from interface net.dv8tion.jda.api.components.selections.SelectMenu

ID_MAX_LENGTH, OPTIONS_MAX_AMOUNT, PLACEHOLDER_MAX_LENGTH

Constructor Summary

Constructors

Constructor	Description
SelectMenuImpl(String id, int uniqueId, String placeholder, int minValues, int maxValues, boolean disabled)
SelectMenuImpl(DataObject data)

Method Summary

Modifier and Type	Method	Description
String	getCustomId()	An unique component ID or null.
int	getMaxValues()	The maximum amount of values a user can select at once.
int	getMinValues()	The minimum amount of values a user has to select.
String	getPlaceholder()	Placeholder which is displayed when no selections have been made yet.
int	getUniqueId()	The unique, numeric identifier of this component.
boolean	isDisabled()	Whether this action component is disabled.
DataObject	toData()	Serialized DataObject for this object.
String	toString()
abstract SelectMenuImpl	withUniqueId(int uniqueId)	Creates a new component with the provided numeric ID.

Methods inherited from class net.dv8tion.jda.internal.components.AbstractComponentImpl

asActionRow, asButton, asContainer, asEntitySelectMenu, asFileDisplay, asMediaGallery, asSection, asSeparator, asStringSelectMenu, asTextDisplay, asTextInput, asThumbnail

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.components.ActionComponent

getId

Methods inherited from interface net.dv8tion.jda.api.components.actionrow.ActionRowChildComponentUnion

asButton, asEntitySelectMenu, asStringSelectMenu

Methods inherited from interface net.dv8tion.jda.api.components.Component

getType, isMessageCompatible, isModalCompatible

Methods inherited from interface net.dv8tion.jda.api.components.IComponentUnion

isUnknownComponent

Methods inherited from interface net.dv8tion.jda.api.components.attribute.IDisableable

isEnabled

Methods inherited from interface net.dv8tion.jda.api.components.selections.SelectMenu

asDisabled, asEnabled, createCopy, withDisabled

Constructor Details

SelectMenuImpl

public SelectMenuImpl(DataObject data)

SelectMenuImpl

public SelectMenuImpl(String id,
 int uniqueId,
 String placeholder,
 int minValues,
 int maxValues,
 boolean disabled)

Method Details

withUniqueId

@Nonnull
public abstract SelectMenuImpl withUniqueId(int uniqueId)

Description copied from interface: Component

Creates a new component with the provided numeric ID.
If no ID is set, Discord will generate IDs incrementally starting from 1 and will not use existing IDs from the same message/modal.

Specified by:

withUniqueId in interface ActionComponent

Specified by:

withUniqueId in interface ActionRowChildComponent

Specified by:

withUniqueId in interface ActionRowChildComponentUnion

Specified by:

withUniqueId in interface Component

Specified by:

withUniqueId in interface IComponentUnion

Specified by:

withUniqueId in interface IDisableable

Specified by:

withUniqueId in interface SelectMenu

Parameters:

uniqueId - The new ID; must be higher or equal to 1

Returns:

The new component

getCustomId

@Nonnull
public String getCustomId()

Description copied from interface: ActionComponent

An unique component ID or null.
Some components such as link buttons don't have this.

Custom IDs can contain custom data, this is typically used to pass data between a slash command and your button listener.

While this ID is unique and can be retrieved with ComponentInteraction.getComponentId(), you should use Component.getUniqueId() to identify a component in a single message, such as when replacing components using ComponentTree or IReplaceable.replace(ComponentReplacer).

Specified by:

getCustomId in interface ActionComponent

Specified by:

getCustomId in interface SelectMenu

Returns:

The component ID or null if not present

See Also:

• ComponentInteraction.getComponentId()
• Component.getUniqueId()

getUniqueId

public int getUniqueId()

Description copied from interface: Component

The unique, numeric identifier of this component.
Can be set manually or automatically assigned by Discord (starting from 1). If it has not been assigned yet, this will return -1.

Note: Older messages may return 0.

Specified by:

getUniqueId in interface Component

Returns:

The unique identifier of this component, or -1 if not assigned yet, or 0 on older messages

getPlaceholder

@Nullable
public String getPlaceholder()

Description copied from interface: SelectMenu

Placeholder which is displayed when no selections have been made yet.

Specified by:

getPlaceholder in interface SelectMenu

Returns:

The placeholder or null

getMinValues

public int getMinValues()

Description copied from interface: SelectMenu

The minimum amount of values a user has to select.

Specified by:

getMinValues in interface SelectMenu

Returns:

The min values

getMaxValues

public int getMaxValues()

Description copied from interface: SelectMenu

The maximum amount of values a user can select at once.

Specified by:

getMaxValues in interface SelectMenu

Returns:

The max values

isDisabled

public boolean isDisabled()

Description copied from interface: ActionComponent

Whether this action component is disabled.

You can use ActionComponent.asDisabled() or ActionComponent.asEnabled() to create enabled/disabled instances.

Specified by:

isDisabled in interface ActionComponent

Specified by:

isDisabled in interface IDisableable

Returns:

True, if this button is disabled

toData

@Nonnull
public DataObject toData()

Description copied from interface: SerializableData

Serialized DataObject for this object.

Specified by:

toData in interface SerializableData

Returns:

DataObject

toString

public String toString()

Overrides:

toString in class Object