class ChannelSelectMenuBuilder

external
declare class ChannelSelectMenuBuilder extends BaseSelectMenuBuilder<APIChannelSelectComponent>

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

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

Constructors

external
constructor(
data?: Partial<APIChannelSelectComponent>
)

Creates a new channel select menu.

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);

protectedreadonlyexternal
data : Partial<APIChannelSelectComponent>

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

Adds channel types to this select menu.

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

Adds default channels 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
setChannelTypes(
...types: RestOrArray<ChannelType>
) : this

Sets channel types for this select menu.

external
setCustomId(
customId: string
) : this

Sets the custom id for this select menu.

Inherited from: BaseSelectMenuBuilder

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

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

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