SlashCommandStringOption
A slash command string option.
export declare class SlashCommandStringOption extends ApplicationCommandOptionBase export declare class SlashCommandStringOption extends ApplicationCommandOptionBase Extends
ApplicationCommandOptionBaseReadonly
Optional
The description localizations of this command.Inherited from SharedNameAndDescription
Readonly
description
:
string
The description of this command.Inherited from SharedNameAndDescription
Readonly
Optional
max_length?
:
number
The maximum length of this option.
Readonly
Optional
min_length?
:
number
The minimum length of this option.
Readonly
Optional
The name localizations of this command.Inherited from SharedNameAndDescription
Readonly
name
:
string
The name of this command.Inherited from SharedNameAndDescription
Readonly
required
:
boolean
Readonly
The type of this option.
Protected
runRequiredValidations()
:
void
This method runs required validators on this builder.Inherited from ApplicationCommandOptionBase
setDescription(description)
:
this
Sets the description of this command.
Inherited from SharedNameAndDescription
| Name | Type | Optional | Description |
|---|---|---|---|
| description | string | No | The description to use |
setDescriptionLocalization(locale, localizedDescription)
:
this
Sets a description localization for this command.
Inherited from SharedNameAndDescription
| Name | Type | Optional | Description |
|---|---|---|---|
| locale | LocaleString | No | The locale to set |
| localizedDescription | string | null | No | The localized description for the given locale |
setDescriptionLocalizations(localizedDescriptions)
:
this
Sets the description localizations for this command.
Inherited from SharedNameAndDescription
| Name | Type | Optional | Description |
|---|---|---|---|
| localizedDescriptions | LocalizationMap | null | No | The object of localized descriptions to set |
setMaxLength(max)
:
this
Sets the maximum length of this string option.
| Name | Type | Optional | Description |
|---|---|---|---|
| max | number | No | The maximum length this option can be |
setMinLength(min)
:
this
Sets the minimum length of this string option.
| Name | Type | Optional | Description |
|---|---|---|---|
| min | number | No | The minimum length this option can be |
setName(name)
:
this
Sets the name of this command.
Inherited from SharedNameAndDescription
| Name | Type | Optional | Description |
|---|---|---|---|
| name | string | No | The name to use |
setNameLocalization(locale, localizedName)
:
this
SSets a name localization for this command.
Inherited from SharedNameAndDescription
| Name | Type | Optional | Description |
|---|---|---|---|
| locale | LocaleString | No | The locale to set |
| localizedName | string | null | No | The localized name for the given locale |
setNameLocalizations(localizedNames)
:
this
Sets the name localizations for this command.
Inherited from SharedNameAndDescription
| Name | Type | Optional | Description |
|---|---|---|---|
| localizedNames | LocalizationMap | null | No | The object of localized names to set |
setRequired(required)
:
this
Sets whether this option is required.
Inherited from ApplicationCommandOptionBase
| Name | Type | Optional | Description |
|---|---|---|---|
| required | boolean | No | Whether this option should be required |
Serializes this builder to API-compatible JSON data.