Carbon
Core/Classes

ChannelSelectMenuInteraction

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

Extends

Constructors

Constructor

new ChannelSelectMenuInteraction(client, data, defaults): ChannelSelectMenuInteraction

Parameters

ParameterType
clientClient
dataAPIMessageComponentSelectMenuInteraction
defaultsInteractionDefaults

Returns

ChannelSelectMenuInteraction

Overrides

AnySelectMenuInteraction.constructor

Properties

PropertyTypeDefault valueDescriptionInherited from
_deferredbooleanfalseInternal Whether the interaction is deferred alreadyAnySelectMenuInteraction._deferred
clientClientundefined-AnySelectMenuInteraction.client
componentTypeComponentTypeundefined-AnySelectMenuInteraction.componentType
customIdstringundefined-AnySelectMenuInteraction.customId
rawDataAPIMessageComponentInteractionundefinedThe raw data of the interactionAnySelectMenuInteraction.rawData
typeInteractionTypeundefinedThe type of interactionAnySelectMenuInteraction.type
userIdundefined | stringundefinedThe user who sent the interactionAnySelectMenuInteraction.userId

Accessors

channel

Get Signature

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

Returns

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

Inherited from

AnySelectMenuInteraction.channel


embeds

Get Signature

get embeds(): null | Embed[]

Returns

null | Embed[]

Inherited from

AnySelectMenuInteraction.embeds


guild

Get Signature

get guild(): null | Guild<true>

Returns

null | Guild<true>

Inherited from

AnySelectMenuInteraction.guild


member

Get Signature

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

Returns

null | GuildMember<false, true>

Inherited from

AnySelectMenuInteraction.member


message

Get Signature

get message(): null | Message<false>

Returns

null | Message<false>

Inherited from

AnySelectMenuInteraction.message


user

Get Signature

get user(): null | User<false>

Returns

null | User<false>

Inherited from

AnySelectMenuInteraction.user


values

Get Signature

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

Inherited from

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

ParameterType
__namedParameters{ ephemeral: boolean; }
__namedParameters.ephemeral?boolean

Returns

Promise<void>

Inherited from

AnySelectMenuInteraction.defer


followUp()

followUp(reply): Promise<void>

Send a followup message to the interaction

Parameters

ParameterType
replyMessagePayload

Returns

Promise<void>

Inherited from

AnySelectMenuInteraction.followUp


reply()

reply(data): Promise<void>

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

Parameters

ParameterTypeDescription
dataMessagePayloadThe response data

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

ParameterType
modalModal

Returns

Promise<void>

Inherited from

AnySelectMenuInteraction.showModal


update()

update(data): Promise<void>

Update the original message of the component

Parameters

ParameterType
dataMessagePayload

Returns

Promise<void>

Inherited from

AnySelectMenuInteraction.update

On this page