Search...

SlashCommandNumberOption

export declare class SlashCommandNumberOption extends ApplicationCommandOptionBase implements ApplicationCommandNumericOptionMinMaxValueMixin 
export declare class SlashCommandNumberOption extends ApplicationCommandOptionBase implements ApplicationCommandNumericOptionMinMaxValueMixin 
A slash command number option.
Readonly
Optional

description_localizations?

:

LocalizationMap

The description localizations of this command.
Inherited from SharedNameAndDescription
Readonly

description

:

string

The description of this command.
Inherited from SharedNameAndDescription
Readonly
Optional

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.
Inherited from ApplicationCommandOptionBase
Readonly

type

:

ApplicationCommandOptionType.Number

The type of this option.
Readonly
Optional

autocomplete?

:

boolean

Whether this option utilizes autocomplete.
Inherited from ApplicationCommandOptionWithChoicesAndAutocompleteMixin
Readonly
Optional

choices?

:

APIApplicationCommandOptionChoice<T>[]

The choices of this option.
Inherited from ApplicationCommandOptionWithChoicesAndAutocompleteMixin
Readonly
Optional

max_value?

:

number

The maximum value of this option.
Inherited from ApplicationCommandNumericOptionMinMaxValueMixin
Readonly
Optional

min_value?

:

number

The minimum value of this option.
Inherited from ApplicationCommandNumericOptionMinMaxValueMixin
Protected

runRequiredValidations()

:

void

This method runs required validators on this builder.
Inherited from ApplicationCommandOptionBase

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

setMaxValue(max)

:

this

Sets the maximum number value of this option.
NameTypeOptionalDescription
maxnumberNoThe maximum value this option can be

setMinValue(min)

:

this

Sets the minimum number value of this option.
NameTypeOptionalDescription
minnumberNoThe minimum value this option can be

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
Inherited from ApplicationCommandOptionBase

toJSON()

:

APIApplicationCommandNumberOption

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.

addChoices(choices)

:

this

Adds multiple choices to this option.
NameTypeOptionalDescription
choicesAPIApplicationCommandOptionChoice<T>[]NoThe choices to add
Inherited from ApplicationCommandOptionWithChoicesAndAutocompleteMixin

setAutocomplete(autocomplete)

:

this

Whether this option uses autocomplete.
NameTypeOptionalDescription
autocompletebooleanNoWhether this option should use autocomplete
Inherited from ApplicationCommandOptionWithChoicesAndAutocompleteMixin

setChoices(choices)

:

this

Sets multiple choices for this option.
NameTypeOptionalDescription
choicesInputNoThe choices to set
Inherited from ApplicationCommandOptionWithChoicesAndAutocompleteMixin