Abstract

ApplicationCommandOptionBase

export declare abstract class ApplicationCommandOptionBase extends SharedNameAndDescription
export declare abstract class ApplicationCommandOptionBase extends SharedNameAndDescription
The base application command option builder that contains common symbols for application command builders.
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
AbstractReadonly
The type of this option.
Protected
runRequiredValidations():void
This method runs required validators on this builder.
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
setRequired(required):this
Sets whether this option is required.
NameTypeOptionalDescription
requiredbooleanNoWhether this option should be required
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.