Preview environment

class MentionableSelectMenuBuilder

export declare class MentionableSelectMenuBuilder extends BaseSelectMenuBuilder<APIMentionableSelectComponent>

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

Constructors

constructor(
data?: Partial<APIMentionableSelectComponent>
)

Creates a new select menu from API data.

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.

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

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