Class TextInputBuilder

Readonly data

equals

• equals(other): boolean

• Whether this is equal to another structure.

  Parameters

  • other: APITextInputComponent | JSONEncodable<APITextInputComponent>

  Returns boolean

setCustomId

• setCustomId(customId): TextInputBuilder

• Sets the custom id for this text input.

  Parameters

  • customId: string

    The custom id to use

  Returns TextInputBuilder

setLabel

• setLabel(label): TextInputBuilder

• Sets the label for this text input.

  Parameters

  • label: string

    The label to use

  Returns TextInputBuilder

setMaxLength

• setMaxLength(maxLength): TextInputBuilder

• Sets the maximum length of text for this text input.

  Parameters

  • maxLength: number

    The maximum length of text for this text input

  Returns TextInputBuilder

setMinLength

• setMinLength(minLength): TextInputBuilder

• Sets the minimum length of text for this text input.

  Parameters

  • minLength: number

    The minimum length of text for this text input

  Returns TextInputBuilder

setPlaceholder

• setPlaceholder(placeholder): TextInputBuilder

• Sets the placeholder for this text input.

  Parameters

  • placeholder: string

    The placeholder to use

  Returns TextInputBuilder

setRequired

• setRequired(required?): TextInputBuilder

• Sets whether this text input is required.

  Parameters

  • Optional required: boolean

    Whether this text input is required

  Returns TextInputBuilder

setStyle

• setStyle(style): TextInputBuilder

• Sets the style for this text input.

  Parameters

  • style: TextInputStyle

    The style to use

  Returns TextInputBuilder

setValue

• setValue(value): TextInputBuilder

• Sets the value for this text input.

  Parameters

  • value: string

    The value to use

  Returns TextInputBuilder

toJSON

• toJSON(): APITextInputComponent

• Serializes this builder to API-compatible JSON data.

  Returns APITextInputComponent

  Remarks

  This method runs validations on the data before serializing it. As such, it may throw an error if the data is invalid.