Preview environment

class RoleSelectMenuBuilder

export declare class RoleSelectMenuBuilder extends BaseSelectMenuBuilder<APIRoleSelectComponent>

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

Constructors

constructor(
data?: Partial<APIRoleSelectComponent>
)

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.

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

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

Sets default roles 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() : APIRoleSelectComponent

Serializes this builder to API-compatible JSON data.

Inherited from: BaseSelectMenuBuilder