Class AutoModerationRule

Represents an auto moderation rule.

Hierarchy

  • Base
    • AutoModerationRule

Constructors

constructor

Properties

_cachedGuild? actions client creator? creatorID enabled eventType exemptChannels exemptRoles guildID id name triggerMetadata triggerType

Accessors

createdAt guild

Methods

deleteAutoModerationRule edit toJSON toString update generateID getCreatedAt getDiscordEpoch

Constructors

constructor

Properties

Private Optional _cachedGuild

_cachedGuild?: any

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.

Accessors

createdAt

  • get createdAt(): Date

  • Returns Date

guild

  • get guild(): Guild

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

    Returns Guild

Methods

deleteAutoModerationRule

  • Delete this auto moderation rule.

    Parameters

    • Optional reason: string

      The reason for deleting this rule.

    Returns Promise<void>

edit

  • Edit this auto moderation rule.

    Parameters

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

      The options for editing the rule.

    Returns Promise<AutoModerationRule>

toJSON

toString

  • Returns string

Protected update

  • Parameters

    Returns void

Static generateID

  • Parameters

    • Optional timestamp: number | Date

    Returns string

Static getCreatedAt

  • Parameters

    • id: string

    Returns Date

Static getDiscordEpoch

  • Parameters

    • id: string

    Returns number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc