ModalFields

The fields a modal carries, read by custom id.

Every getter throws when no field in the modal has that custom id. It also throws when the field holds a kind that getter does not read. The message names the getter that does.

A select getter resolves the ids its field picked against the interaction's resolved data and returns a Collection keyed by id. A field that picked nothing returns null. Pass required to throw there instead.

class ModalFields

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the ModalFields class

ModalFields(data: APIModalSubmission)

Showing members with Protected visibility and higher.

getCheckbox()

public getCheckbox(customId: string): boolean

getCheckboxGroup()

public getCheckboxGroup(customId: string): string[]

getField()

Returns the field with this custom id, as Discord sent it. Use it for a component type the typed getters do not cover.

Pass a component type to get that exact type back. It throws when the field holds a different one.

public getField<Kind>(
    customId: string,
    kind: Kind
): Extract<ModalSubmitComponent, { type: Kind }>

getRadioGroup()

public getRadioGroup(
    customId: string,
    required: true
): string

getSelectedChannels()

Pass channelTypes to throw when a pick falls outside those types.

public getSelectedChannels(
    customId: string,
    required: true,
    channelTypes?: readonly ChannelType[]
): Collection<string, APIInteractionDataResolvedChannel>

getSelectedMembers()

The guild members behind the picked users. Discord resolves these only inside a guild.

public getSelectedMembers(
    customId: string
): Collection<string, APIInteractionDataResolvedGuildMember> | null

getSelectedMentionables()

public getSelectedMentionables(
    customId: string,
    required: true
): SelectedMentionables

getSelectedRoles()

public getSelectedRoles(
    customId: string,
    required: true
): Collection<string, APIRole>

getSelectedUsers()

public getSelectedUsers(
    customId: string,
    required: true
): Collection<string, APIUser>

getStringSelectValues()

public getStringSelectValues(
    customId: string
): string[]

getTextInputValue()

public getTextInputValue(customId: string): string

getUploadedFiles()

public getUploadedFiles(
    customId: string,
    required: true
): Collection<string, APIAttachment>