Documentation/detritus-client/Structures

AutoModerationRuleclass

Auto Moderation Rule Structure

On this page

Overview
Constructor1
Properties12
Accessors6
Methods15

Auto Moderation Rule Structure

import { Structures } from 'detritus-client';

Structures.AutoModerationRule;

Hierarchy

StructureBaseStructureAutoModerationRule

15 properties3 methods15 inheritedsrc/structures/automoderationrule.ts:43

Constructor

new AutoModerationRule

src/structures/automoderationrule.ts:58

new AutoModerationRule(client: ShardClient, data?: BaseStructureData, isClone?: boolean)

Properties

actions

BaseCollection<number, AutoModerationRuleAction>

client

ShardClient

readonly

Inherited from BaseStructure.client

creatorId

string

Default ''

enabled

boolean

Default false

eventType

AutoModerationRuleEventTypes

exemptChannels

BaseSet<string>

exemptRoles

BaseSet<string>

guildId

string

Default ''

string

Default ''

name

string

Default ''

triggerMetadata

AutoModerationRuleTriggerMetadata

triggerType

AutoModerationRuleTriggerTypes

Accessors

createdAt

Date

get

createdAtUnix

number

get

creator

User | null

get

guild

Guild | null

get

isClone

boolean

get

Inherited from BaseStructure.isClone

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]

clone()

src/structures/basestructure.ts:431

clone(): this

Inherited from BaseStructure.clone

delete()

async src/structures/automoderationrule.ts:86

delete(options: DeleteGuildAutoModerationRule): 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/automoderationrule.ts:82

edit(options: EditGuildAutoModerationRule): Promise<AutoModerationRule>

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/automoderationrule.ts:90

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