Class ModalComponentResolver

constructor

• new ModalComponentResolver(
      client: default,
      components: (ActionRowModalData | LabelModalData | TextDisplayModalData)[],
      resolved: undefined | APIInteractionDataResolved,
  ): ModalComponentResolver

  Parameters

  • client: default
  • components: (ActionRowModalData | LabelModalData | TextDisplayModalData)[]
  • resolved: undefined | APIInteractionDataResolved

  Returns ModalComponentResolver

Readonlyclient

ReadonlyhoistedComponents

Readonlyresolved

getComponent

• getComponent(customId: string): ModalData

  Gets a component by custom id.

  Parameters

  • customId: string

    The custom id of the component.

  Returns ModalData

getSelectedChannels

• getSelectedChannels(
      customId: string,
      required?: boolean,
      channelTypes?: ChannelType[],
  ): Collection<string, APIInteractionDataResolvedChannel>

  Gets channels component

  Parameters

  • customId: string

    The custom id of the component

  • required: boolean = false

    Whether to throw an error if the component value is not found or empty

  • channelTypes: ChannelType[] = []

    allowed types of channels. If empty, all channel types are allowed.

  Returns Collection<string, APIInteractionDataResolvedChannel>

  The selected channels, or null if none were selected and not required

getSelectedMembers

• getSelectedMembers(
      customId: string,
  ): Collection<string, APIInteractionDataResolvedGuildMember>

  Gets members component

  Parameters

  • customId: string

    The custom id of the component

  Returns Collection<string, APIInteractionDataResolvedGuildMember>

  The selected members, or null if none were selected or the users were not present in the guild

getSelectedMentionables

• getSelectedMentionables(
      customId: string,
      required?: boolean,
  ): null | ModalSelectedMentionables

  Gets mentionables component

  Parameters

  • customId: string

    The custom id of the component

  • required: boolean = false

    Whether to throw an error if the component value is not found or empty

  Returns null | ModalSelectedMentionables

  The selected mentionables, or null if none were selected and not required

getSelectedRoles

• getSelectedRoles(
      customId: string,
      required?: boolean,
  ): null | Collection<string, APIUser>

  Gets roles component

  Parameters

  • customId: string

    The custom id of the component

  • required: boolean = false

    Whether to throw an error if the component value is not found or empty

  Returns null | Collection<string, APIUser>

getSelectedUsers

• getSelectedUsers(
      customId: string,
      required?: boolean,
  ): null | Collection<string, APIUser>

  Gets users component

  Parameters

  • customId: string

    The custom id of the component

  • required: boolean = false

    Whether to throw an error if the component value is not found or empty The selected users, or null if none were selected and not required

  Returns null | Collection<string, APIUser>

getStringSelectValues

• getStringSelectValues(customId: string): string[]

  Gets the values of a string select component

  Parameters

  • customId: string

    The custom id of the string select component

  Returns string[]

getTextInputValue

• getTextInputValue(customId: string): null | string

  Gets the value of a text input component

  Parameters

  • customId: string

    The custom id of the text input component

  Returns null | string