Class AutoModerationRule

Represents an auto moderation rule.

Hierarchy

Base
- AutoModerationRule

Index

Accessors

createdAt

get createdAt(): Date
Returns Date
Inherited from Base.createdAt
- Defined in lib/structures/Base.ts:39

guild

get guild(): Guild
The guild this rule is in. This will throw an error if the guild is not cached.

Returns Guild
- Defined in lib/structures/AutoModerationRule.ts:107

Constructors

constructor

new AutoModerationRule(data, client): AutoModerationRule
Parameters
- data: RawAutoModerationRule
- client: Client<ClientEvents>
Returns AutoModerationRule
Overrides Base.constructor
- Defined in lib/structures/AutoModerationRule.ts:36

Methods

deleteAutoModerationRule

deleteAutoModerationRule(reason?): Promise<void>
Delete this auto moderation rule.
Parameters
- Optional reason: string
  
  The reason for deleting this rule.
Returns Promise<void>
- Defined in lib/structures/AutoModerationRule.ts:120

edit

edit(options): Promise<AutoModerationRule>
Edit this auto moderation rule.
Parameters
- options: Partial<Pick<CreateAutoModerationRuleOptions, "name" | "reason" | "eventType" | "triggerMetadata" | "actions" | "enabled" | "exemptRoles" | "exemptChannels">>
  
  The options for editing the rule.
Returns Promise<AutoModerationRule>
- Defined in lib/structures/AutoModerationRule.ts:128

toJSON

toJSON(): JSONAutoModerationRule
Returns JSONAutoModerationRule
Overrides Base.toJSON
- Defined in lib/structures/AutoModerationRule.ts:132

toString

toString(): string
Returns string
Inherited from Base.toString
- Defined in lib/structures/Base.ts:64

`Static` generateID

generateID(timestamp?): string
Parameters
- timestamp: number | Date = ...
Returns string
Inherited from Base.generateID
- Defined in lib/structures/Base.ts:21

`Static` getCreatedAt

getCreatedAt(id): Date
Parameters
- id: string
Returns Date
Inherited from Base.getCreatedAt
- Defined in lib/structures/Base.ts:28

`Static` getDiscordEpoch

getDiscordEpoch(id): number
Parameters
- id: string
Returns number
Inherited from Base.getDiscordEpoch
- Defined in lib/structures/Base.ts:32

Properties

actions

actions: AutoModerationAction[]

The actions that will execute when this rule is triggered.

client

client: Client<ClientEvents>

`Optional` creator

creator?: User

The creator of this rule.

creatorID

creatorID: string

The ID of the creator of this rule.

enabled

enabled: boolean

If this rule is enabled.

eventType

eventType: MESSAGE_SEND

The event type of this rule.

exemptChannels

exemptChannels: string[]

The channels that are exempt from this rule.

exemptRoles

exemptRoles: string[]

The roles that are exempt from this rule.

guildID

guildID: string

The id of the guild this rule is in.

id

id: string

name

name: string

The name of this rule

triggerMetadata

triggerMetadata: TriggerMetadata

The metadata of this rule's trigger.

triggerType

triggerType: AutoModerationTriggerTypes

This rule's trigger type.

Class AutoModerationRule

Hierarchy

Index

Accessors

Constructors

Methods

Properties

Accessors

createdAt

Returns Date

guild

Returns Guild

Constructors

constructor

Parameters

data: RawAutoModerationRule

client: Client<ClientEvents>

Returns AutoModerationRule

Methods

deleteAutoModerationRule

Parameters

Optional reason: string

Returns Promise<void>

edit

Parameters

options: Partial<Pick<CreateAutoModerationRuleOptions, "name" | "reason" | "eventType" | "triggerMetadata" | "actions" | "enabled" | "exemptRoles" | "exemptChannels">>

Returns Promise<AutoModerationRule>

toJSON

Returns JSONAutoModerationRule

toString

Returns string

Static generateID

Parameters

timestamp: number | Date = ...

Returns string

Static getCreatedAt

Parameters

id: string

Returns Date

Static getDiscordEpoch

Parameters

id: string

Returns number

Properties

actions

client

Optional creator

creatorID

enabled

eventType

exemptChannels

exemptRoles

guildID

id

name

triggerMetadata

triggerType

On This Page

`Optional` reason: string

`Static` generateID

`Static` getCreatedAt

`Static` getDiscordEpoch

`Optional` creator