Class ModalSubmitInteractionComponentsWrapper

constructor

• new ModalSubmitInteractionComponentsWrapper(resolved, data): ModalSubmitInteractionComponentsWrapper

• Parameters

  • resolved: ModalSubmitInteractionResolvedData
  • data: (ModalSubmitComponentsActionRow | ModalSubmitComponentsLabel)[]

  Returns ModalSubmitInteractionComponentsWrapper

raw

resolved

getChannelSelectComponent

• getChannelSelectComponent(name, required?): undefined | ModalSubmitChannelSelectComponent

• Get a channel select option.

  Parameters

  • name: string

    The name of the option.
  • Optional required: false

    If true, an error will be thrown if the option is not present.

  Returns undefined | ModalSubmitChannelSelectComponent
• getChannelSelectComponent(name, required): ModalSubmitChannelSelectComponent

• Parameters

  • name: string
  • required: true

  Returns ModalSubmitChannelSelectComponent

getChannelSelectValues

• getChannelSelectValues(name, required?): undefined | InteractionResolvedChannel[]

• Get the values of a channel select option. This always returns an array, since selects can be multi-choice.

  Parameters

  • name: string

    The name of the option.
  • Optional required: false

    If true, an error will be thrown if the option is not present.

  Returns undefined | InteractionResolvedChannel[]
• getChannelSelectValues(name, required): InteractionResolvedChannel[]

• Parameters

  • name: string
  • required: true

  Returns InteractionResolvedChannel[]

getComponents

• getComponents(): ModalSubmitComponents[]

• Get the components in this interaction.

  Returns ModalSubmitComponents[]

getFileUploadComponent

• getFileUploadComponent(name, required?): undefined | ModalSubmitFileUploadComponent

• Get a file upload option.

  Parameters

  • name: string

    The name of the option.
  • Optional required: false

    If true, an error will be thrown if the option is not present.

  Returns undefined | ModalSubmitFileUploadComponent
• getFileUploadComponent(name, required): ModalSubmitFileUploadComponent

• Parameters

  • name: string
  • required: true

  Returns ModalSubmitFileUploadComponent

getFileUploadValues

• getFileUploadValues(name, required?): undefined | Attachment[]

• Get the values of a file upload option.

  Parameters

  • name: string

    The name of the option.
  • Optional required: false

    If true, an error will be thrown if the option is not present.

  Returns undefined | Attachment[]
• getFileUploadValues(name, required): Attachment[]

• Parameters

  • name: string
  • required: true

  Returns Attachment[]

getMentionableSelectComponent

• getMentionableSelectComponent(name, required?): undefined | ModalSubmitMentionableSelectComponent

• Get a mentionable select option.

  Parameters

  • name: string

    The name of the option.
  • Optional required: false

    If true, an error will be thrown if the option is not present.

  Returns undefined | ModalSubmitMentionableSelectComponent
• getMentionableSelectComponent(name, required): ModalSubmitMentionableSelectComponent

• Parameters

  • name: string
  • required: true

  Returns ModalSubmitMentionableSelectComponent

getMentionableSelectValues

• getMentionableSelectValues(name, required?): undefined | (User | Role)[]

• Get the values of a mentionable select option. This always returns an array, since selects can be multi-choice.

  Parameters

  • name: string

    The name of the option.
  • Optional required: false

    If true, an error will be thrown if the option is not present.

  Returns undefined | (User | Role)[]
• getMentionableSelectValues(name, required): (User | Role)[]

• Parameters

  • name: string
  • required: true

  Returns (User | Role)[]

getRoleSelectComponent

• getRoleSelectComponent(name, required?): undefined | ModalSubmitRoleSelectComponent

• Get a role select option.

  Parameters

  • name: string

    The name of the option.
  • Optional required: false

    If true, an error will be thrown if the option is not present.

  Returns undefined | ModalSubmitRoleSelectComponent
• getRoleSelectComponent(name, required): ModalSubmitRoleSelectComponent

• Parameters

  • name: string
  • required: true

  Returns ModalSubmitRoleSelectComponent

getRoleSelectValues

• getRoleSelectValues(name, required?): undefined | Role[]

• Get the values of a role select option. This always returns an array, since selects can be multi-choice.

  Parameters

  • name: string

    The name of the option.
  • Optional required: false

    If true, an error will be thrown if the option is not present.

  Returns undefined | Role[]
• getRoleSelectValues(name, required): Role[]

• Parameters

  • name: string
  • required: true

  Returns Role[]

getStringSelectComponent

• getStringSelectComponent(name, required?): undefined | ModalSubmitStringSelectComponent

• Get a string select option.

  Parameters

  • name: string

    The name of the option.
  • Optional required: false

    If true, an error will be thrown if the option is not present.

  Returns undefined | ModalSubmitStringSelectComponent
• getStringSelectComponent(name, required): ModalSubmitStringSelectComponent

• Parameters

  • name: string
  • required: true

  Returns ModalSubmitStringSelectComponent

getStringSelectValues

• getStringSelectValues<T>(name, required?): undefined | T

• Get the values of a string select option. This always returns an array, since selects can be multi-choice.

  Type Parameters

  • T extends string[] = string[]

  Parameters

  • name: string

    The name of the option.
  • Optional required: false

    If true, an error will be thrown if the option is not present.

  Returns undefined | T
• getStringSelectValues<T>(name, required): T

• Type Parameters

  • T extends string[] = string[]

  Parameters

  • name: string
  • required: true

  Returns T

getTextInput

• getTextInput<T>(name, required?): undefined | T

• Get a text input option value.

  Type Parameters

  • T extends string = string

  Parameters

  • name: string

    The name of the option.
  • Optional required: false

    If true, an error will be thrown if the option is not present.

  Returns undefined | T
• getTextInput<T>(name, required): T

• Type Parameters

  • T extends string = string

  Parameters

  • name: string
  • required: true

  Returns T

getTextInputComponent

• getTextInputComponent(name, required?): undefined | ModalSubmitTextInputComponent

• Get a text input option.

  Parameters

  • name: string

    The name of the option.
  • Optional required: false

    If true, an error will be thrown if the option is not present.

  Returns undefined | ModalSubmitTextInputComponent
• getTextInputComponent(name, required): ModalSubmitTextInputComponent

• Parameters

  • name: string
  • required: true

  Returns ModalSubmitTextInputComponent

getUserSelectComponent

• getUserSelectComponent(name, required?): undefined | ModalSubmitUserSelectComponent

• Get a user select option.

  Parameters

  • name: string

    The name of the option.
  • Optional required: false

    If true, an error will be thrown if the option is not present.

  Returns undefined | ModalSubmitUserSelectComponent
• getUserSelectComponent(name, required): ModalSubmitUserSelectComponent

• Parameters

  • name: string
  • required: true

  Returns ModalSubmitUserSelectComponent

getUserSelectValues

• getUserSelectValues(name, required?): undefined | User[]

• Get the values of a user select option. This always returns an array, since selects can be multi-choice.

  Parameters

  • name: string

    The name of the option.
  • Optional required: false

    If true, an error will be thrown if the option is not present.

  Returns undefined | User[]
• getUserSelectValues(name, required): User[]

• Parameters

  • name: string
  • required: true

  Returns User[]