Class ModalSubmitInteraction<FromGuild>

Type Parameters

FromGuild extends boolean = boolean

Hierarchy (View Summary)

Omit<Interaction<FromGuild, APIModalSubmitInteraction>, "modal">
BaseInteraction<FromGuild>
- ModalSubmitInteraction

Constructors

constructor

new ModalSubmitInteraction<FromGuild extends boolean = boolean>(
    client: UsingClient,
    interaction: APIInteraction,
    __reply?: __InternalReplyFunction,
): ModalSubmitInteraction<FromGuild>
Type Parameters
- FromGuild extends boolean = boolean
Parameters
- client: UsingClient
- interaction: APIInteraction
- Optional__reply: __InternalReplyFunction
Returns ModalSubmitInteraction<FromGuild>
Inherited from BaseInteraction.constructor
- Defined in src/structures/Interaction.ts:109

Properties

`Protected` `Optional`__reply

__reply?: __InternalReplyFunction

applicationId

applicationId: string

appPermissions

appPermissions: PermissionsBitField

attachmentSizeLimit

attachmentSizeLimit: number

authorizingIntegrationOwners

authorizingIntegrationOwners: { "0"?: string; "1"?: string }

channel

channel: AllChannels

`Readonly`client

client: UsingClient

`Optional`context

context?: InteractionContextType

data

data: {
    components: {
        component: {
            customId: string;
            type: ComponentType;
            value?: string;
            values?: string[];
        };
        type: ActionRow;
    }[];
    customId: string;
    resolved?: {
        attachments: {
            [key: Lowercase<string>]: {
                contentType?: string;
                description?: string;
                ephemeral?: boolean;
                filename: string;
                flags?: AttachmentFlags;
                height?: number | null;
                id: string;
                proxyUrl: string;
                size: number;
                title?: string;
                url: string;
                width?: number | null;
            };
        };
    };
}

entitlements

entitlements: Entitlement[]

`Optional`guild

guild?: { features: GuildFeature[]; id: string; locale: Locale }

`Optional`guildId

guildId?: string

`Optional`guildLocale

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"

id

id: string

locale

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"

member

member: When<FromGuild, InteractionGuildMember, undefined>

`Optional`message

message?: Message

`Optional`replied

replied?:
| boolean
| Promise<boolean | RESTPostAPIInteractionCallbackResult | undefined>

token

token: string

user

user: User

version

version: 1

Accessors

components

get components(): {
    component: {
        customId: string;
        type: ComponentType;
        value?: string;
        values?: string[];
    };
    type: ActionRow;
}[]
Returns {
    component: {
        customId: string;
        type: ComponentType;
        value?: string;
        values?: string[];
    };
    type: ActionRow;
}[]
- Defined in src/structures/Interaction.ts:868

createdAt

get createdAt(): Date
createdAt gets the creation Date instace of the current object.

Returns Date
Inherited from AnonymousGuild.createdAt
- Defined in src/structures/extra/DiscordBase.ts:27

createdTimestamp

get createdTimestamp(): number
Create a timestamp for the current object.

Returns number
Inherited from AnonymousGuild.createdTimestamp
- Defined in src/structures/extra/DiscordBase.ts:20

customId

get customId(): string
Returns string
- Defined in src/structures/Interaction.ts:864

Methods

deferReply

deferReply<WR extends boolean = false>(
flags?: MessageFlags,
withResponse?: WR,
): Promise<When<WR, WebhookMessage, undefined>>
Type Parameters
- WR extends boolean = false
Parameters
- Optionalflags: MessageFlags
- OptionalwithResponse: WR
Returns Promise<When<WR, WebhookMessage, undefined>>
Inherited from BaseInteraction.deferReply
- Defined in src/structures/Interaction.ts:255

deferUpdate

deferUpdate<WR extends boolean = false>(
withResponse?: WR,
): Promise<When<WR, WebhookMessage, undefined>>
Type Parameters
- WR extends boolean = false
Parameters
- OptionalwithResponse: WR
Returns Promise<When<WR, WebhookMessage, undefined>>
- Defined in src/structures/Interaction.ts:855

deleteMessage

deleteMessage(messageId: string): Promise<void>
Parameters
- messageId: string
Returns Promise<void>
Inherited from Omit.deleteMessage
- Defined in src/structures/Interaction.ts:540

deleteResponse

deleteResponse(): Promise<void>
Returns Promise<void>
Inherited from Omit.deleteResponse
- Defined in src/structures/Interaction.ts:536

editMessage

editMessage(
messageId: string,
body: InteractionMessageUpdateBodyRequest,
): Promise<WebhookMessage>
Parameters
- messageId: string
- body: InteractionMessageUpdateBodyRequest
Returns Promise<WebhookMessage>
Inherited from Omit.editMessage
- Defined in src/structures/Interaction.ts:528

editOrReply

editOrReply<FR extends boolean = false>(
    body: Omit<
        APIInteractionResponseCallbackData,
        "components"
        | "content"
        | "embeds"
        | "poll",
    > & SendResolverProps,
    fetchReply?: FR,
): Promise<When<FR, WebhookMessage, void>>
Type Parameters
- FR extends boolean = false
Parameters
- body: Omit<
      APIInteractionResponseCallbackData,
      "components"
      | "content"
      | "embeds"
      | "poll",
  > & SendResolverProps
- OptionalfetchReply: FR
Returns Promise<When<FR, WebhookMessage, void>>
Inherited from Omit.editOrReply
- Defined in src/structures/Interaction.ts:513

editResponse

editResponse(body: InteractionMessageUpdateBodyRequest): Promise<WebhookMessage>
Parameters
- body: InteractionMessageUpdateBodyRequest
Returns Promise<WebhookMessage>
Inherited from Omit.editResponse
- Defined in src/structures/Interaction.ts:532

fetchGuild

fetchGuild(mode?: "rest" | "flow"): Promise<Guild<"cached" | "api"> | undefined>
Parameters
- Optionalmode: "rest" | "flow"
Returns Promise<Guild<"cached" | "api"> | undefined>
Inherited from BaseInteraction.fetchGuild
- Defined in src/structures/Interaction.ts:373
fetchGuild(mode: "cache"): ReturnCache<Guild<"cached"> | undefined>
Parameters
- mode: "cache"
Returns ReturnCache<Guild<"cached"> | undefined>
Inherited from BaseInteraction.fetchGuild
- Defined in src/structures/Interaction.ts:374

fetchMessage

fetchMessage(messageId: string): Promise<WebhookMessage>
Parameters
- messageId: string
Returns Promise<WebhookMessage>
Inherited from Omit.fetchMessage
- Defined in src/structures/Interaction.ts:459

fetchResponse

fetchResponse(): Promise<WebhookMessage>
Returns Promise<WebhookMessage>
Inherited from Omit.fetchResponse
- Defined in src/structures/Interaction.ts:463

followup

followup(
    body: Omit<
        RESTPostAPIWebhookWithTokenJSONBody,
        "components"
        | "content"
        | "embeds"
        | "poll",
    > & SendResolverProps,
): Promise<WebhookMessage>
Parameters
- body: Omit<
      RESTPostAPIWebhookWithTokenJSONBody,
      "components"
      | "content"
      | "embeds"
      | "poll",
  > & SendResolverProps
Returns Promise<WebhookMessage>
Inherited from Omit.followup
- Defined in src/structures/Interaction.ts:544

getFiles

getFiles(customId: string, required: true): Attachment[]
Parameters
- customId: string
- required: true
Returns Attachment[]
- Defined in src/structures/Interaction.ts:885
getFiles(customId: string, required?: false): Attachment[] | undefined
Parameters
- customId: string
- Optionalrequired: false
Returns Attachment[] | undefined
- Defined in src/structures/Interaction.ts:886

getInputValue

getInputValue(customId: string, required: true): string | string[]
Parameters
- customId: string
- required: true
Returns string | string[]
- Defined in src/structures/Interaction.ts:872
getInputValue(customId: string, required?: false): string | string[] | undefined
Parameters
- customId: string
- Optionalrequired: false
Returns string | string[] | undefined
- Defined in src/structures/Interaction.ts:873

reply

reply<WR extends boolean = false>(
body: ReplyInteractionBody,
withResponse?: WR,
): Promise<When<WR, WebhookMessage, undefined>>
Type Parameters
- WR extends boolean = false
Parameters
- body: ReplyInteractionBody
- OptionalwithResponse: WR
Returns Promise<When<WR, WebhookMessage, undefined>>
Inherited from BaseInteraction.reply
- Defined in src/structures/Interaction.ts:238

update

update<WR extends boolean = false>(
    data: Omit<
        APIInteractionResponseCallbackData,
        "components"
        | "content"
        | "embeds",
    > & ResolverProps,
    withResponse?: WR,
): Promise<When<WR, WebhookMessage, undefined>>
Type Parameters
- WR extends boolean = false
Parameters
- data: Omit<APIInteractionResponseCallbackData, "components" | "content" | "embeds"> & ResolverProps
- OptionalwithResponse: WR
Returns Promise<When<WR, WebhookMessage, undefined>>
- Defined in src/structures/Interaction.ts:842

write

write<FR extends boolean = false>(
    body: Omit<
        APIInteractionResponseCallbackData,
        "components"
        | "content"
        | "embeds"
        | "poll",
    > & SendResolverProps,
    withResponse?: FR,
): Promise<When<FR, WebhookMessage, void>>
Type Parameters
- FR extends boolean = false
Parameters
- body: Omit<
      APIInteractionResponseCallbackData,
      "components"
      | "content"
      | "embeds"
      | "poll",
  > & SendResolverProps
- OptionalwithResponse: FR
Returns Promise<When<FR, WebhookMessage, void>>
Inherited from Omit.write
- Defined in src/structures/Interaction.ts:467

`Static`from

from(
    client: UsingClient,
    gateway: APIInteraction,
    __reply?: __InternalReplyFunction,
):
    | ModalSubmitInteraction<boolean>
    | ButtonInteraction
    | ChannelSelectMenuInteraction
    | RoleSelectMenuInteraction
    | MentionableSelectMenuInteraction
    | UserSelectMenuInteraction
    | StringSelectMenuInteraction<string[]>
    | ChatInputCommandInteraction<boolean>
    | UserCommandInteraction<boolean>
    | MessageCommandInteraction<boolean>
    | AutocompleteInteraction<boolean>
    | BaseInteraction<boolean, APIPingInteraction>
    | undefined
Parameters
- client: UsingClient
- gateway: APIInteraction
- Optional__reply: __InternalReplyFunction
Returns
    | ModalSubmitInteraction<boolean>
    | ButtonInteraction
    | ChannelSelectMenuInteraction
    | RoleSelectMenuInteraction
    | MentionableSelectMenuInteraction
    | UserSelectMenuInteraction
    | StringSelectMenuInteraction<string[]>
    | ChatInputCommandInteraction<boolean>
    | UserCommandInteraction<boolean>
    | MessageCommandInteraction<boolean>
    | AutocompleteInteraction<boolean>
    | BaseInteraction<boolean, APIPingInteraction>
    | undefined
Inherited from BaseInteraction.from
- Defined in src/structures/Interaction.ts:318

`Static`transformBody

transformBody<T>(
    body:
        | Omit<
            RESTPostAPIChannelMessageJSONBody,
            "components"
            | "content"
            | "embeds"
            | "poll",
        > & SendResolverProps
        | Omit<
            APIInteractionResponseCallbackData,
            "components"
            | "content"
            | "embeds"
            | "poll",
        > & SendResolverProps
        | InteractionMessageUpdateBodyRequest
        | Omit<
            RESTPatchAPIChannelMessageJSONBody,
            "components"
            | "content"
            | "embeds",
        > & ResolverProps
        | Omit<
            RESTPostAPIWebhookWithTokenJSONBody,
            "components"
            | "content"
            | "embeds"
            | "poll",
        > & SendResolverProps,
    files: RawFile[] | undefined,
    self: UsingClient,
): T
Type Parameters
- T
Parameters
- body:
      | Omit<
          RESTPostAPIChannelMessageJSONBody,
          "components"
          | "content"
          | "embeds"
          | "poll",
      > & SendResolverProps
      | Omit<
          APIInteractionResponseCallbackData,
          "components"
          | "content"
          | "embeds"
          | "poll",
      > & SendResolverProps
      | InteractionMessageUpdateBodyRequest
      | Omit<
          RESTPatchAPIChannelMessageJSONBody,
          "components"
          | "content"
          | "embeds",
      > & ResolverProps
      | Omit<
          RESTPostAPIWebhookWithTokenJSONBody,
          "components"
          | "content"
          | "embeds"
          | "poll",
      > & SendResolverProps
- files: RawFile[] | undefined
- self: UsingClient
Returns T
Inherited from BaseInteraction.transformBody
- Defined in src/structures/Interaction.ts:174

`Static`transformBodyRequest

transformBodyRequest(
    body: ReplyInteractionBody,
    files: RawFile[] | undefined,
    self: UsingClient,
): APIInteractionResponse
Parameters
- body: ReplyInteractionBody
- files: RawFile[] | undefined
- self: UsingClient
Returns APIInteractionResponse
Inherited from BaseInteraction.transformBodyRequest
- Defined in src/structures/Interaction.ts:135

Class ModalSubmitInteraction<FromGuild>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ModalSubmitInteraction<FromGuild>

Properties

Protected Optional__reply

applicationId

appPermissions

attachmentSizeLimit

authorizingIntegrationOwners

channel

Readonlyclient

Optionalcontext

data

entitlements

Optionalguild

OptionalguildId

OptionalguildLocale

id

locale

member

Optionalmessage

Optionalreplied

token

user

version

Accessors

components

Returns { component: { customId: string; type: ComponentType; value?: string; values?: string[]; }; type: ActionRow;}[]

createdAt

Returns Date

createdTimestamp

Returns number

customId

Returns string

Methods

deferReply

Type Parameters

Parameters

Returns Promise<When<WR, WebhookMessage, undefined>>

deferUpdate

Type Parameters

Parameters

Returns Promise<When<WR, WebhookMessage, undefined>>

deleteMessage

Parameters

Returns Promise<void>

deleteResponse

Returns Promise<void>

editMessage

Parameters

Returns Promise<WebhookMessage>

editOrReply

Type Parameters

Parameters

Returns Promise<When<FR, WebhookMessage, void>>

editResponse

Parameters

Returns Promise<WebhookMessage>

fetchGuild

Parameters

Returns Promise<Guild<"cached" | "api"> | undefined>

Parameters

Returns ReturnCache<Guild<"cached"> | undefined>

fetchMessage

Parameters

Returns Promise<WebhookMessage>

fetchResponse

Returns Promise<WebhookMessage>

followup

Parameters

`Protected` `Optional`__reply

`Readonly`client

`Optional`context

`Optional`guild

`Optional`guildId

`Optional`guildLocale

`Optional`message

`Optional`replied

Returns {
component: {
customId: string;
type: ComponentType;
value?: string;
values?: string[];
};
type: ActionRow;
}[]

`Static`from

`Static`transformBody

`Static`transformBodyRequest