Carbon
Core/Classes

AnySelectMenu

Extends

Extended by

Constructors

Constructor

new AnySelectMenu(data?): AnySelectMenu

Parameters

ParameterType
data?{ additionalData: ComponentAdditionalData; }
data.additionalData?ComponentAdditionalData

Returns

AnySelectMenu

Inherited from

BaseComponent.constructor

Properties

PropertyModifierTypeDefault valueDescriptionOverridesInherited from
additionalDatapublicnull | ComponentAdditionalDatanull--BaseComponent.additionalData
customIdabstractstringundefinedThe custom ID of the component-BaseComponent.customId
deferpublicbooleanfalseWhether the component response should be automatically deferred-BaseComponent.defer
disabled?publicbooleanundefined---
ephemeralpublicbooleanfalseWhether the component response should be ephemeral-BaseComponent.ephemeral
maxValues?publicnumberundefined---
minValues?publicnumberundefined---
placeholder?publicstringundefined---
typeabstractAnySelectMenuComponentTypeundefinedThe type of the componentBaseComponent.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

BaseComponent.createId


run()

abstract run(interaction): Promise<void>

Parameters

ParameterType
interactionAnySelectMenuInteraction

Returns

Promise<void>


serialize()

serialize(): APISelectMenuComponent

Returns

APISelectMenuComponent

Overrides

BaseComponent.serialize


serializeOptions()

abstract serializeOptions(): { channel_types: undefined | ChannelType[]; default_values: undefined | APISelectMenuDefaultValue<Channel>[]; type: ChannelSelect; } | { options: APISelectMenuOption[]; type: StringSelect; } | { default_values: undefined | APISelectMenuDefaultValue<Role>[]; type: RoleSelect; } | { default_values: undefined | APISelectMenuDefaultValue<User>[]; type: UserSelect; } | { default_values: undefined | APISelectMenuDefaultValue<Role | User>[]; type: MentionableSelect; }

Returns

{ channel_types: undefined | ChannelType[]; default_values: undefined | APISelectMenuDefaultValue<Channel>[]; type: ChannelSelect; } | { options: APISelectMenuOption[]; type: StringSelect; } | { default_values: undefined | APISelectMenuDefaultValue<Role>[]; type: RoleSelect; } | { default_values: undefined | APISelectMenuDefaultValue<User>[]; type: UserSelect; } | { default_values: undefined | APISelectMenuDefaultValue<Role | User>[]; type: MentionableSelect; }

On this page