discord.js | SlashCommandChannelOption

Search...

SlashCommandChannelOption

export declare class SlashCommandChannelOption extends ApplicationCommandOptionBase

export declare class SlashCommandChannelOption extends ApplicationCommandOptionBase

A slash command channel option.

Extends

ApplicationCommandOptionBase

Readonly

description_localizations?:LocalizationMap

The description localizations of this command.

Inherited from SharedNameAndDescription

Readonly

description:string

The description of this command.

Inherited from SharedNameAndDescription

Readonly

name_localizations?:LocalizationMap

The name localizations of this command.

Inherited from SharedNameAndDescription

Readonly

name:string

The name of this command.

Inherited from SharedNameAndDescription

Readonly

required:boolean

Whether this option is required.

Default value

false

Inherited from ApplicationCommandOptionBase

Readonly

type:ApplicationCommandOptionType.Channel

The type of this option.

Readonly

channel_types?:ApplicationCommandOptionAllowedChannelTypes[]

The channel types of this option.

Inherited from ApplicationCommandOptionChannelTypesMixin

Protected

runRequiredValidations():void

This method runs required validators on this builder.

Inherited from ApplicationCommandOptionBase

setDescription(description):this

Sets the description of this command.

Name	Type	Optional	Description
description	string	No	The description to use

Inherited from SharedNameAndDescription

setDescriptionLocalization(locale, localizedDescription):this

Sets a description localization for this command.

Name	Type	Optional	Description
locale	LocaleString	No	The locale to set
localizedDescription	string \| null	No	The localized description for the given locale

Inherited from SharedNameAndDescription

setDescriptionLocalizations(localizedDescriptions):this

Sets the description localizations for this command.

Name	Type	Optional	Description
localizedDescriptions	LocalizationMap \| null	No	The object of localized descriptions to set

Inherited from SharedNameAndDescription

setName(name):this

Sets the name of this command.

Name	Type	Optional	Description
name	string	No	The name to use

Inherited from SharedNameAndDescription

setNameLocalization(locale, localizedName):this

Sets a name localization for this command.

Name	Type	Optional	Description
locale	LocaleString	No	The locale to set
localizedName	string \| null	No	The localized name for the given `locale`

Inherited from SharedNameAndDescription

setNameLocalizations(localizedNames):this

Sets the name localizations for this command.

Name	Type	Optional	Description
localizedNames	LocalizationMap \| null	No	The object of localized names to set

Inherited from SharedNameAndDescription

setRequired(required):this

Sets whether this option is required.

Name	Type	Optional	Description
required	boolean	No	Whether this option should be required

Inherited from ApplicationCommandOptionBase

toJSON():APIApplicationCommandChannelOption

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.

addChannelTypes(...channelTypes):this

Adds channel types to this option.

Name	Type	Optional	Description
...channelTypes	ApplicationCommandOptionAllowedChannelTypes[]	No	The channel types

Inherited from ApplicationCommandOptionChannelTypesMixin