Class AresChatInputCommandBuilder

Hierarchy

Constructors

constructor

Properties

type isDisabled name name_localizations? description description_localizations? options contexts? default_permission default_member_permissions dm_permission integration_types? nsfw

Methods

setDisabled setName setDescription setNameLocalization setNameLocalizations setDescriptionLocalization setDescriptionLocalizations addBooleanOption addUserOption addChannelOption addRoleOption addAttachmentOption addMentionableOption addStringOption addIntegerOption addNumberOption addSubcommandGroup addSubcommand setContexts setIntegrationTypes setDefaultPermission setDefaultMemberPermissions setDMPermission setNSFW toJSON

Constructors

constructor

Properties

type

type: ApplicationCommandType = ApplicationCommandType.ChatInput

isDisabled

isDisabled: boolean = true

Readonly name

name: string

The name of this command.

Optional Readonly name_localizations

name_localizations?: Partial<Record<"id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>

The name localizations of this command.

Readonly description

description: string

The description of this command.

Optional Readonly description_localizations

description_localizations?: Partial<Record<"id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>

The description localizations of this command.

Readonly options

options: ToAPIApplicationCommandOptions[]

The options of this command.

Optional Readonly contexts

contexts?: InteractionContextType[]

The contexts for this command.

Readonly default_permission

default_permission: undefined | boolean

Whether this command is enabled by default when the application is added to a guild.

Deprecated

Use SharedSlashCommand.setDefaultMemberPermissions or SharedSlashCommand.setDMPermission instead.

Readonly default_member_permissions

default_member_permissions: undefined | null | string

The set of permissions represented as a bit set for the command.

Readonly dm_permission

dm_permission: undefined | boolean

Indicates whether the command is available in direct messages with the application.

Remarks

By default, commands are visible. This property is only for global commands.

Deprecated

Use SlashCommandBuilder.contexts instead.

Optional Readonly integration_types

integration_types?: ApplicationIntegrationType[]

The integration types for this command.

Readonly nsfw

nsfw: undefined | boolean

Whether this command is NSFW.

Methods

setDisabled

setName

  • setName(name): AresChatInputCommandBuilder

  • Sets the name of this command.

    Parameters

    • name: string

      The name to use

    Returns AresChatInputCommandBuilder

setDescription

  • setDescription(description): AresChatInputCommandBuilder

  • Sets the description of this command.

    Parameters

    • description: string

      The description to use

    Returns AresChatInputCommandBuilder

setNameLocalization

  • setNameLocalization(locale, localizedName): AresChatInputCommandBuilder

  • Sets a name localization for this command.

    Parameters

    • locale: "id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi"

      The locale to set

    • localizedName: null | string

      The localized name for the given locale

    Returns AresChatInputCommandBuilder

setNameLocalizations

  • setNameLocalizations(localizedNames): AresChatInputCommandBuilder

  • Sets the name localizations for this command.

    Parameters

    • localizedNames: null | Partial<Record<"id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>

      The object of localized names to set

    Returns AresChatInputCommandBuilder

setDescriptionLocalization

  • setDescriptionLocalization(locale, localizedDescription): AresChatInputCommandBuilder

  • Sets a description localization for this command.

    Parameters

    • locale: "id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi"

      The locale to set

    • localizedDescription: null | string

      The localized description for the given locale

    Returns AresChatInputCommandBuilder

setDescriptionLocalizations

  • setDescriptionLocalizations(localizedDescriptions): AresChatInputCommandBuilder

  • Sets the description localizations for this command.

    Parameters

    • localizedDescriptions: null | Partial<Record<"id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>

      The object of localized descriptions to set

    Returns AresChatInputCommandBuilder

addBooleanOption

  • addBooleanOption(input): SlashCommandOptionsOnlyBuilder

  • Adds a boolean option.

    Parameters

    • input: SlashCommandBooleanOption | ((builder) => SlashCommandBooleanOption)

      A function that returns an option builder or an already built builder

    Returns SlashCommandOptionsOnlyBuilder

addUserOption

  • addUserOption(input): SlashCommandOptionsOnlyBuilder

  • Adds a user option.

    Parameters

    • input: SlashCommandUserOption | ((builder) => SlashCommandUserOption)

      A function that returns an option builder or an already built builder

    Returns SlashCommandOptionsOnlyBuilder

addChannelOption

  • addChannelOption(input): SlashCommandOptionsOnlyBuilder

  • Adds a channel option.

    Parameters

    • input: SlashCommandChannelOption | ((builder) => SlashCommandChannelOption)

      A function that returns an option builder or an already built builder

    Returns SlashCommandOptionsOnlyBuilder

addRoleOption

  • addRoleOption(input): SlashCommandOptionsOnlyBuilder

  • Adds a role option.

    Parameters

    • input: SlashCommandRoleOption | ((builder) => SlashCommandRoleOption)

      A function that returns an option builder or an already built builder

    Returns SlashCommandOptionsOnlyBuilder

addAttachmentOption

  • addAttachmentOption(input): SlashCommandOptionsOnlyBuilder

  • Adds an attachment option.

    Parameters

    • input: SlashCommandAttachmentOption | ((builder) => SlashCommandAttachmentOption)

      A function that returns an option builder or an already built builder

    Returns SlashCommandOptionsOnlyBuilder

addMentionableOption

  • addMentionableOption(input): SlashCommandOptionsOnlyBuilder

  • Adds a mentionable option.

    Parameters

    • input: SlashCommandMentionableOption | ((builder) => SlashCommandMentionableOption)

      A function that returns an option builder or an already built builder

    Returns SlashCommandOptionsOnlyBuilder

addStringOption

  • addStringOption(input): SlashCommandOptionsOnlyBuilder

  • Adds a string option.

    Parameters

    • input: SlashCommandStringOption | ((builder) => SlashCommandStringOption)

      A function that returns an option builder or an already built builder

    Returns SlashCommandOptionsOnlyBuilder

addIntegerOption

  • addIntegerOption(input): SlashCommandOptionsOnlyBuilder

  • Adds an integer option.

    Parameters

    • input: SlashCommandIntegerOption | ((builder) => SlashCommandIntegerOption)

      A function that returns an option builder or an already built builder

    Returns SlashCommandOptionsOnlyBuilder

addNumberOption

  • addNumberOption(input): SlashCommandOptionsOnlyBuilder

  • Adds a number option.

    Parameters

    • input: SlashCommandNumberOption | ((builder) => SlashCommandNumberOption)

      A function that returns an option builder or an already built builder

    Returns SlashCommandOptionsOnlyBuilder

addSubcommandGroup

  • addSubcommandGroup(input): SlashCommandSubcommandsOnlyBuilder

  • Adds a new subcommand group to this command.

    Parameters

    • input: SlashCommandSubcommandGroupBuilder | ((subcommandGroup) => SlashCommandSubcommandGroupBuilder)

      A function that returns a subcommand group builder or an already built builder

    Returns SlashCommandSubcommandsOnlyBuilder

addSubcommand

  • addSubcommand(input): SlashCommandSubcommandsOnlyBuilder

  • Adds a new subcommand to this command.

    Parameters

    • input: SlashCommandSubcommandBuilder | ((subcommandGroup) => SlashCommandSubcommandBuilder)

      A function that returns a subcommand builder or an already built builder

    Returns SlashCommandSubcommandsOnlyBuilder

setContexts

  • setContexts(...contexts): AresChatInputCommandBuilder

  • Sets the contexts of this command.

    Parameters

    • Rest ...contexts: RestOrArray<InteractionContextType>

      The contexts

    Returns AresChatInputCommandBuilder

setIntegrationTypes

  • setIntegrationTypes(...integrationTypes): AresChatInputCommandBuilder

  • Sets the integration types of this command.

    Parameters

    • Rest ...integrationTypes: RestOrArray<ApplicationIntegrationType>

      The integration types

    Returns AresChatInputCommandBuilder

setDefaultPermission

  • setDefaultPermission(value): AresChatInputCommandBuilder

  • Sets whether the command is enabled by default when the application is added to a guild.

    Parameters

    • value: boolean

      Whether or not to enable this command by default

    Returns AresChatInputCommandBuilder

    Remarks

    If set to false, you will have to later PUT the permissions for this command.

    See

    https://discord.com/developers/docs/interactions/application-commands#permissions

    Deprecated

    Use SharedSlashCommand.setDefaultMemberPermissions or SharedSlashCommand.setDMPermission instead.

setDefaultMemberPermissions

setDMPermission

setNSFW

  • setNSFW(nsfw?): AresChatInputCommandBuilder

  • Sets whether this command is NSFW.

    Parameters

    • Optional nsfw: boolean

      Whether this command is NSFW

    Returns AresChatInputCommandBuilder

toJSON

  • toJSON(): RESTPostAPIChatInputApplicationCommandsJSONBody

  • Serializes this builder to API-compatible JSON data.

    Returns RESTPostAPIChatInputApplicationCommandsJSONBody

    Remarks

    This method runs validations on the data before serializing it. As such, it may throw an error if the data is invalid.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc