Carbon
Core/Classes

MentionableSelectMenu

Extends

Constructors

Constructor

new MentionableSelectMenu(data?): MentionableSelectMenu

Parameters

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

Returns

MentionableSelectMenu

Inherited from

AnySelectMenu.constructor

Properties

PropertyModifierTypeDefault valueDescriptionOverridesInherited from
additionalDatapublicnull | ComponentAdditionalDatanull--AnySelectMenu.additionalData
customIdabstractstringundefinedThe custom ID of the component-AnySelectMenu.customId
defaultValues?publicAPISelectMenuDefaultValue<Role | User>[]undefined---
deferpublicbooleanfalseWhether the component response should be automatically deferred-AnySelectMenu.defer
disabled?publicbooleanundefined--AnySelectMenu.disabled
ephemeralpublicbooleanfalseWhether the component response should be ephemeral-AnySelectMenu.ephemeral
id?publicnumberundefined32 bit integer used as an optional identifier for component The id field is optional and is used to identify components in the response from an interaction that aren't interactive components. The id must be unique within the message and is generated sequentially by Discord if left empty. Generation of ids won't use another id that exists in the message if you have one defined for another component.-AnySelectMenu.id
isV2readonlyfalsefalseWhether the component is a v2 component and requires the IS_COMPONENTS_V2 flagAnySelectMenu.isV2-
maxValues?publicnumberundefined--AnySelectMenu.maxValues
minValues?publicnumberundefined--AnySelectMenu.minValues
placeholder?publicstringundefined--AnySelectMenu.placeholder
typereadonlyMentionableSelectundefinedThe 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
interactionMentionableSelectMenuInteraction

Returns

Promise<void>

Overrides

AnySelectMenu.run


serialize()

serialize(): APISelectMenuComponent

Returns

APISelectMenuComponent

Inherited from

AnySelectMenu.serialize


serializeOptions()

serializeOptions(): object

Returns

object

NameType
default_valuesundefined | APISelectMenuDefaultValue<Role | User>[]
typeMentionableSelect

Overrides

AnySelectMenu.serializeOptions

On this page