ChannelSelectMenu

Represents a Select Menu for selecting channels.

Example

const channelSelectMenu = new ChannelSelectMenu();
channelSelectMenu.setCustomId("channel-select");
channelSelectMenu.addDefaultChannels("123456789", "987654321");
channelSelectMenu.setChannelTypes([ChannelType.GuildText, ChannelType.GuildVoice]);

Extends

• SelectMenu<APIChannelSelectComponent, ChannelSelectMenuInteraction>

Constructors

new ChannelSelectMenu(data)

new ChannelSelectMenu(data: Partial<APIChannelSelectComponent>): ChannelSelectMenu

Parameters

Parameter	Type
data	Partial<APIChannelSelectComponent>

Returns

ChannelSelectMenu

Overrides

SelectMenu.constructor

Source

seyfert/src/builders/SelectMenu.ts:229

Properties

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

Methods

addDefaultChannels()

addDefaultChannels(...channels: RestOrArray<string>): this

Adds default selected channels to the select menu.

Parameters

Parameter	Type	Description
…channels	RestOrArray<string>	Channel IDs to be added as default.

Returns

this

The current ChannelSelectMenu instance.

Source

seyfert/src/builders/SelectMenu.ts:238

---

setChannelTypes()

setChannelTypes(types: ChannelType[]): this

Sets the types of channels that can be selected in the menu. types - The types of channels.

Parameters

Parameter	Type
types	ChannelType[]

Returns

this

The current ChannelSelectMenu instance.

Source

seyfert/src/builders/SelectMenu.ts:260

---

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

---

setDefaultChannels()

setDefaultChannels(...channels: RestOrArray<string>): this

Sets the default selected channels for the select menu.

Parameters

Parameter	Type	Description
…channels	RestOrArray<string>	Channel IDs to be set as default.

Returns

this

The current ChannelSelectMenu instance.

Source

seyfert/src/builders/SelectMenu.ts:250

---

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(): APIChannelSelectComponent

Returns

APIChannelSelectComponent

Inherited from

SelectMenu.toJSON

Source

seyfert/src/builders/Base.ts:8