Class Modal

Hierarchy

Modal

Index

Constructors

Properties

callback id modal rawRequires requires

Methods

addComponent addComponents call getInput getModal handle register

Constructors

constructor

new Modal(data: ModalData): Modal
Create a new modal handler.
Parameters
- data: ModalData
Returns Modal
- Defined in src/structures/v14/Modal.ts:50

Properties

`Private` callback

callback: ((modal: ModalSubmitInteraction<CacheType>) => void)

Type declaration

- (modal: ModalSubmitInteraction<CacheType>): void
- The callback to call when the modal is submitted.
  Parameters
  - modal: ModalSubmitInteraction<CacheType>
  Returns void

id

id: string

The identifier of the modal.

`Private` modal

modal: ModalBuilder

The built modal.

`Private` rawRequires

rawRequires: string[]

The raw requirements before load.

requires

requires: (undefined | Requirement)[]

Methods

addComponent

addComponent(data: TextInputData | TextInputBuilder): Modal
Add a text input component to the modal.
Parameters
- data: TextInputData | TextInputBuilder
Returns Modal
- Defined in src/structures/v14/Modal.ts:63

addComponents

addComponents(...components: TextInputData[] | TextInputBuilder[]): Modal
Add text input components to the modal.
Parameters
- Rest ...components: TextInputData[] | TextInputBuilder[]
Returns Modal
- Defined in src/structures/v14/Modal.ts:72

call

call(modal: ModalSubmitInteraction<CacheType>): Promise<undefined | Modal>
Call the callback.
Parameters
- modal: ModalSubmitInteraction<CacheType>
  
  The modal that was submitted.
Returns Promise<undefined | Modal>
- Defined in src/structures/v14/Modal.ts:142

getInput

getInput(itr: ChatInputCommandInteraction<CacheType> | MessageContextMenuCommandInteraction<CacheType> | UserContextMenuCommandInteraction<CacheType> | StringSelectMenuInteraction<CacheType> | UserSelectMenuInteraction<CacheType> | RoleSelectMenuInteraction<CacheType> | MentionableSelectMenuInteraction<CacheType> | ChannelSelectMenuInteraction<CacheType> | ButtonInteraction<CacheType>): Promise<ModalSubmitFields>
Show modal to user and recieve the input.
Parameters
- itr: ChatInputCommandInteraction<CacheType> | MessageContextMenuCommandInteraction<CacheType> | UserContextMenuCommandInteraction<CacheType> | StringSelectMenuInteraction<CacheType> | UserSelectMenuInteraction<CacheType> | RoleSelectMenuInteraction<CacheType> | MentionableSelectMenuInteraction<CacheType> | ChannelSelectMenuInteraction<CacheType> | ButtonInteraction<CacheType>
Returns Promise<ModalSubmitFields>
- Defined in src/structures/v14/Modal.ts:99

getModal

getModal(): ModalBuilder
Get the modal.

Returns ModalBuilder
- Defined in src/structures/v14/Modal.ts:92

handle

handle(callback: ((modal: ModalSubmitInteraction<CacheType>) => void)): Modal
Set the callback to call when the modal is submitted.
Parameters
- callback: ((modal: ModalSubmitInteraction<CacheType>) => void)
  
  The callback to call.
  - - (modal: ModalSubmitInteraction<CacheType>): void
    - Parameters
      
      modal: ModalSubmitInteraction<CacheType>
      
      Returns void
Returns Modal
- Defined in src/structures/v14/Modal.ts:132

register

register(client: KommandoClient): Modal
Register the modal to the client.
Parameters
- client: KommandoClient
  
  The client to register the modal to.
Returns Modal
- Defined in src/structures/v14/Modal.ts:83

Generated using TypeDoc