discord.js | MentionableSelectMenuBuilder

Search...

MentionableSelectMenuBuilder

export declare class MentionableSelectMenuBuilder extends BaseSelectMenuBuilder<APIMentionableSelectComponent>

export declare class MentionableSelectMenuBuilder extends BaseSelectMenuBuilder<APIMentionableSelectComponent>

A builder that creates API-compatible JSON data for mentionable select menus.

Extends

BaseSelectMenuBuilder<APIMentionableSelectComponent>

constructor(data?)

Creates a new select menu from API data.

Example

Creating a select menu from an API data object:

const selectMenu = new MentionableSelectMenuBuilder({
	custom_id: 'a cool select menu',
	placeholder: 'select an option',
	max_values: 2,
});

const selectMenu = new MentionableSelectMenuBuilder({
	custom_id: 'a cool select menu',
	placeholder: 'select an option',
	max_values: 2,
});

Example

Creating a select menu using setters and API data:

const selectMenu = new MentionableSelectMenuBuilder({
	custom_id: 'a cool select menu',
})
	.setMinValues(1);

const selectMenu = new MentionableSelectMenuBuilder({
	custom_id: 'a cool select menu',
})
	.setMinValues(1);

Name	Type	Optional	Description
data	Partial<APIMentionableSelectComponent>	Yes	The API data to create this select menu with

Readonly

data:Partial<SelectMenuType>

The API data associated with this component.

Inherited from ComponentBuilder

addDefaultRoles(...roles):this

Adds default roles to this auto populated select menu.

Name	Type	Optional	Description
...roles	RestOrArray<Snowflake>	No	The roles to add

addDefaultUsers(...users):this

Adds default users to this auto populated select menu.

Name	Type	Optional	Description
...users	RestOrArray<Snowflake>	No	The users to add

addDefaultValues(...values):this

Adds default values to this auto populated select menu.

Name	Type	Optional	Description
...values	RestOrArray<APISelectMenuDefaultValue<SelectMenuDefaultValueType.Role> \| APISelectMenuDefaultValue<SelectMenuDefaultValueType.User>>	No	The values to add

clearId():this

Clears the id of this component, defaulting to a default incremented id.

Inherited from ComponentBuilder

setCustomId(customId):this

Sets the custom id for this select menu.

Name	Type	Optional	Description
customId	string	No	The custom id to use

Inherited from BaseSelectMenuBuilder

setDefaultValues(...values):this

Sets default values for this auto populated select menu.

Name	Type	Optional	Description
...values	RestOrArray<APISelectMenuDefaultValue<SelectMenuDefaultValueType.Role> \| APISelectMenuDefaultValue<SelectMenuDefaultValueType.User>>	No	The values to set

setDisabled(disabled?):this

Sets whether this select menu is disabled.

Name	Type	Optional	Description
disabled	boolean	Yes	Whether this select menu is disabled

Inherited from BaseSelectMenuBuilder

setId(id):this

Sets the id (not the custom id) for this component.

Name	Type	Optional	Description
id	number	No	The id for this component

Inherited from ComponentBuilder

setMaxValues(maxValues):this

Sets the maximum values that must be selected in the select menu.

Name	Type	Optional	Description
maxValues	number	No	The maximum values that must be selected

Inherited from BaseSelectMenuBuilder

setMinValues(minValues):this

Sets the minimum values that must be selected in the select menu.

Name	Type	Optional	Description
minValues	number	No	The minimum values that must be selected

Inherited from BaseSelectMenuBuilder

setPlaceholder(placeholder):this

Sets the placeholder for this select menu.

Name	Type	Optional	Description
placeholder	string	No	The placeholder to use

Inherited from BaseSelectMenuBuilder

setRequired(required?):this

Sets whether this select menu is required.

Remarks

Only for use in modals.

Name	Type	Optional	Description
required	boolean	Yes	Whether this select menu is required

Inherited from BaseSelectMenuBuilder

toJSON():APIMentionableSelectComponent

Serializes this builder to API-compatible JSON data.

Remarks

This method runs validations on the data before serializing it. As such, it may throw an error if the data is invalid.

Inherited from BaseSelectMenuBuilder