Class StringSelectMenuInteraction<T>

Type Parameters

T extends any[] = string[]

Hierarchy

{
    api: APIRoutes;
    applicationId: string;
    appPermissions: PermissionsBitField;
    attachmentSizeLimit: number;
    authorizingIntegrationOwners: { "0"?: string; "1"?: string };
    cache: Cache;
    channel: AllChannels;
    client: UsingClient;
    componentType:
        | Button
        | StringSelect
        | UserSelect
        | RoleSelect
        | MentionableSelect
        | ChannelSelect;
    context?: InteractionContextType;
    createdAt: Date;
    createdTimestamp: number;
    customId: string;
    entitlements: Entitlement[];
    guild?: { features: GuildFeature[]; id: string; locale: Locale };
    guildId?: 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";
    id: string;
    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: undefined
    | InteractionGuildMember;
    message: Message;
    replied?:
        | boolean
        | Promise<undefined | boolean | RESTPostAPIInteractionCallbackResult>;
    rest: ApiHandler;
    token: string;
    type: MessageComponent;
    user: User;
    values: string[];
    version: 1;
    deferReply<WR extends boolean = false>(
        flags?: MessageFlags,
        withResponse?: WR,
    ): Promise<When<WR, WebhookMessage, undefined>>;
    deferUpdate(): Promise<undefined>;
    deleteMessage(messageId: string): Promise<void>;
    deleteResponse(): Promise<void>;
    editMessage(
        messageId: string,
        body: InteractionMessageUpdateBodyRequest,
    ): Promise<WebhookMessage>;
    editOrReply<FR extends boolean = false>(
        body: Omit<
            APIInteractionResponseCallbackData,
            "components"
            | "content"
            | "embeds"
            | "poll",
        > & SendResolverProps,
        fetchReply?: FR,
    ): Promise<When<FR, WebhookMessage, void>>;
    editResponse(
        body: InteractionMessageUpdateBodyRequest,
    ): Promise<WebhookMessage>;
    fetchGuild(
        mode?: "rest" | "flow",
    ): Promise<undefined | Guild<"cached" | "api">>;
    fetchGuild(mode: "cache"): ReturnCache<undefined | Guild<"cached">>;
    fetchMessage(messageId: string): Promise<WebhookMessage>;
    fetchResponse(): Promise<WebhookMessage>;
    followup(
        body: Omit<
            RESTPostAPIWebhookWithTokenJSONBody,
            "components"
            | "content"
            | "embeds"
            | "poll",
        > & SendResolverProps,
    ): Promise<WebhookMessage>;
    isAutocomplete(): this is AutocompleteInteraction<boolean>;
    isButton(): this is ButtonInteraction;
    isChannelSelectMenu(): this is ChannelSelectMenuInteraction;
    isChatInput(): this is ChatInputCommandInteraction<boolean>;
    isEntryPoint(): this is EntryPointInteraction<boolean>;
    isMentionableSelectMenu(): this is MentionableSelectMenuInteraction;
    isMessage(): this is MessageCommandInteraction<boolean>;
    isModal(): this is ModalSubmitInteraction<boolean>;
    isRoleSelectMenu(): this is RoleSelectMenuInteraction;
    isUser(): this is UserCommandInteraction<boolean>;
    isUserSelectMenu(): this is UserSelectMenuInteraction;
    modal(
        body: ModalCreateBodyRequest,
        options?: undefined,
    ): Promise<undefined>;
    modal(
        body: ModalCreateBodyRequest,
        options: ModalCreateOptions,
    ): Promise<null | ModalSubmitInteraction<boolean>>;
    reply<WR extends boolean = false>(
        body: ReplyInteractionBody,
        withResponse?: WR,
    ): Promise<When<WR, WebhookMessage, undefined>>;
    update(
        data: Omit<
            APIInteractionResponseCallbackData,
            "components"
            | "content"
            | "embeds",
        > & ResolverProps,
    ): Promise<undefined>;
    write<FR extends boolean = false>(
        body: Omit<
            APIInteractionResponseCallbackData,
            "components"
            | "content"
            | "embeds"
            | "poll",
        > & SendResolverProps,
        withResponse?: FR,
    ): Promise<When<FR, WebhookMessage, void>>;
}
- StringSelectMenuInteraction

Constructors

constructor

new StringSelectMenuInteraction<T extends any[] = string[]>(
...args: any[],
): StringSelectMenuInteraction<T>
Type Parameters
- T extends any[] = string[]
Parameters
- ...args: any[]
Returns StringSelectMenuInteraction<T>
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).constructor
- Defined in src/common/types/util.ts:3

Properties

api

api: APIRoutes

applicationId

applicationId: string

appPermissions

appPermissions: PermissionsBitField

attachmentSizeLimit

attachmentSizeLimit: number

authorizingIntegrationOwners

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

cache

cache: Cache

channel

channel: AllChannels

`Readonly`client

client: UsingClient

componentType

`Optional`context

context?: InteractionContextType

createdAt

createdAt: Date

createdTimestamp

createdTimestamp: number

customId

customId: string

data

data: Omit<
{ componentType: StringSelect; customId: string; values: string[] },
"values",
> & { values: T }

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: undefined | InteractionGuildMember

message

message: Message

`Optional`replied

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

rest

rest: ApiHandler

token

token: string

type

type: MessageComponent

user

user: User

values

values: T

version

version: 1

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 (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).deferReply
- Defined in src/structures/Interaction.ts:251

deferUpdate

deferUpdate(): Promise<undefined>
Returns Promise<undefined>
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).deferUpdate
- Defined in src/structures/Interaction.ts:646

deleteMessage

deleteMessage(messageId: string): Promise<void>
Parameters
- messageId: string
Returns Promise<void>
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).deleteMessage
- Defined in src/structures/Interaction.ts:536

deleteResponse

deleteResponse(): Promise<void>
Returns Promise<void>
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).deleteResponse
- Defined in src/structures/Interaction.ts:532

editMessage

editMessage(
messageId: string,
body: InteractionMessageUpdateBodyRequest,
): Promise<WebhookMessage>
Parameters
- messageId: string
- body: InteractionMessageUpdateBodyRequest
Returns Promise<WebhookMessage>
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).editMessage
- Defined in src/structures/Interaction.ts:524

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 (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).editOrReply
- Defined in src/structures/Interaction.ts:509

editResponse

editResponse(body: InteractionMessageUpdateBodyRequest): Promise<WebhookMessage>
Parameters
- body: InteractionMessageUpdateBodyRequest
Returns Promise<WebhookMessage>
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).editResponse
- Defined in src/structures/Interaction.ts:528

fetchGuild

fetchGuild(mode?: "rest" | "flow"): Promise<undefined | Guild<"cached" | "api">>
Parameters
- Optionalmode: "rest" | "flow"
Returns Promise<undefined | Guild<"cached" | "api">>
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).fetchGuild
- Defined in src/structures/Interaction.ts:369
fetchGuild(mode: "cache"): ReturnCache<undefined | Guild<"cached">>
Parameters
- mode: "cache"
Returns ReturnCache<undefined | Guild<"cached">>
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).fetchGuild
- Defined in src/structures/Interaction.ts:370

fetchMessage

fetchMessage(messageId: string): Promise<WebhookMessage>
Parameters
- messageId: string
Returns Promise<WebhookMessage>
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).fetchMessage
- Defined in src/structures/Interaction.ts:455

fetchResponse

fetchResponse(): Promise<WebhookMessage>
Returns Promise<WebhookMessage>
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).fetchResponse
- Defined in src/structures/Interaction.ts:459

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 (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).followup
- Defined in src/structures/Interaction.ts:540

isAutocomplete

isAutocomplete(): this is AutocompleteInteraction<boolean>
Returns this is AutocompleteInteraction<boolean>
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).isAutocomplete
- Defined in src/structures/Interaction.ts:302

isButton

isButton(): this is ButtonInteraction
Returns this is ButtonInteraction
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).isButton
- Defined in src/structures/Interaction.ts:266

isChannelSelectMenu

isChannelSelectMenu(): this is ChannelSelectMenuInteraction
Returns this is ChannelSelectMenuInteraction
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).isChannelSelectMenu
- Defined in src/structures/Interaction.ts:270

isChatInput

isChatInput(): this is ChatInputCommandInteraction<boolean>
Returns this is ChatInputCommandInteraction<boolean>
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).isChatInput
- Defined in src/structures/Interaction.ts:290

isEntryPoint

isEntryPoint(): this is EntryPointInteraction<boolean>
Returns this is EntryPointInteraction<boolean>
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).isEntryPoint
- Defined in src/structures/Interaction.ts:310

isMentionableSelectMenu

isMentionableSelectMenu(): this is MentionableSelectMenuInteraction
Returns this is MentionableSelectMenuInteraction
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).isMentionableSelectMenu
- Defined in src/structures/Interaction.ts:278

isMessage

isMessage(): this is MessageCommandInteraction<boolean>
Returns this is MessageCommandInteraction<boolean>
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).isMessage
- Defined in src/structures/Interaction.ts:298

isModal

isModal(): this is ModalSubmitInteraction<boolean>
Returns this is ModalSubmitInteraction<boolean>
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).isModal
- Defined in src/structures/Interaction.ts:306

isRoleSelectMenu

isRoleSelectMenu(): this is RoleSelectMenuInteraction
Returns this is RoleSelectMenuInteraction
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).isRoleSelectMenu
- Defined in src/structures/Interaction.ts:274

isStringSelectMenu

isStringSelectMenu(): this is StringSelectMenuInteraction<string[]>
Returns this is StringSelectMenuInteraction<string[]>
- Defined in src/structures/Interaction.ts:694

isUser

isUser(): this is UserCommandInteraction<boolean>
Returns this is UserCommandInteraction<boolean>
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).isUser
- Defined in src/structures/Interaction.ts:294

isUserSelectMenu

isUserSelectMenu(): this is UserSelectMenuInteraction
Returns this is UserSelectMenuInteraction
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).isUserSelectMenu
- Defined in src/structures/Interaction.ts:282

modal(body: ModalCreateBodyRequest, options?: undefined): Promise<undefined>
Parameters
- body: ModalCreateBodyRequest
- Optionaloptions: undefined
Returns Promise<undefined>
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).modal
- Defined in src/structures/Interaction.ts:476
modal(
body: ModalCreateBodyRequest,
options: ModalCreateOptions,
): Promise<null | ModalSubmitInteraction<boolean>>
Parameters
- body: ModalCreateBodyRequest
- options: ModalCreateOptions
Returns Promise<null | ModalSubmitInteraction<boolean>>
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).modal
- Defined in src/structures/Interaction.ts:477

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 (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).reply
- Defined in src/structures/Interaction.ts:234

update

update(
    data: Omit<
        APIInteractionResponseCallbackData,
        "components"
        | "content"
        | "embeds",
    > & ResolverProps,
): Promise<undefined>
Parameters
- data: Omit<APIInteractionResponseCallbackData, "components" | "content" | "embeds"> & ResolverProps
Returns Promise<undefined>
Inherited from (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).update
- Defined in src/structures/Interaction.ts:639

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 (SelectMenuInteraction as unknown as ToClass< Omit<SelectMenuInteraction, 'data' | 'isStringSelectMenu'>, StringSelectMenuInteraction >).write
- Defined in src/structures/Interaction.ts:463

Class StringSelectMenuInteraction<T>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns StringSelectMenuInteraction<T>

Properties

api

applicationId

appPermissions

attachmentSizeLimit

authorizingIntegrationOwners

cache

channel

Readonlyclient

componentType

Optionalcontext

createdAt

createdTimestamp

customId

data

entitlements

Optionalguild

OptionalguildId

OptionalguildLocale

id

locale

member

message

Optionalreplied

rest

token

type

user

values

version

Methods

deferReply

Type Parameters

Parameters

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

deferUpdate

Returns Promise<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<undefined | Guild<"cached" | "api">>

Parameters

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

fetchMessage

Parameters

Returns Promise<WebhookMessage>

fetchResponse

Returns Promise<WebhookMessage>

followup

Parameters

Returns Promise<WebhookMessage>

isAutocomplete

Returns this is AutocompleteInteraction<boolean>

isButton

`Readonly`client

`Optional`context

`Optional`guild

`Optional`guildId

`Optional`guildLocale

`Optional`replied