Package net.dv8tion.jda.api.components.textinput

Interface TextInput

All Superinterfaces:

ActionComponent, ActionRowChildComponent, Component, IDisableable

All Known Implementing Classes:

TextInputImpl

public interface TextInput
extends ActionComponent, ActionRowChildComponent

Represents a Discord Text input component

Must be used in Modals!

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TextInput.Builder	Builder for TextInputs

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

Component.Type

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_ID_LENGTH	The maximum length a TextInput custom id can have.
static final int	MAX_LABEL_LENGTH	The maximum length a TextInput label can have.
static final int	MAX_PLACEHOLDER_LENGTH	The maximum length a TextInput placeholder can have.
static final int	MAX_VALUE_LENGTH	The maximum length a TextInput value can have.

Method Summary

Modifier and Type	Method	Description
default TextInput	asDisabled()	Returns a copy of this component with ActionComponent.isDisabled() set to true.
default TextInput	asEnabled()	Returns a copy of this component with ActionComponent.isDisabled() set to false.
static TextInput.Builder	create(String id, String label, TextInputStyle style)	Creates a new TextInput Builder.
String	getCustomId()	The custom id of this TextInput component.
String	getLabel()	The label of this TextInput component.
int	getMaxLength()	The maximum amount of characters that can be written to submit the Modal.
int	getMinLength()	The minimum amount of characters that must be written to submit the Modal.
String	getPlaceHolder()	The placeholder of this TextInput component.
TextInputStyle	getStyle()	The TextInputStyle of this TextInput component.
default Component.Type	getType()	The type of component.
String	getValue()	The pre-defined value of this TextInput component.
default boolean	isDisabled()	Whether this action component is disabled.
boolean	isRequired()	Whether this TextInput is required to be non-empty
default TextInput	withDisabled(boolean disabled)	Returns a copy of this component with ActionComponent.isDisabled() set to the provided value.
TextInput	withUniqueId(int uniqueId)	Creates a new component with the provided numeric ID.

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

getId

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

getUniqueId, isMessageCompatible, isModalCompatible

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

isEnabled

Field Details

MAX_VALUE_LENGTH

static final int MAX_VALUE_LENGTH

The maximum length a TextInput value can have. (4000)

See Also:

• Constant Field Values

MAX_ID_LENGTH

static final int MAX_ID_LENGTH

The maximum length a TextInput custom id can have. (100)

See Also:

• Constant Field Values

MAX_PLACEHOLDER_LENGTH

static final int MAX_PLACEHOLDER_LENGTH

The maximum length a TextInput placeholder can have. (100)

See Also:

• Constant Field Values

MAX_LABEL_LENGTH

static final int MAX_LABEL_LENGTH

The maximum length a TextInput label can have. (45)

See Also:

• Constant Field Values

Method Details

getStyle

@Nonnull
TextInputStyle getStyle()

The TextInputStyle of this TextInput component.

Returns:

The style of this TextInput component.

getCustomId

@Nonnull
String getCustomId()

The custom id of this TextInput component.

This is used to uniquely identify the TextInput. Similar to Buttons.

Specified by:

getCustomId in interface ActionComponent

Returns:

The custom id of this component.

See Also:

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

getLabel

@Nonnull
String getLabel()

The label of this TextInput component.

Returns:

The label of this TextInput component.

getMinLength

int getMinLength()

The minimum amount of characters that must be written to submit the Modal.

This is -1 if no length has been set!

Returns:

The minimum length of this TextInput component or -1

getMaxLength

int getMaxLength()

The maximum amount of characters that can be written to submit the Modal.

This is -1 if no length has been set!

Returns:

The maximum length of this TextInput component or -1

isRequired

boolean isRequired()

Whether this TextInput is required to be non-empty

Returns:

True if this TextInput is required to be used.

getValue

@Nullable
String getValue()

The pre-defined value of this TextInput component.
If this is not null, sending a Modal with this component will pre-populate the field with this String.

This is null if no pre-defined value has been set!

Returns:

The value of this TextInput component or null.

getPlaceHolder

@Nullable
String getPlaceHolder()

The placeholder of this TextInput component.
This is a short hint that describes the expected value of the TextInput field.

This is null if no placeholder has been set!

Returns:

The placeholder of this TextInput component or null.

isDisabled

default 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

asDisabled

@Nonnull
default TextInput asDisabled()

Description copied from interface: ActionComponent

Returns a copy of this component with ActionComponent.isDisabled() set to true.

Specified by:

asDisabled in interface ActionComponent

Specified by:

asDisabled in interface IDisableable

Returns:

New disabled component instance

See Also:

• ComponentTree.replace(ComponentReplacer)

asEnabled

@Nonnull
default TextInput asEnabled()

Description copied from interface: ActionComponent

Returns a copy of this component with ActionComponent.isDisabled() set to false.

Specified by:

asEnabled in interface ActionComponent

Specified by:

asEnabled in interface IDisableable

Returns:

New enabled component instance

See Also:

• ComponentTree.replace(ComponentReplacer)

withDisabled

@Nonnull
default TextInput withDisabled(boolean disabled)

Description copied from interface: ActionComponent

Returns a copy of this component with ActionComponent.isDisabled() set to the provided value.

Specified by:

withDisabled in interface ActionComponent

Specified by:

withDisabled in interface IDisableable

Parameters:

disabled - True, if this component should be disabled

Returns:

New enabled/disabled component instance

See Also:

• ComponentTree.replace(ComponentReplacer)

withUniqueId

@Nonnull
TextInput 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 Component

Specified by:

withUniqueId in interface IDisableable

Parameters:

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

Returns:

The new component

getType

@Nonnull
default Component.Type getType()

Description copied from interface: Component

The type of component.

Specified by:

getType in interface Component

Returns:

Component.Type

create

@Nonnull
static TextInput.Builder create(@Nonnull
 String id,
 @Nonnull
 String label,
 @Nonnull
 TextInputStyle style)

Creates a new TextInput Builder.

Parameters:

id - The custom id

label - The label

style - The TextInputStyle

Returns:

a new TextInput Builder.

Throws:

IllegalArgumentException -

• If either id or label are null or blank
• If style is null or UNKNOWN
• If id is longer than 100 characters
• If label is longer than 45 characters