Class Modal

constructor

• new Modal(data?: Partial<APIModalInteractionResponseCallbackData>): Modal

  Creates a new Modal instance.

  Parameters

  • data: Partial<APIModalInteractionResponseCallbackData> = {}

    Optional data for the modal.

  Returns Modal

components

data

addComponents

• addComponents(...components: RestOrArray<ModalBuilderComponents>): this

  Adds components to the modal.

  Parameters

  • ...components: RestOrArray<ModalBuilderComponents>

    Components to be added to the modal.

  Returns this

  The current Modal instance.

run

• run(func: ModalSubmitCallback): this

  Sets the callback function to be executed when the modal is submitted.

  Parameters

  • func: ModalSubmitCallback

    The callback function.

  Returns this

  The current Modal instance.

setComponents

• setComponents(component: ModalBuilderComponents[]): this

  Set the components to the modal.

  Parameters

  • component: ModalBuilderComponents[]

    The components to set into the modal.

  Returns this

  The current Modal instance.

setCustomId

• setCustomId(id: string): this

  Sets the custom ID of the modal.

  Parameters

  • id: string

    The custom ID for the modal.

  Returns this

  The current Modal instance.

setTitle

• setTitle(title: string): this

  Sets the title of the modal.

  Parameters

  • title: string

    The title of the modal.

  Returns this

  The current Modal instance.

toJSON

• toJSON(): APIModalInteractionResponseCallbackData

  Converts the modal to JSON format.

  Returns APIModalInteractionResponseCallbackData

  The modal data in JSON format.