Documentation/detritus-client/Structures

Overwriteclass

Channel Overwrite Structure, used in [ChannelGuildBase] Structures

On this page

Overview
Constructor1
Properties6
Accessors9
Methods16

Channel Overwrite Structure, used in [ChannelGuildBase] Structures

import { Structures } from 'detritus-client';

Structures.Overwrite;

Hierarchy

StructureBaseStructureOverwrite

12 properties5 methods14 inheritedsrc/structures/overwrite.ts:34

Constructor

new Overwrite

src/structures/overwrite.ts:43

new Overwrite(channel: Channel, data: BaseStructureData, isClone?: boolean)

Parameters

channel

Channel

data

BaseStructureData

isClone?

boolean

Default !!channel._clone

Properties

allow

bigint

Default Permissions.NONE

channel

Channel

readonly

client

ShardClient

readonly

Inherited from BaseStructure.client

deny

bigint

Default Permissions.NONE

string

Default ''

type

OverwriteTypes

Accessors

channelId

string

get

guild

Guild | null

get

guildId

string

get

isClone

boolean

get

Inherited from BaseStructure.isClone

isMember

boolean

get

isRole

boolean

get

member

Member | null

get

role

Role | null

get

shardId

number

get

Inherited from BaseStructure.shardId

Methods

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake

_setFromSnake()

src/structures/basestructure.ts:142

_setFromSnake(key: string, value: any): any

Inherited from BaseStructure._setFromSnake

[custom]()

src/structures/basestructure.ts:388

[custom](): object

Inherited from BaseStructure.[custom]

can()

src/structures/overwrite.ts:91

can(permissions: PermissionChecks): boolean

clone()

src/structures/overwrite.ts:50

clone(): this

Overrides BaseStructure.clone

delete()

async src/structures/overwrite.ts:98

delete(): Promise<any>

difference()

src/structures/basestructure.ts:146

difference(key: string, value: any): [boolean, any]

Inherited from BaseStructure.difference

differences()

src/structures/basestructure.ts:178

differences(data?: BaseStructureData): object | null

Inherited from BaseStructure.differences

differencesBetween()

src/structures/basestructure.ts:197

differencesBetween(structure: Structure): object | null

Inherited from BaseStructure.differencesBetween

edit()

async src/structures/overwrite.ts:102

edit(options?: EditChannelOverwrite): Promise<any>

hasDifference()

src/structures/basestructure.ts:218

hasDifference(key: string, value: any): boolean

Inherited from BaseStructure.hasDifference

hasDifferences()

src/structures/basestructure.ts:293

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences

hasDifferencesBetween()

src/structures/basestructure.ts:308

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween

merge()

src/structures/overwrite.ts:111

merge(data?: BaseStructureData): void

Overrides BaseStructure.merge

mergeValue()

src/structures/basestructure.ts:351

mergeValue(key: string, value: any): void

Inherited from BaseStructure.mergeValue

toJSON()

src/structures/basestructure.ts:357

toJSON(): object

Inherited from BaseStructure.toJSON