Preview environment

class ModalBuilder

export declare class ModalBuilder implements JSONEncodable<APIModalInteractionResponseCallbackData>

A builder that creates API-compatible JSON data for modals.

Constructors

constructor(
data?: Partial<APIModalInteractionResponseCallbackData>
)

Creates a new modal from API data.

readonly
components : ActionRowBuilder<ModalActionRowComponentBuilder>[]

The components within this modal.

readonly
data : Partial<APIModalInteractionResponseCallbackData>

The API data associated with this modal.

addComponents(
...components: RestOrArray<ActionRowBuilder<ModalActionRowComponentBuilder> | APIActionRowComponent<APIModalActionRowComponent>>
) : this

Adds components to this modal.

setComponents(
...components: RestOrArray<ActionRowBuilder<ModalActionRowComponentBuilder>>
) : this

Sets components for this modal.

setCustomId(
customId: string
) : this

Sets the custom id of this modal.

setTitle(
title: string
) : this

Sets the title of this modal.

toJSON() : APIModalInteractionResponseCallbackData

Serializes this builder to API-compatible JSON data.