class MentionableSelectMenuBuilder

export declare class MentionableSelectMenuBuilder extends BaseSelectMenuBuilder<APIMentionableSelectComponent>

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

data
addDefaultRoles
addDefaultUsers
addDefaultValues
clearId
setCustomId
setDefaultValues
setDisabled
setId
setMaxValues
setMinValues
setPlaceholder
toJSON

Constructors

constructor(
data?: Partial<APIMentionableSelectComponent>
)

Creates a new select menu from API data.

Examples: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,
});
Creating a select menu using setters and API data:
const selectMenu = new MentionableSelectMenuBuilder({
	custom_id: 'a cool select menu',
})
	.setMinValues(1);

readonly
data : Partial<SelectMenuType>

The API data associated with this component.

Inherited from: ComponentBuilder

addDefaultRoles(
...roles: RestOrArray<Snowflake>
) : this

Adds default roles to this auto populated select menu.

addDefaultUsers(
...users: RestOrArray<Snowflake>
) : this

Adds default users to this auto populated select menu.

addDefaultValues(
...values: RestOrArray<APISelectMenuDefaultValue<SelectMenuDefaultValueType.Role> | APISelectMenuDefaultValue<SelectMenuDefaultValueType.User>>
) : this

Adds default values to this auto populated select menu.

clearId() : this

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

Inherited from: ComponentBuilder

setCustomId(
customId: string
) : this

Sets the custom id for this select menu.

Inherited from: BaseSelectMenuBuilder

setDefaultValues(
...values: RestOrArray<APISelectMenuDefaultValue<SelectMenuDefaultValueType.Role> | APISelectMenuDefaultValue<SelectMenuDefaultValueType.User>>
) : this

Sets default values for this auto populated select menu.

setDisabled(
disabled?: boolean
) : this

Sets whether this select menu is disabled.

Inherited from: BaseSelectMenuBuilder

setId(
id: number
) : this

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

Inherited from: ComponentBuilder

setMaxValues(
maxValues: number
) : this

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

Inherited from: BaseSelectMenuBuilder

setMinValues(
minValues: number
) : this

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

Inherited from: BaseSelectMenuBuilder

setPlaceholder(
placeholder: string
) : this

Sets the placeholder for this select menu.

Inherited from: BaseSelectMenuBuilder

toJSON() : APIMentionableSelectComponent

Serializes this builder to API-compatible JSON data.

Inherited from: BaseSelectMenuBuilder