@discord-types/builders/guild/overwrite
API reference for @discord-types/builders/guild/overwrite
@discord-types/builders/guild/overwrite
Types
Overwrite
Raw Type
type Overwrite = Overwrite.Prototype, & {
allowedPermissionFlags: {permissionTypes.Permissions},
deniedPermissionFlags: {permissionTypes.Permissions},
type: PermissionOverwriteType,
id: apiTypes.Snowflake
}
Intersection with variants:
Variant 2
Prop | Type | Description |
---|---|---|
allowedPermissionFlags | - | |
deniedPermissionFlags | - | |
type | - | |
id | - |
JSON
Raw Type
type JSON = Overwrite.Prototype.build(nil :: any),
PermissionOverwriteType
Raw Type
type PermissionOverwriteType = "role" | "member"
Union with variants:
Variant 1
"role"
Variant 2
"member"
PermissionOverwriteObject
Raw Type
type PermissionOverwriteObject = apiTypes.OverwriteObject
Functions
Overwrite.Prototype.allowPermissions
[[ Responsible for allowing specific permissionTypes to be set on either a Role of a Member. ]]
Function Signature
--[[
Responsible for allowing specific permissionTypes to be set on either a Role of a Member.
]]
function Overwrite.Prototype.allowPermissions(self: Overwrite, ...: permissionTypes.Permissions) -> Overwrite end
Arguments
...
Returns
ret1
Overwrite.Prototype.denyPermissions
[[ Responsible for denying specific permissionTypes to be set on either a Role of a Member. ]]
Function Signature
--[[
Responsible for denying specific permissionTypes to be set on either a Role of a Member.
]]
function Overwrite.Prototype.denyPermissions(self: Overwrite, ...: permissionTypes.Permissions) -> Overwrite end
Arguments
...
Returns
ret1
Overwrite.Prototype.build
[[ Responsible for building the OverwriteObject JSON that can be parsed by the Discord API. ]]
Function Signature
--[[
Responsible for building the OverwriteObject JSON that can be parsed by the Discord API.
]]
function Overwrite.Prototype.build(self: Overwrite) -> JSON end
Returns
ret1
Overwrite.Interface.new
[[ Responsible for creating a new Overwrite.
```lua
``` ]]
Function Signature
--[[
Responsible for creating a new Overwrite.
\`\`\`lua
\`\`\`
]]
function Overwrite.Interface.new(resource: {
permissionType: PermissionOverwriteType,
allowFlags: {permissionTypes.Permissions}?,
denyFlags: {permissionTypes.Permissions}?
}) -> Overwrite end
Arguments
resource
Prop | Type | Description |
---|---|---|
permissionType | - | |
allowFlags? | - | |
denyFlags? | - |
Returns
ret1
Overwrite.Interface.fromId
[[ Responsible for creating a new Overwrite from an existing ID/Object.
Supports properties that the .new constructor doesn't support. (id) ]]
Function Signature
--[[
Responsible for creating a new Overwrite from an existing ID/Object.
Supports properties that the .new constructor doesn't support. (id)
]]
function Overwrite.Interface.fromId(resource: {
permissionId: apiTypes.Snowflake,
permissionType: PermissionOverwriteType,
allowFlags: {permissionTypes.Permissions}?,
denyFlags: {permissionTypes.Permissions}?
}) -> Overwrite end
Arguments
resource
Prop | Type | Description |
---|---|---|
permissionId | - | |
permissionType | - | |
allowFlags? | - | |
denyFlags? | - |
Returns
ret1
Last updated on