StringSelectMenuInteraction

This is the base type interaction, all interaction types extend from this

Extends

AnySelectMenuInteraction

Constructors

new StringSelectMenuInteraction()

new StringSelectMenuInteraction(client, data, defaults): StringSelectMenuInteraction

Parameters

Parameter	Type
`client`	`Client`
`data`	`APIMessageComponentSelectMenuInteraction`
`defaults`	`InteractionDefaults`

Returns

StringSelectMenuInteraction

Overrides

AnySelectMenuInteraction.constructor

Properties

Property	Type	Default value	Description	Inherited from
`_deferred`	`boolean`	`false`	`Internal` Whether the interaction is deferred already	`AnySelectMenuInteraction`.`_deferred`
`client`	`Client`	`undefined`	-	`AnySelectMenuInteraction`.`client`
`componentType`	`ComponentType`	`undefined`	-	`AnySelectMenuInteraction`.`componentType`
`customId`	`string`	`undefined`	-	`AnySelectMenuInteraction`.`customId`
`rawData`	`APIMessageComponentInteraction`	`undefined`	The raw data of the interaction	`AnySelectMenuInteraction`.`rawData`
`type`	`InteractionType`	`undefined`	The type of interaction	`AnySelectMenuInteraction`.`type`
`userId`	`undefined` \| `string`	`undefined`	The user who sent the interaction	`AnySelectMenuInteraction`.`userId`

Accessors

channel

get channel(): null | GuildCategoryChannel<false> | DmChannel<false> | GroupDmChannel<false> | GuildTextChannel<false> | GuildVoiceChannel<false> | GuildAnnouncementChannel<false> | GuildThreadChannel<ThreadChannelType, false> | GuildStageChannel<false> | GuildForumChannel<false> | GuildMediaChannel

Returns

Inherited from

AnySelectMenuInteraction.channel

embeds

get embeds(): null | Embed[]

Returns

null | Embed[]

Inherited from

AnySelectMenuInteraction.embeds

guild

get guild(): null | Guild<true>

Returns

null | Guild<true>

Inherited from

AnySelectMenuInteraction.guild

member

get member(): null | GuildMember<false, true>

Returns

null | GuildMember<false, true>

Inherited from

AnySelectMenuInteraction.member

message

get message(): null | Message<false>

Returns

null | Message<false>

Inherited from

AnySelectMenuInteraction.message

user

get user(): null | User<false>

Returns

null | User<false>

Inherited from

AnySelectMenuInteraction.user

values

get values(): string[]

The raw IDs of the selected options (either role/string/channel IDs or the IDs you provided in your options)

Returns

string[]

Overrides

AnySelectMenuInteraction.values

Methods

acknowledge()

acknowledge(): Promise<void>

Acknowledge the interaction, the user does not see a loading state. This can only be used for component interactions

Returns

Promise<void>

Inherited from

AnySelectMenuInteraction.acknowledge

defer()

defer(__namedParameters): Promise<void>

Internal

Defer the interaction response. This is used automatically by commands that are set to defer. If the interaction is already deferred, this will do nothing.

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.ephemeral`	`undefined` \| `boolean`

Returns

Promise<void>

Inherited from

AnySelectMenuInteraction.defer

followUp()

followUp(reply, options): Promise<void>

Send a followup message to the interaction

Parameters

Parameter	Type
`reply`	`MessagePayload`
`options`	`InteractionReplyOptions`

Returns

Promise<void>

Inherited from

AnySelectMenuInteraction.followUp

reply()

reply(data, options): Promise<void>

Reply to an interaction. If the interaction is deferred, this will edit the original response.

Parameters

Parameter	Type	Description
`data`	`MessagePayload`	The response data
`options`	`InteractionReplyOptions`	-

Returns

Promise<void>

Inherited from

AnySelectMenuInteraction.reply

showModal()

showModal(modal): Promise<void>

Show a modal to the user This can only be used if the interaction is not deferred

Parameters

Parameter	Type
`modal`	`Modal`

Returns

Promise<void>

Inherited from

AnySelectMenuInteraction.showModal

update()

update(data, options): Promise<void>

Update the original message of the component

Parameters

Parameter	Type
`data`	`MessagePayload`
`options`	`Pick`<`InteractionReplyOptions`, `"files"`>

Returns

Promise<void>

Inherited from

AnySelectMenuInteraction.update

StringSelectMenuInteraction

On this page