Overwrite
Implementation of discords Permission Overwrite object as a Luau builder.
See permissions for more information about the allow and deny fields.
https://discord.com/developers/docs/topics/permissions#permissions https://discord.com/developers/docs/resources/channel#overwrite-object
Summary
Properties
Overwrite.allowedPermissionFlags :: {apiTypes.Permissions}Overwrite.deniedPermissionFlags :: {apiTypes.Permissions}Overwrite.type :: PermissionOverwriteTypeOverwrite.id :: stringMethods
Overwrite:allowPermissions(...: apiTypes.Permissions) → OverwriteOverwrite:denyPermissions(...: apiTypes.Permissions) → OverwriteOverwrite:setPermissionType(type: PermissionOverwriteType) → OverwriteOverwrite:build() → JSONFunctions
Overwrite.new(resource: { permissionType: PermissionOverwriteType, allowFlags: { apiTypes.Permissions }?, denyFlags: { apiTypes.Permissions }?, }) → OverwriteOverwrite.fromId(resource: { permissionId: apiTypes.Snowflake, permissionType: PermissionOverwriteType, allowFlags: { apiTypes.Permissions }?, denyFlags: { apiTypes.Permissions }?, }) → OverwriteProperties
Section titled “Properties”allowedPermissionFlags
Section titled “allowedPermissionFlags”Array of permission flags that are allowed for this overwrite.
deniedPermissionFlags
Section titled “deniedPermissionFlags”Array of permission flags that are denied for this overwrite.
The type of overwrite, either “role” or “member”.
The ID of the role or user that the overwrite belongs to.
Methods
Section titled “Methods”allowPermissions
Section titled “allowPermissions”Overwrite : allowPermissions ( ... ) -> Overwrite
Responsible for allowing specific permissions to be set on either a Role of a Member.
Parameters
| ...: Permissions |
Returns
| Overwrite |
denyPermissions
Section titled “denyPermissions”Overwrite : denyPermissions ( ... ) -> Overwrite
Responsible for denying specific permissions to be set on either a Role of a Member.
Parameters
| ...: Permissions |
Returns
| Overwrite |
setPermissionType
Section titled “setPermissionType”Overwrite : setPermissionType ( type ) -> Overwrite
Sets the permission type for this builder.
Parameters
| type: PermissionOverwriteType |
Returns
| Overwrite |
Overwrite : build ( ) -> JSON
Responsible for building the OverwriteObject JSON that can be parsed by the Discord API.
Returns
| JSON |
Functions
Section titled “Functions”Overwrite . new ( resource ) -> Overwrite
Responsible for creating a new Overwrite.
Parameters
| resource: { permissionType: PermissionOverwriteType, allowFlags: { apiTypes.Permissions, } |
Returns
| Overwrite |
fromId
Section titled “fromId”Overwrite . fromId ( resource ) -> Overwrite
Responsible for creating a new Overwrite from an existing ID/Object.
Supports properties that the .new constructor doesn’t support. (id)
Parameters
| resource: { permissionId: apiTypes.Snowflake, permissionType: PermissionOverwriteType, allowFlags: { apiTypes.Permissions, } |
Returns
| Overwrite |