class ChannelSelectMenuBuilder

export declare class ChannelSelectMenuBuilder extends BaseSelectMenuBuilder<APIChannelSelectComponent>

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

data
addChannelTypes
addDefaultChannels
clearId
setChannelTypes
setCustomId
setDefaultChannels
setDisabled
setId
setMaxValues
setMinValues
setPlaceholder
toJSON

Constructors

constructor(
data?: Partial<APIChannelSelectComponent>
)

Creates a new select menu from API data.

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

readonly
data : Partial<SelectMenuType>

The API data associated with this component.

Inherited from: ComponentBuilder

addChannelTypes(
...types: RestOrArray<ChannelType>
) : this

Adds channel types to this select menu.

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

Adds default channels to this auto populated select menu.

clearId() : this

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

Inherited from: ComponentBuilder

setChannelTypes(
...types: RestOrArray<ChannelType>
) : this

Sets channel types for this select menu.

setCustomId(
customId: string
) : this

Sets the custom id for this select menu.

Inherited from: BaseSelectMenuBuilder

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

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

Serializes this builder to API-compatible JSON data.