discord.js | SlashCommandSubcommandBuilder

SlashCommandSubcommandBuilder

export declare class SlashCommandSubcommandBuilder implements ToAPIApplicationCommandOptions

export declare class SlashCommandSubcommandBuilder implements ToAPIApplicationCommandOptions

Represents a subcommandFor more information, go to https://discord.com/developers/docs/interactions/application-commands#subcommands-and-subcommand-groups

Implements

ToAPIApplicationCommandOptions

Readonly

description

:

string

The description of this subcommand

Readonly

name

:

string

The name of this subcommand

Readonly

options

:

ApplicationCommandOptionBase[]

The options of this subcommand

Readonly

Optional

description_localizations?

:

LocalizationMap

Inherited from SharedNameAndDescription

Readonly

Optional

name_localizations?

:

LocalizationMap

Inherited from SharedNameAndDescription

toJSON()

:

APIApplicationCommandSubcommandOption

addAttachmentOption(input)

:

ShouldOmitSubcommandFunctions extends true ? Omit<this, "addSubcommand" | "addSubcommandGroup"> : this

Adds an attachment option

Name	Type	Optional	Description
input	SlashCommandAttachmentOption \| ((builder: SlashCommandAttachmentOption) => SlashCommandAttachmentOption)	No	A function that returns an option builder, or an already built builder

Inherited from SharedSlashCommandOptions

addBooleanOption(input)

:

ShouldOmitSubcommandFunctions extends true ? Omit<this, "addSubcommand" | "addSubcommandGroup"> : this

Adds a boolean option

Name	Type	Optional	Description
input	SlashCommandBooleanOption \| ((builder: SlashCommandBooleanOption) => SlashCommandBooleanOption)	No	A function that returns an option builder, or an already built builder

Inherited from SharedSlashCommandOptions

addChannelOption(input)

:

ShouldOmitSubcommandFunctions extends true ? Omit<this, "addSubcommand" | "addSubcommandGroup"> : this

Adds a channel option

Name	Type	Optional	Description
input	SlashCommandChannelOption \| ((builder: SlashCommandChannelOption) => SlashCommandChannelOption)	No	A function that returns an option builder, or an already built builder

Inherited from SharedSlashCommandOptions

addIntegerOption(input)

:

ShouldOmitSubcommandFunctions extends true ? Omit<this, "addSubcommand" | "addSubcommandGroup"> : this

Adds an integer option

Name	Type	Optional	Description
input	SlashCommandIntegerOption \| Omit<SlashCommandIntegerOption, 'setAutocomplete'> \| Omit<SlashCommandIntegerOption, 'addChoices'> \| ((builder: SlashCommandIntegerOption) => SlashCommandIntegerOption \| Omit<SlashCommandIntegerOption, 'setAutocomplete'> \| Omit<SlashCommandIntegerOption, 'addChoices'>)	No	A function that returns an option builder, or an already built builder

Inherited from SharedSlashCommandOptions

addMentionableOption(input)

:

ShouldOmitSubcommandFunctions extends true ? Omit<this, "addSubcommand" | "addSubcommandGroup"> : this

Adds a mentionable option

Name	Type	Optional	Description
input	SlashCommandMentionableOption \| ((builder: SlashCommandMentionableOption) => SlashCommandMentionableOption)	No	A function that returns an option builder, or an already built builder

Inherited from SharedSlashCommandOptions

addNumberOption(input)

:

ShouldOmitSubcommandFunctions extends true ? Omit<this, "addSubcommand" | "addSubcommandGroup"> : this

Adds a number option

Name	Type	Optional	Description
input	SlashCommandNumberOption \| Omit<SlashCommandNumberOption, 'setAutocomplete'> \| Omit<SlashCommandNumberOption, 'addChoices'> \| ((builder: SlashCommandNumberOption) => SlashCommandNumberOption \| Omit<SlashCommandNumberOption, 'setAutocomplete'> \| Omit<SlashCommandNumberOption, 'addChoices'>)	No	A function that returns an option builder, or an already built builder

Inherited from SharedSlashCommandOptions

addRoleOption(input)

:

ShouldOmitSubcommandFunctions extends true ? Omit<this, "addSubcommand" | "addSubcommandGroup"> : this

Adds a role option

Name	Type	Optional	Description
input	SlashCommandRoleOption \| ((builder: SlashCommandRoleOption) => SlashCommandRoleOption)	No	A function that returns an option builder, or an already built builder

Inherited from SharedSlashCommandOptions

addStringOption(input)

:

ShouldOmitSubcommandFunctions extends true ? Omit<this, "addSubcommand" | "addSubcommandGroup"> : this

Adds a string option

Name	Type	Optional	Description
input	SlashCommandStringOption \| Omit<SlashCommandStringOption, 'setAutocomplete'> \| Omit<SlashCommandStringOption, 'addChoices'> \| ((builder: SlashCommandStringOption) => SlashCommandStringOption \| Omit<SlashCommandStringOption, 'setAutocomplete'> \| Omit<SlashCommandStringOption, 'addChoices'>)	No	A function that returns an option builder, or an already built builder

Inherited from SharedSlashCommandOptions

addUserOption(input)

:

ShouldOmitSubcommandFunctions extends true ? Omit<this, "addSubcommand" | "addSubcommandGroup"> : this

Adds a user option

Name	Type	Optional	Description
input	SlashCommandUserOption \| ((builder: SlashCommandUserOption) => SlashCommandUserOption)	No	A function that returns an option builder, or an already built builder

Inherited from SharedSlashCommandOptions

setDescription(description)

:

this

Sets the description

Name	Type	Optional	Description
description	string	No	The description

Inherited from SharedNameAndDescription

setDescriptionLocalization(locale, localizedDescription)

:

this

Sets a description localization

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

Inherited from SharedNameAndDescription

setDescriptionLocalizations(localizedDescriptions)

:

this

Sets the description localizations

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

Inherited from SharedNameAndDescription

setName(name)

:

this

Sets the name

Name	Type	Optional	Description
name	string	No	The name

Inherited from SharedNameAndDescription

setNameLocalization(locale, localizedName)

:

this

Sets a name localization

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

Inherited from SharedNameAndDescription

setNameLocalizations(localizedNames)

:

this

Sets the name localizations

Name	Type	Optional	Description
localizedNames	LocalizationMap \| null	No	The dictionary of localized descriptions to set

Inherited from SharedNameAndDescription