class RoleSelectMenuBuilder

external
declare class RoleSelectMenuBuilder extends BaseSelectMenuBuilder<APIRoleSelectComponent>

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

data
addDefaultRoles
clearId
clearPlaceholder
setCustomId
setDefaultRoles
setDisabled
setId
setMaxValues
setMinValues
setPlaceholder
setRequired
toJSON

Constructors

external
constructor(
data?: Partial<APIRoleSelectComponent>
)

Creates a new role select menu.

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

protectedreadonlyexternal
data : Partial<APIRoleSelectComponent>

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

Adds default roles to this auto populated select menu.

external
clearId() : this

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

Inherited from: ComponentBuilder

external
clearPlaceholder() : this

Clears the placeholder for this select menu.

Inherited from: BaseSelectMenuBuilder

external
setCustomId(
customId: string
) : this

Sets the custom id for this select menu.

Inherited from: BaseSelectMenuBuilder

external
setDefaultRoles(
...roles: RestOrArray<Snowflake>
) : this

Sets default roles for this auto populated select menu.

external
setDisabled(
disabled?: boolean
) : this

Sets whether this select menu is disabled.

Inherited from: BaseSelectMenuBuilder

external
setId(
id: number
) : this

Sets the id of this component.

Inherited from: ComponentBuilder

external
setMaxValues(
maxValues: number
) : this

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

Inherited from: BaseSelectMenuBuilder

external
setMinValues(
minValues: number
) : this

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

Inherited from: BaseSelectMenuBuilder

external
setPlaceholder(
placeholder: string
) : this

Sets the placeholder for this select menu.

Inherited from: BaseSelectMenuBuilder

external
setRequired(
required?: boolean
) : this

Sets whether this select menu is required.

Inherited from: BaseSelectMenuBuilder

external
toJSON(
validationOverride?: boolean
) : APIRoleSelectComponent

Serializes this builder to API-compatible JSON data.Note that by disabling validation, there is no guarantee that the resulting object will be valid.