Class AresContextMenuCommandBuilder

Hierarchy

Constructors

constructor

Properties

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

Methods

setDisabled setName setDescription setNameLocalization setNameLocalizations setDescriptionLocalization setDescriptionLocalizations setContexts setIntegrationTypes setType setDefaultPermission setDefaultMemberPermissions setDMPermission toJSON

Constructors

constructor

Properties

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 type

type: ContextMenuCommandType

The type 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 ContextMenuCommandBuilder.setDefaultMemberPermissions or ContextMenuCommandBuilder.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 ContextMenuCommandBuilder.contexts instead.

Optional Readonly integration_types

integration_types?: ApplicationIntegrationType[]

The integration types for this command.

Methods

setDisabled

setName

  • setName(name): AresContextMenuCommandBuilder

  • Sets the name of this command.

    Parameters

    • name: string

      The name to use

    Returns AresContextMenuCommandBuilder

setDescription

  • setDescription(description): AresContextMenuCommandBuilder

  • Sets the description of this command.

    Parameters

    • description: string

      The description to use

    Returns AresContextMenuCommandBuilder

setNameLocalization

  • setNameLocalization(locale, localizedName): AresContextMenuCommandBuilder

  • 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 AresContextMenuCommandBuilder

setNameLocalizations

  • setNameLocalizations(localizedNames): AresContextMenuCommandBuilder

  • 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 AresContextMenuCommandBuilder

setDescriptionLocalization

  • setDescriptionLocalization(locale, localizedDescription): AresContextMenuCommandBuilder

  • 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 AresContextMenuCommandBuilder

setDescriptionLocalizations

  • setDescriptionLocalizations(localizedDescriptions): AresContextMenuCommandBuilder

  • 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 AresContextMenuCommandBuilder

setContexts

  • setContexts(...contexts): AresContextMenuCommandBuilder

  • Sets the contexts of this command.

    Parameters

    • Rest ...contexts: RestOrArray<InteractionContextType>

      The contexts

    Returns AresContextMenuCommandBuilder

setIntegrationTypes

  • setIntegrationTypes(...integrationTypes): AresContextMenuCommandBuilder

  • Sets integration types of this command.

    Parameters

    • Rest ...integrationTypes: RestOrArray<ApplicationIntegrationType>

      The integration types

    Returns AresContextMenuCommandBuilder

setType

  • setType(type): AresContextMenuCommandBuilder

  • Sets the type of this command.

    Parameters

    • type: ContextMenuCommandType

      The type to use

    Returns AresContextMenuCommandBuilder

setDefaultPermission

  • setDefaultPermission(value): AresContextMenuCommandBuilder

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

    Parameters

    • value: boolean

      Whether to enable this command by default

    Returns AresContextMenuCommandBuilder

    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 ContextMenuCommandBuilder.setDefaultMemberPermissions or ContextMenuCommandBuilder.setDMPermission instead.

setDefaultMemberPermissions

setDMPermission

toJSON

  • toJSON(): RESTPostAPIContextMenuApplicationCommandsJSONBody

  • Serializes this builder to API-compatible JSON data.

    Returns RESTPostAPIContextMenuApplicationCommandsJSONBody

    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