declare class ChannelSelectMenuBuilder extends BaseSelectMenuBuilder<APIChannelSelectComponent>
A builder that creates API-compatible JSON data for channel select menus.
Constructors
data?: Partial<APIChannelSelectComponent>)
constructor(Creates a new select menu from API data.
const selectMenu = new ChannelSelectMenuBuilder({
custom_id: 'a cool select menu',
placeholder: 'select an option',
max_values: 2,
});
const selectMenu = new ChannelSelectMenuBuilder({
custom_id: 'a cool select menu',
})
.addChannelTypes(ChannelType.GuildText, ChannelType.GuildAnnouncement)
.setMinValues(2);
protectedreadonlyexternalPartial<APIChannelSelectComponent> data :
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.
Clears the id of this component, defaulting to a default incremented id.
Inherited from: ComponentBuilder
Clears the placeholder for this select menu.
Inherited from: BaseSelectMenuBuilder
external setChannelTypes...types: RestOrArray<ChannelType>) : this (
Sets channel types for this select menu.
external setCustomIdcustomId: 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 setDisableddisabled?: boolean) : this (
Sets whether this select menu is disabled.
Inherited from: BaseSelectMenuBuilder
external setMaxValuesmaxValues: number) : this (
Sets the maximum values that must be selected in the select menu.
Inherited from: BaseSelectMenuBuilder
external setMinValuesminValues: number) : this (
Sets the minimum values that must be selected in the select menu.
Inherited from: BaseSelectMenuBuilder
external setPlaceholderplaceholder: string) : this (
Sets the placeholder for this select menu.
Inherited from: BaseSelectMenuBuilder
external toJSONvalidationOverride?: 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.