discord.js | RoleSelectMenuBuilder

Search...

RoleSelectMenuBuilder

export class RoleSelectMenuBuilder extends BuilderRoleSelectMenuComponent

export class RoleSelectMenuBuilder extends BuilderRoleSelectMenuComponent

Class used to build select menu components to be sent through the API

constructor(data?)

Constructs a new instance of the RoleSelectMenuBuilder class

Name	Type	Optional	Description
data	Partial<RoleSelectMenuComponentData \| APIRoleSelectComponent>	Yes	None

Readonly

data:Partial<DataType>

The API data associated with this component.

Static

Creates a new select menu builder from JSON data

Name	Type	Optional	Description
other	JSONEncodable<APISelectMenuComponent> \| APISelectMenuComponent	No	The other data

setCustomId(customId):this

Sets the custom id for this select menu.

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

setDisabled(disabled?):this

Sets whether this select menu is disabled.

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

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

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

setPlaceholder(placeholder):this

Sets the placeholder for this select menu.

Name	Type	Optional	Description
placeholder	string	No	The placeholder to use

toJSON():SelectMenuType

Serializes this builder to API-compatible JSON data.

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