Preview environment

class SlashCommandUserOption

export declare class SlashCommandUserOption extends ApplicationCommandOptionBase

A slash command user option.

readonlyoptional
description_localizations? : LocalizationMap

The description localizations of this command.

Inherited from: SharedNameAndDescription

readonly
description : string

The description of this command.

Inherited from: SharedNameAndDescription

readonlyoptional
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.User

The type of this option.

protected
runRequiredValidations() : void

This method runs required validators on this builder.

Inherited from: ApplicationCommandOptionBase

setDescription(
description: string
) : this

Sets the description of this command.

Inherited from: SharedNameAndDescription

setDescriptionLocalization(
locale: LocaleString
localizedDescription: string | null
) : this

Sets a description localization for this command.

Inherited from: SharedNameAndDescription

setDescriptionLocalizations(
localizedDescriptions: LocalizationMap | null
) : this

Sets the description localizations for this command.

Inherited from: SharedNameAndDescription

setName(
name: string
) : this

Sets the name of this command.

Inherited from: SharedNameAndDescription

setNameLocalization(
locale: LocaleString
localizedName: string | null
) : this

Sets a name localization for this command.

Inherited from: SharedNameAndDescription

setNameLocalizations(
localizedNames: LocalizationMap | null
) : this

Sets the name localizations for this command.

Inherited from: SharedNameAndDescription

setRequired(
required: boolean
) : this

Sets whether this option is required.

Inherited from: ApplicationCommandOptionBase

toJSON() : APIApplicationCommandUserOption

Serializes this builder to API-compatible JSON data.