Skip to main content

DiscordAutoModerationRule

Documentation


Documentation / @discordeno/types / DiscordAutoModerationRule

Interface: DiscordAutoModerationRule

Defined in: discord/autoModeration.ts:4

https://docs.discord.com/developers/resources/auto-moderation#auto-moderation-rule-object-auto-moderation-rule-structure

Properties

actions

actions: DiscordAutoModerationAction[]

Defined in: discord/autoModeration.ts:20

Actions which will execute whenever a rule is triggered.


creator_id

creator_id: string

Defined in: discord/autoModeration.ts:12

The id of the user who created this rule.


enabled

enabled: boolean

Defined in: discord/autoModeration.ts:22

Whether the rule is enabled.


event_type

event_type: AutoModerationEventTypes

Defined in: discord/autoModeration.ts:14

Indicates in what event context a rule should be checked.


exempt_channels

exempt_channels: string[]

Defined in: discord/autoModeration.ts:26

The channel ids that are whitelisted. Max 50.


exempt_roles

exempt_roles: string[]

Defined in: discord/autoModeration.ts:24

The role ids that are whitelisted. Max 20.


guild_id

guild_id: string

Defined in: discord/autoModeration.ts:8

The guild id of the rule


id

id: string

Defined in: discord/autoModeration.ts:6

The id of this rule


name

name: string

Defined in: discord/autoModeration.ts:10

The name of the rule


trigger_metadata

trigger_metadata: DiscordAutoModerationRuleTriggerMetadata

Defined in: discord/autoModeration.ts:18

The metadata used to determine whether a rule should be triggered.


trigger_type

trigger_type: AutoModerationTriggerTypes

Defined in: discord/autoModeration.ts:16

The type of trigger for this rule