UserSelectMenu

Represents a Select Menu for selecting users.

Example

const userSelectMenu = new UserSelectMenu();
userSelectMenu.setCustomId("user-select");
userSelectMenu.addDefaultUsers("123456789", "987654321");

Extends

• SelectMenu<APIUserSelectComponent, UserSelectMenuInteraction>

Constructors

new UserSelectMenu(data)

new UserSelectMenu(data: Partial<APIUserSelectComponent>): UserSelectMenu

Parameters

Parameter	Type
data	Partial<APIUserSelectComponent>

Returns

UserSelectMenu

Overrides

SelectMenu.constructor

Source

seyfert/src/builders/SelectMenu.ts:116

Properties

Property	Modifier	Type	Inherited from
data	public	Partial<APIUserSelectComponent>	SelectMenu.data

Methods

addDefaultUsers()

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

Adds default selected users to the select menu.

Parameters

Parameter	Type	Description
…users	RestOrArray<string>	User IDs to be added as default.

Returns

this

The current UserSelectMenu instance.

Source

seyfert/src/builders/SelectMenu.ts:125

---

setCustomId()

setCustomId(id: string): this

Sets the custom ID for the select menu.

Parameters

Parameter	Type	Description
id	string	The custom ID for the select menu.

Returns

this

The current SelectMenu instance.

Inherited from

SelectMenu.setCustomId

Source

seyfert/src/builders/SelectMenu.ts:71

---

setDefaultUsers()

setDefaultUsers(...users: RestOrArray<string>): this

Sets the default selected users for the select menu.

Parameters

Parameter	Type	Description
…users	RestOrArray<string>	User IDs to be set as default.

Returns

this

The current UserSelectMenu instance.

Source

seyfert/src/builders/SelectMenu.ts:137

---

setDisabled()

setDisabled(disabled: boolean): this

Sets whether the select menu is disabled. [disabled=true] - Indicates whether the select menu is disabled.

Parameters

Parameter	Type	Default value
disabled	boolean	true

Returns

this

The current SelectMenu instance.

Inherited from

SelectMenu.setDisabled

Source

seyfert/src/builders/SelectMenu.ts:102

---

setPlaceholder()

setPlaceholder(placeholder: string): this

Sets the placeholder text for the select menu.

Parameters

Parameter	Type	Description
placeholder	string	The placeholder text.

Returns

this

The current SelectMenu instance.

Inherited from

SelectMenu.setPlaceholder

Source

seyfert/src/builders/SelectMenu.ts:81

---

setValuesLength()

setValuesLength(options: Partial<OptionValuesLength>): this

Sets the maximum and minimum number of selected values for the select menu.

Parameters

Parameter	Type	Description
options	Partial<OptionValuesLength>	The maximum and minimum values.

Returns

this

The current SelectMenu instance.

Inherited from

SelectMenu.setValuesLength

Source

seyfert/src/builders/SelectMenu.ts:91

---

toJSON()

toJSON(): APIUserSelectComponent

Returns

APIUserSelectComponent

Inherited from

SelectMenu.toJSON

Source

seyfert/src/builders/Base.ts:8