ModalSubmitInteraction
Signature
export interface ModalSubmitInteraction<FromGuild extends boolean = boolean> extends Omit<Interaction<FromGuild, APIModalSubmitInteraction>, 'modal'>Properties
28Methods
37updatedeferUpdategetComponentgetChannelsgetRolesgetUsersgetMentionablesgetRadioValuesgetCheckboxValuesgetCheckboxgetInputValuegetFilesisModalhasRepliedOrAwaitPendingReplyreplydeferReplyisButtonisChannelSelectMenuisRoleSelectMenuisMentionableSelectMenuisUserSelectMenuisStringSelectMenuisChatInputisUserisMessageisAutocompleteisEntryPointfetchGuildwriteeditResponsedeleteResponseeditOrReplyfollowupfetchResponsefetchMessageeditMessagedeleteMessage
Properties
data: ObjectToLower<APIModalSubmission>;channel: AllChannels;customIdGetterget customId(): string;componentsGetterget components(): { type: ComponentType.Label; id?: number | undefined; component?: { type: ComponentType.FileUpload; values: string[]; id?: number | undefined; customId: string; } | { type: ComponentType.RadioGroup; value: string; id?: number | undefined; customId: string; } | { type: ComponentType.CheckboxGroup; values: string[]; id?: number | undefined; customId: string; } | { type: ComponentType.Checkbox; value: boolean; id?: number | undefined; customId: string; } | { type: ComponentType.TextInput; value: string; id?: number | undefined; customId: string; } | { type: ComponentType.StringSelect | ComponentType.UserSelect | ComponentType.RoleSelect | ComponentType.MentionableSelect | ComponentType.ChannelSelect; values: string[]; id?: number | undefined; customId: string; } | undefined;}[];readonly client: UsingClient;protected __reply?: __InternalReplyFunction | undefined;user: UserStructure;member: When<FromGuild, InteractionGuildMemberStructure, undefined>;message?: MessageStructure;replied?: boolean;private _repliedPromise?;deferred?: boolean;appPermissions: PermissionsBitField;entitlements: EntitlementStructure[];private matchReplied;id: string;createdTimestampGetterget createdTimestamp(): number;Create a timestamp for the current object.
createdAtGetterget createdAt(): Date;createdAt gets the creation Date instace of the current object.
guildId?: string | undefined;guild?: { locale: Locale; id: string; features: GuildFeature[]; } | undefined;token: string;version: 1;locale: 'id' | 'en-US' | 'en-GB' | 'bg' | 'zh-CN' | 'zh-TW' | 'hr' | 'cs' | 'da' | 'nl' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'it' | 'ja' | 'ko' | 'lt' | 'no' | 'pl' | 'pt-BR' | 'ro' | 'ru' | 'es-ES' | 'es-419' | 'sv-SE' | 'th' | 'tr' | 'uk' | 'vi';applicationId: string;guildLocale?: 'id' | 'en-US' | 'en-GB' | 'bg' | 'zh-CN' | 'zh-TW' | 'hr' | 'cs' | 'da' | 'nl' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'it' | 'ja' | 'ko' | 'lt' | 'no' | 'pl' | 'pt-BR' | 'ro' | 'ru' | 'es-ES' | 'es-419' | 'sv-SE' | 'th' | 'tr' | 'uk' | 'vi' | undefined;authorizingIntegrationOwners: { 0?: string | undefined; 1?: string | undefined; };context?: InteractionContextType | undefined;attachmentSizeLimit: number;Methods
update<WR extends boolean = false>(data: ComponentInteractionMessageUpdate, withResponse?: WR): Promise<When<WR, WebhookMessageStructure, undefined>>;deferUpdate(): Promise<undefined>;getComponent(customId: string, type?: ComponentType[]): ObjectToLower<ModalSubmitInsideLabelData> | undefined;getChannels(customId: string, required: true): AllChannels[];getChannels(customId: string, required?: false): AllChannels[] | void;getRoles(customId: string, required: true): GuildRoleStructure[];getRoles(customId: string, required?: false): GuildRoleStructure[] | void;getUsers(customId: string, required: true): UserStructure[];getUsers(customId: string, required?: false): UserStructure[] | void;getMentionables(customId: string, required: true): (UserStructure | GuildRoleStructure | InteractionGuildMemberStructure)[];getMentionables(customId: string, required?: false): (UserStructure | GuildRoleStructure | InteractionGuildMemberStructure)[] | void;getRadioValues(customId: string, required: true): string;getRadioValues(customId: string, required?: false): string | void;getCheckboxValues(customId: string, required: true): string[];getCheckboxValues(customId: string, required?: false): string[] | void;For checkbox groups.
getCheckbox(customId: string, required: true): boolean;getCheckbox(customId: string, required?: false): boolean | void;getInputValue(customId: string, required: true): string | string[];getInputValue(customId: string, required?: false): string | string[] | undefined;getFiles(customId: string, required: true): Attachment[];getFiles(customId: string, required?: false): Attachment[] | undefined;isModal(): this is ModalSubmitInteraction;protected hasRepliedOrAwaitPendingReply(): Promise<boolean>;reply<WR extends boolean = false>(body: ReplyInteractionBody, withResponse?: WR): Promise<When<WR, WebhookMessageStructure, undefined>>;deferReply<WR extends boolean = false>(flags?: MessageFlags, withResponse?: WR): Promise<When<WR, WebhookMessageStructure, undefined>>;isButton(): this is ButtonInteraction;isChannelSelectMenu(): this is ChannelSelectMenuInteraction;isRoleSelectMenu(): this is RoleSelectMenuInteraction;isMentionableSelectMenu(): this is MentionableSelectMenuInteraction;isUserSelectMenu(): this is UserSelectMenuInteraction;isStringSelectMenu(): this is StringSelectMenuInteraction;isChatInput(): this is ChatInputCommandInteraction;isUser(): this is UserCommandInteraction;isMessage(): this is MessageCommandInteraction;isAutocomplete(): this is AutocompleteInteraction;isEntryPoint(): this is EntryPointInteraction;fetchGuild(mode?: 'rest' | 'flow'): Promise<GuildStructure<'cached' | 'api'> | undefined>;fetchGuild(mode: 'cache'): ReturnCache<GuildStructure<'cached'> | undefined>;write<FR extends boolean = false>(body: InteractionCreateBodyRequest, withResponse?: FR): Promise<When<FR, WebhookMessageStructure, void>>;editResponse(body: InteractionMessageUpdateBodyRequest): Promise<WebhookMessageStructure>;deleteResponse(): Promise<void>;editOrReply<FR extends boolean = false>(body: InteractionCreateBodyRequest, fetchReply?: FR): Promise<When<FR, WebhookMessageStructure, void>>;followup(body: MessageWebhookCreateBodyRequest): Promise<WebhookMessageStructure>;fetchResponse(): Promise<WebhookMessageStructure>;fetchMessage(messageId: string): Promise<WebhookMessageStructure>;editMessage(messageId: string, body: InteractionMessageUpdateBodyRequest): Promise<WebhookMessageStructure>;deleteMessage(messageId: string): Promise<void>;