builders

ContextMenuCommandBuilder

export declare class ContextMenuCommandBuilder 

Summary

No summary provided.

Properties

default_member_permissions

:

Permissions | null | undefined

Set of permissions represented as a bit set for the command

default_permission

:

boolean | undefined

Whether the command is enabled by default when the app is added to a guild

dm_permission

:

boolean | undefined

Indicates whether the command is available in DMs with the application, only for globally-scoped commands. By default, commands are visible.

name_localizations

:

LocalizationMap

The localized names for this command

name

:

string

The name of this context menu command

The type of this context menu command

Methods

setDefaultMemberPermissions(permissions)

:

this

Sets the default permissions a member should have in order to run the command.

**Note:** You can set this to to disable the command by default.

NameTypeOptionalDescription
permissionsPermissions | bigint | number | null | undefinedNoNone

setDefaultPermission(value)

:

this

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

**Note**: If set to , you will have to later the permissions for this command.

NameTypeOptionalDescription
valuebooleanNoNone

setDMPermission(enabled)

:

this

Sets if the command is available in DMs with the application, only for globally-scoped commands. By default, commands are visible.

NameTypeOptionalDescription
enabledboolean | null | undefinedNoNone

setName(name)

:

this

Sets the name

NameTypeOptionalDescription
namestringNoNone

setNameLocalization(locale, localizedName)

:

this

Sets a name localization

NameTypeOptionalDescription
localeLocaleStringNoNone
localizedNamestring | nullNoNone

setNameLocalizations(localizedNames)

:

this

Sets the name localizations

NameTypeOptionalDescription
localizedNamesLocalizationMap | nullNoNone

setType(type)

:

this

Sets the type

NameTypeOptionalDescription
typeContextMenuCommandTypeNoNone

Returns the final data that should be sent to Discord.

**Note:** Calling this function will validate required properties based on their conditions.

builders