Interface ModalMessageModalSubmitInteraction<Cached>

interface ModalMessageModalSubmitInteraction<
    Cached extends CacheType = CacheType,
> {
    applicationId: string;
    appPermissions: Readonly<PermissionsBitField>;
    attachmentSizeLimit: number;
    authorizingIntegrationOwners: APIAuthorizingIntegrationOwnersMap;
    channelId: string;
    client: Client<true>;
    components: ActionRowModalData[];
    context: null | InteractionContextType;
    customId: string;
    deferred: boolean;
    entitlements: Collection<string, Entitlement>;
    ephemeral: null | boolean;
    fields: ModalSubmitFields;
    guildId: CacheTypeReducer<Cached, string>;
    guildLocale: CacheTypeReducer<Cached, Locale>;
    id: string;
    locale: Locale;
    member: CacheTypeReducer<Cached, GuildMember, APIInteractionGuildMember>;
    memberPermissions: CacheTypeReducer<Cached, Readonly<PermissionsBitField>>;
    message: Message<BooleanCache<Cached>>;
    replied: boolean;
    token: string;
    type: ModalSubmit;
    user: User;
    version: number;
    webhook: InteractionWebhook;
    get channel(): CacheTypeReducer<
        Cached,
        null
        | GuildTextBasedChannel,
        null | GuildTextBasedChannel,
        null | GuildTextBasedChannel,
        null | TextBasedChannel,
    >;
    get createdAt(): Date;
    get createdTimestamp(): number;
    get guild(): CacheTypeReducer<Cached, Guild, null>;
    deferReply(
        options: InteractionDeferReplyOptions & { withResponse: true },
    ): Promise<InteractionCallbackResponse<BooleanCache<Cached>>>;
    deferReply(
        options: InteractionDeferReplyOptions & { fetchReply: true },
    ): Promise<Message<BooleanCache<Cached>>>;
    deferReply(
        options?: InteractionDeferReplyOptions,
    ): Promise<InteractionResponse<BooleanCache<Cached>>>;
    deferUpdate(
        options: InteractionDeferUpdateOptions & { withResponse: true },
    ): Promise<InteractionCallbackResponse<BooleanCache<Cached>>>;
    deferUpdate(
        options: InteractionDeferUpdateOptions & { fetchReply: true },
    ): Promise<Message<BooleanCache<Cached>>>;
    deferUpdate(
        options?: InteractionDeferUpdateOptions,
    ): Promise<InteractionResponse<BooleanCache<Cached>>>;
    deleteReply(message?: MessageResolvable): Promise<void>;
    editReply(
        options: string | MessagePayload | InteractionEditReplyOptions,
    ): Promise<Message<BooleanCache<Cached>>>;
    fetchReply(message?: string): Promise<Message<BooleanCache<Cached>>>;
    followUp(
        options: string | MessagePayload | InteractionReplyOptions,
    ): Promise<Message<BooleanCache<Cached>>>;
    inCachedGuild(): this is ModalMessageModalSubmitInteraction<"cached">;
    inGuild(): this is ModalMessageModalSubmitInteraction<"raw" | "cached">;
    inRawGuild(): this is ModalMessageModalSubmitInteraction<"raw">;
    isAnySelectMenu(): this is AnySelectMenuInteraction<Cached>;
    isAutocomplete(): this is AutocompleteInteraction<Cached>;
    isButton(): this is ButtonInteraction<Cached>;
    isChannelSelectMenu(): this is ChannelSelectMenuInteraction<Cached>;
    isChatInputCommand(): this is ChatInputCommandInteraction<Cached>;
    isCommand(): this is CommandInteraction<Cached>;
    isContextMenuCommand(): this is ContextMenuCommandInteraction<Cached>;
    isFromMessage(): this is ModalMessageModalSubmitInteraction<Cached>;
    isMentionableSelectMenu(): this is MentionableSelectMenuInteraction<Cached>;
    isMessageComponent(): this is MessageComponentInteraction<Cached>;
    isMessageContextMenuCommand(): this is MessageContextMenuCommandInteraction<
        Cached,
    >;
    isModalSubmit(): this is ModalSubmitInteraction<Cached>;
    isPrimaryEntryPointCommand(): this is PrimaryEntryPointCommandInteraction<
        Cached,
    >;
    isRepliable(): this is RepliableInteraction<Cached>;
    isRoleSelectMenu(): this is RoleSelectMenuInteraction<Cached>;
    isSelectMenu(): this is StringSelectMenuInteraction<Cached>;
    isStringSelectMenu(): this is StringSelectMenuInteraction<Cached>;
    isUserContextMenuCommand(): this is UserContextMenuCommandInteraction<
        Cached,
    >;
    isUserSelectMenu(): this is UserSelectMenuInteraction<Cached>;
    launchActivity(
        options: LaunchActivityOptions & { withResponse: true },
    ): Promise<InteractionCallbackResponse<BooleanCache<Cached>>>;
    launchActivity(
        options?: LaunchActivityOptions & { withResponse?: false },
    ): Promise<undefined>;
    launchActivity(
        options?: LaunchActivityOptions,
    ): Promise<undefined | InteractionCallbackResponse<BooleanCache<Cached>>>;
    reply(
        options: InteractionReplyOptions & { withResponse: true },
    ): Promise<InteractionCallbackResponse<BooleanCache<Cached>>>;
    reply(
        options: InteractionReplyOptions & { fetchReply: true },
    ): Promise<Message<BooleanCache<Cached>>>;
    reply(
        options: string | MessagePayload | InteractionReplyOptions,
    ): Promise<InteractionResponse<BooleanCache<Cached>>>;
    sendPremiumRequired(): Promise<void>;
    toJSON(...props: Record<string, string | boolean>[]): unknown;
    update(
        options: InteractionUpdateOptions & { withResponse: true },
    ): Promise<InteractionCallbackResponse<BooleanCache<Cached>>>;
    update(
        options: InteractionUpdateOptions & { fetchReply: true },
    ): Promise<Message<boolean>>;
    update(
        options: string | MessagePayload | InteractionUpdateOptions,
    ): Promise<InteractionResponse<BooleanCache<Cached>>>;
    valueOf(): string;
}

Type Parameters

Hierarchy (View Summary)

Properties

applicationId appPermissions attachmentSizeLimit authorizingIntegrationOwners channelId client components context customId deferred entitlements ephemeral fields guildId guildLocale id locale member memberPermissions message replied token type user version webhook

Accessors

channel createdAt createdTimestamp guild

Methods

deferReply deferUpdate deleteReply editReply fetchReply followUp inCachedGuild inGuild inRawGuild isAnySelectMenu isAutocomplete isButton isChannelSelectMenu isChatInputCommand isCommand isContextMenuCommand isFromMessage isMentionableSelectMenu isMessageComponent isMessageContextMenuCommand isModalSubmit isPrimaryEntryPointCommand isRepliable isRoleSelectMenu isSelectMenu isStringSelectMenu isUserContextMenuCommand isUserSelectMenu launchActivity reply sendPremiumRequired toJSON update valueOf

Properties

applicationId

applicationId: string

appPermissions

appPermissions: Readonly<PermissionsBitField>

attachmentSizeLimit

attachmentSizeLimit: number

authorizingIntegrationOwners

authorizingIntegrationOwners: APIAuthorizingIntegrationOwnersMap

channelId

channelId: string

Readonlyclient

client: Client<true>

Readonlycomponents

components: ActionRowModalData[]

context

context: null | InteractionContextType

ReadonlycustomId

customId: string

deferred

deferred: boolean

entitlements

entitlements: Collection<string, Entitlement>

ephemeral

ephemeral: null | boolean

Readonlyfields

fields: ModalSubmitFields

guildId

guildId: CacheTypeReducer<Cached, string>

guildLocale

guildLocale: CacheTypeReducer<Cached, Locale>

id

id: string

locale

locale: Locale

member

member: CacheTypeReducer<Cached, GuildMember, APIInteractionGuildMember>

memberPermissions

memberPermissions: CacheTypeReducer<Cached, Readonly<PermissionsBitField>>

message

message: Message<BooleanCache<Cached>>

replied

replied: boolean

Readonlytoken

token: string

type

type: ModalSubmit

user

user: User

version

version: number

Readonlywebhook

webhook: InteractionWebhook

Accessors

channel

createdAt

  • get createdAt(): Date

    Returns Date

createdTimestamp

  • get createdTimestamp(): number

    Returns number

guild

Methods

deferReply

deferUpdate

deleteReply

editReply

fetchReply

followUp

inCachedGuild

inGuild

inRawGuild

isAnySelectMenu

isAutocomplete

isButton

isChannelSelectMenu

isChatInputCommand

isCommand

isContextMenuCommand

isFromMessage

isMentionableSelectMenu

isMessageComponent

isMessageContextMenuCommand

isModalSubmit

isPrimaryEntryPointCommand

isRepliable

isRoleSelectMenu

isSelectMenu

isStringSelectMenu

isUserContextMenuCommand

isUserSelectMenu

launchActivity

reply

sendPremiumRequired

toJSON

  • toJSON(...props: Record<string, string | boolean>[]): unknown

    Parameters

    • ...props: Record<string, string | boolean>[]

    Returns unknown

update

valueOf

Settings

Member Visibility

On This Page

Properties
Accessors
Methods