Class SelectMenuInteraction

Hierarchy (View Summary)

ComponentInteraction
- SelectMenuInteraction

Constructors

constructor

new SelectMenuInteraction(
    client: UsingClient,
    interaction: APIMessageComponentSelectMenuInteraction,
    __reply?: __InternalReplyFunction,
): SelectMenuInteraction
Parameters
- client: UsingClient
- interaction: APIMessageComponentSelectMenuInteraction
- Optional__reply: __InternalReplyFunction
Returns SelectMenuInteraction
Overrides ComponentInteraction.constructor
- Defined in src/structures/Interaction.ts:672

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: ObjectToLower<
(APIMessageSelectMenuInteractionData | undefined) & APIMessageSelectMenuInteractionData,
>

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>

token

token: string

type

type: MessageComponent

user

user: User

version

version: 1

Accessors

componentType

get componentType(): | Button
| StringSelect
| UserSelect
| RoleSelect
| MentionableSelect
| ChannelSelect
Returns
    | Button
    | StringSelect
    | UserSelect
    | RoleSelect
    | MentionableSelect
    | ChannelSelect
Inherited from ComponentInteraction.componentType
- Defined in src/structures/Interaction.ts:656

createdAt

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

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

createdTimestamp

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

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

customId

get customId(): string
Returns string
Inherited from ComponentInteraction.customId
- Defined in src/structures/Interaction.ts:652

values

get values(): string[]
Returns string[]
- Defined in src/structures/Interaction.ts:680

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 ComponentInteraction.deferReply
- Defined in src/structures/Interaction.ts:251

deferUpdate

deferUpdate(): Promise<undefined>
Returns Promise<undefined>
Inherited from ComponentInteraction.deferUpdate
- Defined in src/structures/Interaction.ts:646

deleteMessage

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

deleteResponse

deleteResponse(): Promise<void>
Returns Promise<void>
Inherited from ComponentInteraction.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 ComponentInteraction.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 ComponentInteraction.editOrReply
- Defined in src/structures/Interaction.ts:509

editResponse

editResponse(body: InteractionMessageUpdateBodyRequest): Promise<WebhookMessage>
Parameters
- body: InteractionMessageUpdateBodyRequest
Returns Promise<WebhookMessage>
Inherited from ComponentInteraction.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 ComponentInteraction.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 ComponentInteraction.fetchGuild
- Defined in src/structures/Interaction.ts:370

fetchMessage

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

fetchResponse

fetchResponse(): Promise<WebhookMessage>
Returns Promise<WebhookMessage>
Inherited from ComponentInteraction.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 ComponentInteraction.followup
- Defined in src/structures/Interaction.ts:540

modal(body: ModalCreateBodyRequest, options?: undefined): Promise<undefined>
Parameters
- body: ModalCreateBodyRequest
- Optionaloptions: undefined
Returns Promise<undefined>
Inherited from ComponentInteraction.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 ComponentInteraction.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 ComponentInteraction.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 ComponentInteraction.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 ComponentInteraction.write
- Defined in src/structures/Interaction.ts:463

`Static`from

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

`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: undefined | RawFile[],
    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: undefined | RawFile[]
- self: UsingClient
Returns T
Inherited from ComponentInteraction.transformBody
- Defined in src/structures/Interaction.ts:179

`Static`transformBodyRequest

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

Class SelectMenuInteraction

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SelectMenuInteraction

Properties

Protected Optional__reply

applicationId

appPermissions

attachmentSizeLimit

authorizingIntegrationOwners

channel

Readonlyclient

Optionalcontext

data

entitlements

Optionalguild

OptionalguildId

OptionalguildLocale

id

locale

member

message

Optionalreplied

token

type

user

version

Accessors

componentType

Returns | Button | StringSelect | UserSelect | RoleSelect | MentionableSelect | ChannelSelect

createdAt

Returns Date

createdTimestamp

Returns number

customId

Returns string

values

Returns string[]

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>

`Protected` `Optional`__reply

`Readonly`client

`Optional`context

`Optional`guild

`Optional`guildId

`Optional`guildLocale

`Optional`replied

Returns
| Button
| StringSelect
| UserSelect
| RoleSelect
| MentionableSelect
| ChannelSelect

`Static`from

`Static`transformBody

`Static`transformBodyRequest