Class ModalContext<M>

Represents a context for interacting with components in a Discord bot.

Template: Type

The type of component interaction.

Type Parameters

M extends keyof RegisteredMiddlewares = never

Hierarchy (View Summary)

BaseContext
ExtendContext
- ModalContext

Constructors

constructor

new ModalContext<M extends never = never>(
client: UsingClient,
interaction: ModalSubmitInteraction,
): ModalContext<M>
Creates a new instance of the ComponentContext class.
Type Parameters
- M extends never = never
Parameters
- client: UsingClient
  The UsingClient instance.
- interaction: ModalSubmitInteraction
  The component interaction object.
Returns ModalContext<M>
Inherited from BaseContext.constructor
- Defined in src/components/modalcontext.ts:35

Properties

`Readonly`client

client: UsingClient

The UsingClient instance.

command

command: ModalCommand

globalMetadata

globalMetadata: GlobalMetadata = {}

interaction

interaction: ModalSubmitInteraction

The component interaction object.

metadata

metadata: CommandMetadata<UnionToTuple<M, []>> = ...

Accessors

author

get author(): User
Gets the author of the interaction.

Returns User
- Defined in src/components/modalcontext.ts:198

channelId

get channelId(): string
Gets the ID of the channel of the interaction.

Returns string
- Defined in src/components/modalcontext.ts:191

components

get components(): {
components: { customId: string; type: ComponentType; value: string }[];
type: ActionRow;
}[]
Returns {
components: { customId: string; type: ComponentType; value: string }[];
type: ActionRow;
}[]
- Defined in src/components/modalcontext.ts:50

customId

get customId(): string
Returns string
- Defined in src/components/modalcontext.ts:46

guildId

get guildId(): undefined | string
Gets the ID of the guild of the interaction.

Returns undefined | string
- Defined in src/components/modalcontext.ts:184

member

get member(): undefined | InteractionGuildMember
Gets the member of the interaction.

Returns undefined | InteractionGuildMember
- Defined in src/components/modalcontext.ts:205

proxy

get proxy(): APIRoutes
Gets the proxy object.

Returns APIRoutes
Inherited from BaseContext.proxy
- Defined in src/commands/basecontext.ts:15

t

get t(): __InternalParseLocale<DefaultLocale> & {
get(locale?: string): DefaultLocale;
}
Gets the language object for the interaction's locale.

Returns __InternalParseLocale<DefaultLocale> & { get(locale?: string): DefaultLocale }
- Defined in src/components/modalcontext.ts:57

Methods

channel

channel(mode?: "rest" | "flow"): Promise<AllChannels>
Gets the channel of the interaction.
Parameters
- Optionalmode: "rest" | "flow"
  The mode to fetch the channel.
Returns Promise<AllChannels>
A promise that resolves to the channel.
- Defined in src/components/modalcontext.ts:135
channel(mode: "cache"): ReturnCache<AllChannels>
Gets the channel of the interaction.
Parameters
- mode: "cache"
  The mode to fetch the channel.
Returns ReturnCache<AllChannels>
A promise that resolves to the channel.
- Defined in src/components/modalcontext.ts:136

deferReply

deferReply<FR extends boolean = false>(
ephemeral?: boolean,
fetchReply?: FR,
): Promise<When<FR, WebhookMessage, undefined>>
Defers the reply to the interaction.
Type Parameters
- FR extends boolean = false
Parameters
- ephemeral: boolean = false
  Whether the reply should be ephemeral or not.
- OptionalfetchReply: FR
Returns Promise<When<FR, WebhookMessage, undefined>>
- Defined in src/components/modalcontext.ts:77

deleteResponse

deleteResponse(): Promise<void>
Deletes the response of the interaction.

Returns Promise<void>
A promise that resolves when the response is deleted.
- Defined in src/components/modalcontext.ts:119

editOrReply

editOrReply<FR extends boolean = false>(
    body:
        | Omit<
            APIInteractionResponseCallbackData,
            "components"
            | "content"
            | "embeds"
            | "poll",
        > & SendResolverProps
        | InteractionMessageUpdateBodyRequest,
    fetchReply?: FR,
): Promise<When<FR, WebhookMessage, void>>
Edits the response or replies to the interaction.
Type Parameters
- FR extends boolean = false
Parameters
- body:
      | Omit<
          APIInteractionResponseCallbackData,
          "components"
          | "content"
          | "embeds"
          | "poll",
      > & SendResolverProps
      | InteractionMessageUpdateBodyRequest
  The body of the response or updated body of the interaction.
- OptionalfetchReply: FR
  Whether to fetch the reply or not.
Returns Promise<When<FR, WebhookMessage, void>>
- Defined in src/components/modalcontext.ts:97

editResponse

editResponse(body: InteractionMessageUpdateBodyRequest): Promise<WebhookMessage>
Edits the response of the interaction.
Parameters
- body: InteractionMessageUpdateBodyRequest
  The updated body of the response.
Returns Promise<WebhookMessage>
- Defined in src/components/modalcontext.ts:88

fetchResponse

fetchResponse(): Promise<WebhookMessage>
Returns Promise<WebhookMessage>
A Promise that resolves to the fetched message
- Defined in src/components/modalcontext.ts:111

followup

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

guild

guild(mode?: "rest" | "flow"): Promise<undefined | Guild<"cached" | "api">>
Gets the guild of the interaction.
Parameters
- Optionalmode: "rest" | "flow"
  The mode to fetch the guild.
Returns Promise<undefined | Guild<"cached" | "api">>
A promise that resolves to the guild.
- Defined in src/components/modalcontext.ts:166
guild(mode: "cache"): ReturnCache<undefined | Guild<"cached">>
Gets the guild of the interaction.
Parameters
- mode: "cache"
  The mode to fetch the guild.
Returns ReturnCache<undefined | Guild<"cached">>
A promise that resolves to the guild.
- Defined in src/components/modalcontext.ts:167

inGuild

inGuild(): this is GuildModalContext<M>
Returns this is GuildModalContext<M>
- Defined in src/components/modalcontext.ts:213

isButton

isButton(): this is ComponentContext<"Button", never>
Returns this is ComponentContext<"Button", never>
Inherited from BaseContext.isButton
- Defined in src/commands/basecontext.ts:43

isChannelSelectMenu

isChannelSelectMenu(): this is ComponentContext<"ChannelSelect", never>
Returns this is ComponentContext<"ChannelSelect", never>
Inherited from BaseContext.isChannelSelectMenu
- Defined in src/commands/basecontext.ts:47

isChat

isChat(): this is CommandContext<{}, never>
Returns this is CommandContext<{}, never>
Inherited from BaseContext.isChat
- Defined in src/commands/basecontext.ts:19

isComponent

isComponent(): this is ComponentContext<
keyof ContextComponentCommandInteractionMap,
never,
>
Returns this is ComponentContext<keyof ContextComponentCommandInteractionMap, never>
Inherited from BaseContext.isComponent
- Defined in src/commands/basecontext.ts:35

isEntryPoint

isEntryPoint(): this is EntryPointContext<never>
Returns this is EntryPointContext<never>
Inherited from BaseContext.isEntryPoint
- Defined in src/commands/basecontext.ts:67

isMentionableSelectMenu

isMentionableSelectMenu(): this is ComponentContext<"MentionableSelect", never>
Returns this is ComponentContext<"MentionableSelect", never>
Inherited from BaseContext.isMentionableSelectMenu
- Defined in src/commands/basecontext.ts:55

isMenu

isMenu(): this is MenuCommandContext<
    UserCommandInteraction<boolean>
    | MessageCommandInteraction<boolean>,
    never,
>
Returns this is MenuCommandContext<
    UserCommandInteraction<boolean>
    | MessageCommandInteraction<boolean>,
    never,
>
Inherited from BaseContext.isMenu
- Defined in src/commands/basecontext.ts:23

isMenuMessage

isMenuMessage(): this is MenuCommandContext<
MessageCommandInteraction<boolean>,
never,
>
Returns this is MenuCommandContext<MessageCommandInteraction<boolean>, never>
Inherited from BaseContext.isMenuMessage
- Defined in src/commands/basecontext.ts:31

isMenuUser

isMenuUser(): this is MenuCommandContext<UserCommandInteraction<boolean>, never>
Returns this is MenuCommandContext<UserCommandInteraction<boolean>, never>
Inherited from BaseContext.isMenuUser
- Defined in src/commands/basecontext.ts:27

isModal

isModal(): this is ModalContext<M>
Returns this is ModalContext<M>
Inherited from BaseContext.isModal
- Defined in src/components/modalcontext.ts:209

isRoleSelectMenu

isRoleSelectMenu(): this is ComponentContext<"RoleSelect", never>
Returns this is ComponentContext<"RoleSelect", never>
Inherited from BaseContext.isRoleSelectMenu
- Defined in src/commands/basecontext.ts:51

isStringSelectMenu

isStringSelectMenu(): this is ComponentContext<"StringSelect", never>
Returns this is ComponentContext<"StringSelect", never>
Inherited from BaseContext.isStringSelectMenu
- Defined in src/commands/basecontext.ts:63

isUserSelectMenu

isUserSelectMenu(): this is ComponentContext<"UserSelect", never>
Returns this is ComponentContext<"UserSelect", never>
Inherited from BaseContext.isUserSelectMenu
- Defined in src/commands/basecontext.ts:59

me

me(mode?: "rest" | "flow"): Promise<undefined | GuildMember>
Gets the bot member in the guild of the interaction.
Parameters
- Optionalmode: "rest" | "flow"
  The mode to fetch the member.
Returns Promise<undefined | GuildMember>
A promise that resolves to the bot member.
- Defined in src/components/modalcontext.ts:148
me(mode: "cache"): ReturnCache<undefined | GuildMember>
Gets the bot member in the guild of the interaction.
Parameters
- mode: "cache"
  The mode to fetch the member.
Returns ReturnCache<undefined | GuildMember>
A promise that resolves to the bot member.
- Defined in src/components/modalcontext.ts:149

modal(body: ModalCreateBodyRequest, options?: undefined): Promise<undefined>
Parameters
- body: ModalCreateBodyRequest
- Optionaloptions: undefined
Returns Promise<undefined>
- Defined in src/components/modalcontext.ts:123
modal(
body: ModalCreateBodyRequest,
options: ModalCreateOptions,
): Promise<null | ModalSubmitInteraction<boolean>>
Parameters
- body: ModalCreateBodyRequest
- options: ModalCreateOptions
Returns Promise<null | ModalSubmitInteraction<boolean>>
- Defined in src/components/modalcontext.ts:124

write

write<FR extends boolean = false>(
    body: Omit<
        APIInteractionResponseCallbackData,
        "components"
        | "content"
        | "embeds"
        | "poll",
    > & SendResolverProps,
    fetchReply?: FR,
): Promise<When<FR, WebhookMessage, void>>
Writes a response to the interaction.
Type Parameters
- FR extends boolean = false
Parameters
- body: Omit<
      APIInteractionResponseCallbackData,
      "components"
      | "content"
      | "embeds"
      | "poll",
  > & SendResolverProps
  The body of the response.
- OptionalfetchReply: FR
  Whether to fetch the reply or not.
Returns Promise<When<FR, WebhookMessage, void>>
- Defined in src/components/modalcontext.ts:66

Class ModalContext<M>

Template: Type

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ModalContext<M>

Properties

Readonlyclient

command

globalMetadata

interaction

metadata

Accessors

author

Returns User

channelId

Returns string

components

Returns { components: { customId: string; type: ComponentType; value: string }[]; type: ActionRow;}[]

customId

Returns string

guildId

Returns undefined | string

member

Returns undefined | InteractionGuildMember

proxy

Returns APIRoutes

t

Returns __InternalParseLocale<DefaultLocale> & { get(locale?: string): DefaultLocale }

Methods

channel

Parameters

Returns Promise<AllChannels>

Parameters

Returns ReturnCache<AllChannels>

deferReply

Type Parameters

Parameters

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

deleteResponse

Returns Promise<void>

editOrReply

Type Parameters

Parameters

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

editResponse

Parameters

Returns Promise<WebhookMessage>

fetchResponse

Returns Promise<WebhookMessage>

followup

Parameters

Returns Promise<WebhookMessage>

guild

Parameters

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

Parameters

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

inGuild

Returns this is GuildModalContext<M>

isButton

Returns this is ComponentContext<"Button", never>

isChannelSelectMenu

Returns this is ComponentContext<"ChannelSelect", never>

isChat

Returns this is CommandContext<{}, never>

isComponent

Returns this is ComponentContext<keyof ContextComponentCommandInteractionMap, never>

isEntryPoint

Returns this is EntryPointContext<never>

isMentionableSelectMenu

Returns this is ComponentContext<"MentionableSelect", never>

`Readonly`client

Returns {
components: { customId: string; type: ComponentType; value: string }[];
type: ActionRow;
}[]

Returns this is MenuCommandContext<
UserCommandInteraction<boolean>
| MessageCommandInteraction<boolean>,
never,
>