Class ModalBuilder

Readonly components

Readonly data

addComponents

• addComponents(...components): ModalBuilder

• Adds components to this modal.

  Parameters

  • Rest ...components: RestOrArray<ActionRowBuilder<TextInputBuilder> | APIActionRowComponent<APITextInputComponent>>

    The components to add

  Returns ModalBuilder

setComponents

• setComponents(...components): ModalBuilder

• Sets components for this modal.

  Parameters

  • Rest ...components: RestOrArray<ActionRowBuilder<TextInputBuilder>>

    The components to set

  Returns ModalBuilder

setCustomId

• setCustomId(customId): ModalBuilder

• Sets the custom id of this modal.

  Parameters

  • customId: string

    The custom id to use

  Returns ModalBuilder

setTitle

• setTitle(title): ModalBuilder

• Sets the title of this modal.

  Parameters

  • title: string

    The title to use

  Returns ModalBuilder

toJSON

• toJSON(): APIModalInteractionResponseCallbackData

• Serializes this builder to API-compatible JSON data.

  Returns APIModalInteractionResponseCallbackData

  Remarks

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