Abstract
The base application command option builder that contains common symbols for application command builders.
Extends
SharedNameAndDescriptionReadonly
The description localizations of this command.
Inherited from SharedNameAndDescriptionThe description of this command.
Inherited from SharedNameAndDescriptionReadonly
The name localizations of this command.
Inherited from SharedNameAndDescriptionThe name of this command.
Inherited from SharedNameAndDescriptionAbstractReadonly
The type of this option.
This method runs required validators on this builder.
Sets the description of this command.
| Name | Type | Optional | Description |
|---|---|---|---|
| description | string | No | The description to use |
Sets a description localization for this command.
| Name | Type | Optional | Description |
|---|---|---|---|
| locale | LocaleString | No | The locale to set |
| localizedDescription | string | null | No | The localized description for the given locale |
Sets the description localizations for this command.
| Name | Type | Optional | Description |
|---|---|---|---|
| localizedDescriptions | LocalizationMap | null | No | The object of localized descriptions to set |
Sets the name of this command.
| Name | Type | Optional | Description |
|---|---|---|---|
| name | string | No | The name to use |
Sets a name localization for this command.
| Name | Type | Optional | Description |
|---|---|---|---|
| locale | LocaleString | No | The locale to set |
| localizedName | string | null | No | The localized name for the given locale |
Sets the name localizations for this command.
| Name | Type | Optional | Description |
|---|---|---|---|
| localizedNames | LocalizationMap | null | No | The object of localized names to set |
Sets whether this option is required.
| Name | Type | Optional | Description |
|---|---|---|---|
| required | boolean | No | Whether this option should be required |
Abstract
Serializes this builder to API-compatible JSON data.