Preview environment

class ModalSubmitFields

export class ModalSubmitFields<Cached extends CacheType = CacheType>

Represents the serialized fields from a modal submit interaction

Type Parameters

optional
Cached? extends CacheType = CacheType

components : (ActionRowModalData | LabelModalData | TextDisplayModalData)[]

The components within the modal

fields : Collection<string, ModalData>

The extracted fields from the modal

resolved : Readonly<BaseInteractionResolvedData<Cached>> | null

The interaction resolved data

getField<

Type extends ComponentType

>(
customId: string
type: Type
) : Extract<ModalData, { type: Type }>

Gets a field given a custom id from a component

getSelectedChannels<

Type? extends ChannelType = ChannelType

>(
customId: string
required: true = false
channelTypes?: readonly Type[] = []
) : ReadonlyCollection<Snowflake, Extract<NonNullable<CommandInteractionOption<Cached>['channel']>, { type: Type extends ChannelType.AnnouncementThread | ChannelType.PublicThread ? ChannelType.AnnouncementThread | ChannelType.PublicThread : Type; }>>

Gets channels component

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

getSelectedMembers(
customId: string
) : NonNullable<SelectMenuModalData<Cached>['members']> | null

Gets members component

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

getSelectedMentionables(
customId: string
required: true = false
) : ModalSelectedMentionables<Cached>

Gets mentionables component

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

getSelectedRoles(
customId: string
required: true = false
) : NonNullable<SelectMenuModalData<Cached>['roles']>

Gets roles component

Returns: The selected roles, or null if none were selected and not required

getSelectedUsers(
customId: string
required: true = false
) : ReadonlyCollection<Snowflake, User>

Gets users component

Returns: The selected users, or null if none were selected and not required

getStringSelectValues(
customId: string
) : readonly string[]

Gets the values of a string select component given a custom id

getTextInputValue(
customId: string
) : string

Gets the value of a text input component given a custom id

getUploadedFiles(
customId: string
required: true = false
) : ReadonlyCollection<Snowflake, Attachment>

Gets file upload component

Returns: The uploaded files, or null if none were uploaded and not required