ContextMenuCommandBuilder
declare class ContextMenuCommandBuilder declare class ContextMenuCommandBuilder No summary provided.
Readonly
default_member_permissions
:
Permissions | null | undefined
Set of permissions represented as a bit set for the command
Deprecated
Readonly
default_permission
:
boolean | undefined
This property is deprecated and will be removed in the future. You should use
setDefaultMemberPermissions or setDMPermission instead.Deprecated
Readonly
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.
Readonly
Optional
name_localizations?
:
LocalizationMap
The localized names for this command
Readonly
name
:
string
The name of this context menu command
Readonly
type
:
ContextMenuCommandType
The type of this context menu command
setDefaultMemberPermissions(permissions)
:
this
Sets the default permissions a member should have in order to run the command.**Note:** You can set this to
'0' to disable the command by default.See Also
https://discord.com/developers/docs/interactions/application-commands#permissions| Name | Type | Optional | Description |
|---|---|---|---|
| permissions | Permissions | bigint | number | null | undefined | No | The permissions bit field to set |
Deprecated
setDefaultPermission(value)
:
this
Use
setDefaultMemberPermissions or setDMPermission instead.Deprecated
false, you will have to later PUT the permissions for this command.See Also
https://discord.com/developers/docs/interactions/application-commands#permissions| Name | Type | Optional | Description |
|---|---|---|---|
| value | boolean | No | Whether or not to enable this command by default |
setDMPermission(enabled)
:
this
Sets if the command is available in DMs with the application, only for globally-scoped commands. By default, commands are visible.
See Also
https://discord.com/developers/docs/interactions/application-commands#permissions| Name | Type | Optional | Description |
|---|---|---|---|
| enabled | boolean | null | undefined | No | If the command should be enabled in DMs |
setName(name)
:
this
Sets the name
| Name | Type | Optional | Description |
|---|---|---|---|
| name | string | No | The name |
setNameLocalization(locale, localizedName)
:
this
Sets a name localization
| Name | Type | Optional | Description |
|---|---|---|---|
| locale | LocaleString | No | The locale to set a description for |
| localizedName | string | null | No | The localized description for the given locale |
setNameLocalizations(localizedNames)
:
this
Sets the name localizations
| Name | Type | Optional | Description |
|---|---|---|---|
| localizedNames | LocalizationMap | null | No | The dictionary of localized descriptions to set |
setType(type)
:
this
Sets the type
| Name | Type | Optional | Description |
|---|---|---|---|
| type | ContextMenuCommandType | No | The type |
toJSON()
:
RESTPostAPIApplicationCommandsJSONBody
Returns the final data that should be sent to Discord.**Note:** Calling this function will validate required properties based on their conditions.