SlashCommandSubcommandBuilder

export declare class SlashCommandSubcommandBuilder implements ToAPIApplicationCommandOptions
export declare class SlashCommandSubcommandBuilder implements ToAPIApplicationCommandOptions
A builder that creates API-compatible JSON data for slash command subcommands.
Readonly
description:string
The description of this subcommand.
Readonly
name:string
The name of this subcommand.
The options within this subcommand.
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
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.
addAttachmentOption(input):TypeAfterAddingOptions
Adds an attachment option.
NameTypeOptionalDescription
inputSlashCommandAttachmentOption | ((builder: SlashCommandAttachmentOption) => SlashCommandAttachmentOption)NoA function that returns an option builder or an already built builder
Inherited from SharedSlashCommandOptions
addBooleanOption(input):TypeAfterAddingOptions
Adds a boolean option.
NameTypeOptionalDescription
inputSlashCommandBooleanOption | ((builder: SlashCommandBooleanOption) => SlashCommandBooleanOption)NoA function that returns an option builder or an already built builder
Inherited from SharedSlashCommandOptions
addChannelOption(input):TypeAfterAddingOptions
Adds a channel option.
NameTypeOptionalDescription
inputSlashCommandChannelOption | ((builder: SlashCommandChannelOption) => SlashCommandChannelOption)NoA function that returns an option builder or an already built builder
Inherited from SharedSlashCommandOptions
addIntegerOption(input):TypeAfterAddingOptions
Adds an integer option.
NameTypeOptionalDescription
inputSlashCommandIntegerOption | ((builder: SlashCommandIntegerOption) => SlashCommandIntegerOption)NoA function that returns an option builder or an already built builder
Inherited from SharedSlashCommandOptions
addMentionableOption(input):TypeAfterAddingOptions
Adds a mentionable option.
NameTypeOptionalDescription
inputSlashCommandMentionableOption | ((builder: SlashCommandMentionableOption) => SlashCommandMentionableOption)NoA function that returns an option builder or an already built builder
Inherited from SharedSlashCommandOptions
addNumberOption(input):TypeAfterAddingOptions
Adds a number option.
NameTypeOptionalDescription
inputSlashCommandNumberOption | ((builder: SlashCommandNumberOption) => SlashCommandNumberOption)NoA function that returns an option builder or an already built builder
Inherited from SharedSlashCommandOptions
addRoleOption(input):TypeAfterAddingOptions
Adds a role option.
NameTypeOptionalDescription
inputSlashCommandRoleOption | ((builder: SlashCommandRoleOption) => SlashCommandRoleOption)NoA function that returns an option builder or an already built builder
Inherited from SharedSlashCommandOptions
addStringOption(input):TypeAfterAddingOptions
Adds a string option.
NameTypeOptionalDescription
inputSlashCommandStringOption | ((builder: SlashCommandStringOption) => SlashCommandStringOption)NoA function that returns an option builder or an already built builder
Inherited from SharedSlashCommandOptions
addUserOption(input):TypeAfterAddingOptions
Adds a user option.
NameTypeOptionalDescription
inputSlashCommandUserOption | ((builder: SlashCommandUserOption) => SlashCommandUserOption)NoA function that returns an option builder or an already built builder
Inherited from SharedSlashCommandOptions
setDescription(description):this
Sets the description of this command.
NameTypeOptionalDescription
descriptionstringNoThe description to use
Inherited from SharedNameAndDescription
setDescriptionLocalization(locale, localizedDescription):this
Sets a description localization for this command.
NameTypeOptionalDescription
localeLocaleStringNoThe locale to set
localizedDescriptionstring | nullNoThe localized description for the given locale
Inherited from SharedNameAndDescription
setDescriptionLocalizations(localizedDescriptions):this
Sets the description localizations for this command.
NameTypeOptionalDescription
localizedDescriptionsLocalizationMap | nullNoThe object of localized descriptions to set
Inherited from SharedNameAndDescription
setName(name):this
Sets the name of this command.
NameTypeOptionalDescription
namestringNoThe name to use
Inherited from SharedNameAndDescription
setNameLocalization(locale, localizedName):this
Sets a name localization for this command.
NameTypeOptionalDescription
localeLocaleStringNoThe locale to set
localizedNamestring | nullNoThe localized name for the given locale
Inherited from SharedNameAndDescription
setNameLocalizations(localizedNames):this
Sets the name localizations for this command.
NameTypeOptionalDescription
localizedNamesLocalizationMap | nullNoThe object of localized names to set
Inherited from SharedNameAndDescription