Class PermissionOverwrite

Implements

PermissionOverwrite

Index

Constructors

Accessors

allow deny id type

Methods

[custom] toJSON toString

Constructors

constructor

new PermissionOverwrite(
    client: Client,
    data:
        | PermissionOverwriteStorageJSON
        | PermissionOverwriteDiscordJSON
        | PermissionOverwriteCacheJSON
        | APIOverwrite,
): PermissionOverwrite
Creates the structure for a permission overwrite.
Parameters
- client: Client
  The client instance.
- data:
      | PermissionOverwriteStorageJSON
      | PermissionOverwriteDiscordJSON
      | PermissionOverwriteCacheJSON
      | APIOverwrite
  The raw permission overwrite data.
Returns PermissionOverwrite
- Defined in src/structures/PermissionOverwrite.ts:23

Accessors

allow

get allow(): string
The permissions for the overwrite.

Returns string
Implementation of PermissionOverwriteType.allow
- Defined in src/structures/PermissionOverwrite.ts:94

deny

get deny(): string
The denied permissions for the overwrite.

Returns string
Implementation of PermissionOverwriteType.deny
- Defined in src/structures/PermissionOverwrite.ts:104

id

get id(): string
The ID of the overwrite.

Returns string
Implementation of PermissionOverwriteType.id
- Defined in src/structures/PermissionOverwrite.ts:74

type

get type(): OverwriteType
The type of the overwrite. 0 for role, 1 for member.

Returns OverwriteType
Implementation of PermissionOverwriteType.type
- Defined in src/structures/PermissionOverwrite.ts:84

Methods

[custom]

"[custom]"(): string
Returns string
Method
- Defined in src/structures/PermissionOverwrite.ts:120

toJSON

toJSON(
format?: JsonTypes,
): { allow: string; deny: string; id: string; type: OverwriteType }
Returns the JSON representation of this structure.
Parameters
- Optionalformat: JsonTypes
  The format to return the data in.
Returns { allow: string; deny: string; id: string; type: OverwriteType }
Method
Implementation of PermissionOverwriteType.toJSON
- Defined in src/structures/PermissionOverwrite.ts:131

toString

toString(): string
Returns string
Method
Implementation of PermissionOverwriteType.toString
- Defined in src/structures/PermissionOverwrite.ts:112