TextInputBuilder

No summary provided.
declare class TextInputBuilder extends ComponentBuilder<APITextInputComponent> implements Equatable<APITextInputComponent | JSONEncodable<APITextInputComponent>>

Extends

ComponentBuilder<APITextInputComponent>

Implements

Equatable<APITextInputComponent | JSONEncodable<APITextInputComponent>>

constructor(data?)

Constructs a new instance of the TextInputBuilder class
NameTypeOptionalDescription
dataAPITextInputComponent & { type?: ComponentType.TextInput; }YesNone
Readonly

data

:

Partial<DataType>

The API data associated with this component
Inherited from ComponentBuilder

equals(other)

:

boolean

Whether or not this is equal to another structure
NameTypeOptionalDescription
otherAPITextInputComponent | JSONEncodable<APITextInputComponent>NoNone

setCustomId(customId)

:

this

Sets the custom id for this text input
NameTypeOptionalDescription
customIdstringNo
The custom id of this text input

setLabel(label)

:

this

Sets the label for this text input
NameTypeOptionalDescription
labelstringNo
The label for this text input

setMaxLength(maxLength)

:

this

Sets the maximum length of text for this text input
NameTypeOptionalDescription
maxLengthnumberNo
The maximum length of text for this text input

setMinLength(minLength)

:

this

Sets the minimum length of text for this text input
NameTypeOptionalDescription
minLengthnumberNo
The minimum length of text for this text input

setPlaceholder(placeholder)

:

this

Sets the placeholder of this text input
NameTypeOptionalDescription
placeholderstringNo
The placeholder of this text input

setRequired(required?)

:

this

Sets whether this text input is required
NameTypeOptionalDescription
requiredbooleanYes
Whether this text input is required

setStyle(style)

:

this

Sets the style for this text input
NameTypeOptionalDescription
styleTextInputStyleNo
The style for this text input

setValue(value)

:

this

Sets the value of this text input
NameTypeOptionalDescription
valuestringNo
The value for this text input

toJSON()

:

APITextInputComponent

Serializes this component to an API-compatible JSON object
Remarks
This method runs validations on the data before serializing it. As such, it may throw an error if the data is invalid.