Class AutoModerationRule

constructor

• new AutoModerationRule(data, client): AutoModerationRule

• Parameters

  • data: RawAutoModerationRule

  • client: Client<ClientEvents>

  Returns AutoModerationRule

actions

Optional creator

creatorID

enabled

eventType

exemptChannels

exemptRoles

guildID

name

triggerMetadata

triggerType

guild

• get guild(): Guild

• The guild this rule is in. This will throw an error if the guild is not cached.

  Returns Guild

deleteAutoModerationRule

• deleteAutoModerationRule(reason?): Promise<void>

• Delete this auto moderation rule.

  Parameters

  • Optional reason: string

    The reason for deleting this rule.

  Returns Promise<void>

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>

toJSON

• toJSON(): JSONAutoModerationRule

• Returns JSONAutoModerationRule