Carbon
CoreClasses

AnySelectMenuInteraction

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

Extends

Extended by

Constructors

new AnySelectMenuInteraction()

new AnySelectMenuInteraction(client, data, defaults): AnySelectMenuInteraction

Parameters

ParameterType
clientClient
dataAPIMessageComponentSelectMenuInteraction
defaultsInteractionDefaults

Returns

AnySelectMenuInteraction

Overrides

BaseComponentInteraction.constructor

Properties

PropertyTypeDefault valueDescriptionOverridesInherited from
_deferredbooleanfalseInternal Whether the interaction is deferred already-BaseComponentInteraction._deferred
clientClientundefined--BaseComponentInteraction.client
componentTypeComponentTypeundefined--BaseComponentInteraction.componentType
customIdstringundefined-BaseComponentInteraction.customId-
rawDataAPIMessageComponentInteractionundefinedThe raw data of the interaction-BaseComponentInteraction.rawData
typeInteractionTypeundefinedThe type of interaction-BaseComponentInteraction.type
userIdundefined | stringundefinedThe user who sent the interaction-BaseComponentInteraction.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

null | GuildCategoryChannel<false> | DmChannel<false> | GroupDmChannel<false> | GuildTextChannel<false> | GuildVoiceChannel<false> | GuildAnnouncementChannel<false> | GuildThreadChannel<ThreadChannelType, false> | GuildStageChannel<false> | GuildForumChannel<false> | GuildMediaChannel

Inherited from

BaseComponentInteraction.channel


embeds

get embeds(): null | Embed[]

Returns

null | Embed[]

Inherited from

BaseComponentInteraction.embeds


guild

get guild(): null | Guild<true>

Returns

null | Guild<true>

Inherited from

BaseComponentInteraction.guild


member

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

Returns

null | GuildMember<false, true>

Inherited from

BaseComponentInteraction.member


message

get message(): null | Message<false>

Returns

null | Message<false>

Inherited from

BaseComponentInteraction.message


user

get user(): null | User<false>

Returns

null | User<false>

Inherited from

BaseComponentInteraction.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[]

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

BaseComponentInteraction.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

ParameterType
__namedParametersobject
__namedParameters.ephemeralundefined | boolean

Returns

Promise<void>

Inherited from

BaseComponentInteraction.defer


followUp()

followUp(reply, options): Promise<void>

Send a followup message to the interaction

Parameters

ParameterType
replyMessagePayload
optionsInteractionReplyOptions

Returns

Promise<void>

Inherited from

BaseComponentInteraction.followUp


reply()

reply(data, options): Promise<void>

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

Parameters

ParameterTypeDescription
dataMessagePayloadThe response data
optionsInteractionReplyOptions-

Returns

Promise<void>

Inherited from

BaseComponentInteraction.reply


showModal()

showModal(modal): Promise<void>

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

Parameters

ParameterType
modalModal

Returns

Promise<void>

Inherited from

BaseComponentInteraction.showModal


update()

update(data, options): Promise<void>

Update the original message of the component

Parameters

ParameterType
dataMessagePayload
optionsPick<InteractionReplyOptions, "files">

Returns

Promise<void>

Inherited from

BaseComponentInteraction.update

On this page

Edit on GitHub