Interface TextInput
- All Superinterfaces:
ActionComponent,Component,ItemComponent,SerializableData
Represents a Discord Text input component
Must be used in Modals!
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface net.dv8tion.jda.api.interactions.components.Component
Component.Type -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe maximum length a TextInput custom id can have.static final intThe maximum length a TextInput label can have.static final intThe maximum length a TextInput placeholder can have.static final intThe maximum length a TextInput value can have. -
Method Summary
Modifier and TypeMethodDescriptionstatic TextInput.Buildercreate(String id, String label, TextInputStyle style) Creates a new TextInput Builder.getId()The custom id of this TextInput component.getLabel()The label of this TextInput component.intThe maximum amount of characters that can be written to submit the Modal.intThe minimum amount of characters that must be written to submit the Modal.The placeholder of this TextInput component.getStyle()TheTextInputStyleof this TextInput component.default Component.TypegetType()The type of component.getValue()The pre-defined value of this TextInput component.default booleanWhether this action component is disabled.booleanWhether this TextInput is required to be non-emptydefault ActionComponentwithDisabled(boolean disabled) Returns a copy of this component withActionComponent.isDisabled()set to the provided value.Methods inherited from interface net.dv8tion.jda.api.interactions.components.ActionComponent
asDisabled, asEnabledMethods inherited from interface net.dv8tion.jda.api.interactions.components.ItemComponent
getMaxPerRow, isMessageCompatible, isModalCompatibleMethods inherited from interface net.dv8tion.jda.api.utils.data.SerializableData
toData
-
Field Details
-
MAX_VALUE_LENGTH
static final int MAX_VALUE_LENGTHThe maximum length a TextInput value can have. (4000)- See Also:
-
MAX_ID_LENGTH
static final int MAX_ID_LENGTHThe maximum length a TextInput custom id can have. (100)- See Also:
-
MAX_PLACEHOLDER_LENGTH
static final int MAX_PLACEHOLDER_LENGTHThe maximum length a TextInput placeholder can have. (100)- See Also:
-
MAX_LABEL_LENGTH
static final int MAX_LABEL_LENGTHThe maximum length a TextInput label can have. (45)- See Also:
-
-
Method Details
-
getStyle
TheTextInputStyleof this TextInput component.- Returns:
- The style of this TextInput component.
-
getId
The custom id of this TextInput component.This is used to uniquely identify the TextInput. Similar to
Buttons.- Specified by:
getIdin interfaceActionComponent- Returns:
- The custom id of this component.
- See Also:
-
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
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
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:ActionComponentWhether this action component is disabled.You can use
ActionComponent.asDisabled()orActionComponent.asEnabled()to create enabled/disabled instances.- Specified by:
isDisabledin interfaceActionComponent- Returns:
- True, if this button is disabled
-
withDisabled
Description copied from interface:ActionComponentReturns a copy of this component withActionComponent.isDisabled()set to the provided value.- Specified by:
withDisabledin interfaceActionComponent- Parameters:
disabled- True, if this component should be disabled- Returns:
- New enabled/disabled component instance
-
getType
Description copied from interface:ComponentThe type of component.- Specified by:
getTypein interfaceComponent- 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 idlabel- The labelstyle- TheTextInputStyle- Returns:
- a new TextInput Builder.
- Throws:
IllegalArgumentException-
-