ChannelSelectMenuBuilder

export declare class ChannelSelectMenuBuilder extends BaseSelectMenuBuilder<APIChannelSelectComponent>
export declare class ChannelSelectMenuBuilder extends BaseSelectMenuBuilder<APIChannelSelectComponent>
A builder that creates API-compatible JSON data for channel select menus.
constructor(data?)
Creates a new select menu from API data.
Example
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,
});
const selectMenu = new ChannelSelectMenuBuilder({
custom_id: 'a cool select menu',
placeholder: 'select an option',
max_values: 2,
});
Example
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);
const selectMenu = new ChannelSelectMenuBuilder({
custom_id: 'a cool select menu',
})
.addChannelTypes(ChannelType.GuildText, ChannelType.GuildAnnouncement)
.setMinValues(2);
NameTypeOptionalDescription
dataPartial<APIChannelSelectComponent>Yes
The API data to create this select menu with
Readonly
data:Partial<DataType>
The API data associated with this component.
Inherited from ComponentBuilder
addChannelTypes(types):this
Adds channel types to this select menu.
NameTypeOptionalDescription
typesRestOrArray<ChannelType>No
The channel types to use
setChannelTypes(types):this
Sets channel types for this select menu.
NameTypeOptionalDescription
typesRestOrArray<ChannelType>No
The channel types to use
setCustomId(customId):this
Sets the custom id for this select menu.
NameTypeOptionalDescription
customIdstringNo
The custom id to use
Inherited from BaseSelectMenuBuilder
setDisabled(disabled?):this
Sets whether this select menu is disabled.
NameTypeOptionalDescription
disabledbooleanYes
Whether this select menu is disabled
Inherited from BaseSelectMenuBuilder
setMaxValues(maxValues):this
Sets the maximum values that must be selected in the select menu.
NameTypeOptionalDescription
maxValuesnumberNo
The maximum values that must be selected
Inherited from BaseSelectMenuBuilder
setMinValues(minValues):this
Sets the minimum values that must be selected in the select menu.
NameTypeOptionalDescription
minValuesnumberNo
The minimum values that must be selected
Inherited from BaseSelectMenuBuilder
setPlaceholder(placeholder):this
Sets the placeholder for this select menu.
NameTypeOptionalDescription
placeholderstringNo
The placeholder to use
Inherited from BaseSelectMenuBuilder
Serializes this builder to API-compatible JSON data.
Remarks
This method runs validations on the data before serializing it. As such, it may throw an error if the data is invalid.