CommandPermission

Implementation of the Application Command Permission Structure as a Luau builder.

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

Summary

Properties

CommandPermission.id :: string?CommandPermission.type :: CommandPermissionType?CommandPermission.permission :: boolean

Methods

CommandPermission:setId(id: apiTypes.Snowflake) → CommandPermissionCommandPermission:setType(permissionType: CommandPermissionType) → CommandPermissionCommandPermission:allow() → CommandPermissionCommandPermission:deny() → CommandPermissionCommandPermission:build() → JSON

Functions

CommandPermission.new(resource: { id: apiTypes.Snowflake?, permissionType: CommandPermissionType?, permission: boolean?, }?) → CommandPermission

Properties

id

CommandPermission.id  :: string?

---

The ID of the role, user, or channel this permission applies to.

type

CommandPermission.type  :: CommandPermissionType?

---

Whether this permission targets a role, user, or channel.

permission

CommandPermission.permission  :: boolean

---

Whether the target is allowed (true) or denied (false) access to the command.

Methods

setId

CommandPermission : setId ( id )  -> CommandPermission

Sets the ID of the role, user, or channel this permission applies to.

Parameters

id: Snowflake

Returns

CommandPermission

setType

CommandPermission : setType ( permissionType )  -> CommandPermission

Sets the type of entity this permission targets.

Parameters

permissionType: CommandPermissionType

Returns

CommandPermission

allow

CommandPermission : allow ( )  -> CommandPermission

Allows the targeted role, user, or channel to use the command.

Returns

CommandPermission

deny

CommandPermission : deny ( )  -> CommandPermission

Denies the targeted role, user, or channel from using the command.

Returns

CommandPermission

build

CommandPermission : build ( )  -> JSON

Responsible for building the GuildApplicationCommandPermissionObject JSON that can be parsed by the Discord API.

Returns

JSON

Functions

new

CommandPermission . new ( resource )  -> CommandPermission

Responsible for creating a new CommandPermission.

Parameters

resource: { id: apiTypes.Snowflake?, permissionType: CommandPermissionType?, permission: boolean?, }

Returns

CommandPermission