Class ModalBuilder

Hierarchy

  • ModalBuilder
    • ModalBuilder

Constructors

constructor

Properties

components data

Methods

addComponents setComponents setCustomId setExecute setTitle toJSON from

Constructors

constructor

Properties

Readonlycomponents

components: ActionRowBuilder<TextInputBuilder>[]

The components within this modal.

Readonlydata

data: Partial<APIModalInteractionResponseCallbackData>

The API data associated with this modal.

Methods

addComponents

  • addComponents(...components): this

  • Adds components to this modal.

    Parameters

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

      The components to add

    Returns this

setComponents

  • setComponents(...components): this

  • Sets components for this modal.

    Parameters

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

      The components to set

    Returns this

setCustomId

  • setCustomId(customId): this

  • Sets the custom id of this modal.

    Parameters

    • customId: string

      The custom id to use

    Returns this

setExecute

  • setExecute(execute): this

  • Parameters

    • execute: ModalSubmitInteractionExecute

    Returns this

setTitle

  • setTitle(title): this

  • Sets the title of this modal.

    Parameters

    • title: string

      The title to use

    Returns this

toJSON

  • toJSON(): APIModalInteractionResponseCallbackData

  • {@inheritDoc ComponentBuilder.toJSON}

    Returns APIModalInteractionResponseCallbackData

Staticfrom

  • from(other): ModalBuilder

  • Parameters

    • other: APIModalInteractionResponseCallbackData | JSONEncodable<APIModalInteractionResponseCallbackData>

    Returns ModalBuilder

Settings

Member Visibility

On This Page

Constructors
Properties
Methods