Carbon
CoreClasses

ChannelSelectMenu

Extends

Constructors

new ChannelSelectMenu()

new ChannelSelectMenu(data?): ChannelSelectMenu

Parameters

ParameterType
data?object
data.additionalData?ComponentAdditionalData

Returns

ChannelSelectMenu

Inherited from

AnySelectMenu.constructor

Properties

PropertyModifierTypeDefault valueDescriptionOverridesInherited from
additionalDatapublicnull | ComponentAdditionalDatanull--AnySelectMenu.additionalData
channelTypes?publicChannelType[]undefined---
customIdabstractstringundefinedThe custom ID of the component-AnySelectMenu.customId
defaultValues?publicAPISelectMenuDefaultValue<Channel>[]undefined---
deferpublicbooleanfalseWhether the component response should be automatically deferred-AnySelectMenu.defer
disabled?publicbooleanundefined--AnySelectMenu.disabled
ephemeralpublicbooleanfalseWhether the component response should be ephemeral-AnySelectMenu.ephemeral
maxValues?publicnumberundefined--AnySelectMenu.maxValues
minValues?publicnumberundefined--AnySelectMenu.minValues
placeholder?publicstringundefined--AnySelectMenu.placeholder
typepublicChannelSelectComponentType.ChannelSelectThe type of the componentAnySelectMenu.type-

Methods

createId()

createId(additionalData): string

Create a custom ID to use for this component that embeds additional data that you want to be handed

Parameters

ParameterTypeDescription
additionalDatanull | ComponentAdditionalDataThe additional data that you want to be passed in this component's custom ID

Returns

string

The custom ID to use

Inherited from

AnySelectMenu.createId


run()

abstract run(interaction): Promise<void>

Parameters

ParameterType
interactionChannelSelectMenuInteraction

Returns

Promise<void>

Overrides

AnySelectMenu.run


serialize()

serialize(): APISelectMenuComponent

Returns

APISelectMenuComponent

Inherited from

AnySelectMenu.serialize


serializeOptions()

serializeOptions(): object

Returns

object

NameType
channel_typesundefined | ChannelType[]
default_valuesundefined | APISelectMenuDefaultValue<Channel>[]
typeChannelSelect

Overrides

AnySelectMenu.serializeOptions

On this page

Edit on GitHub