Skip to main content

CreateAutoModerationRuleOptions

Documentation

Documentation / @discordeno/types / CreateAutoModerationRuleOptions

Interface: CreateAutoModerationRuleOptions

Defined in: discordeno/autoModeration.ts:58

https://docs.discord.com/developers/resources/auto-moderation#create-auto-moderation-rule-json-params

Properties​

actions​

actions: DiscordenoAutoModerationAction[]

Defined in: discordeno/autoModeration.ts:68

The actions that will trigger for this rule

enabled?​

optional enabled?: boolean

Defined in: discordeno/autoModeration.ts:70

Whether the rule should be enabled, true by default.

eventType​

eventType: AutoModerationEventTypes

Defined in: discordeno/autoModeration.ts:62

The type of event to trigger the rule on.

exemptChannels?​

optional exemptChannels?: BigString[]

Defined in: discordeno/autoModeration.ts:74

The channel ids that should not be effected by the rule.

exemptRoles?​

optional exemptRoles?: BigString[]

Defined in: discordeno/autoModeration.ts:72

The role ids that should not be effected by the rule

name​

name: string

Defined in: discordeno/autoModeration.ts:60

The name of the rule.

triggerMetadata​

triggerMetadata: object

Defined in: discordeno/autoModeration.ts:66

The metadata to use for the trigger.

allowList?​

optional allowList?: string[]

keywordFilter?​

optional keywordFilter?: string[]

mentionRaidProtectionEnabled?​

optional mentionRaidProtectionEnabled?: boolean

mentionTotalLimit?​

optional mentionTotalLimit?: number

presets?​

optional presets?: DiscordAutoModerationRuleTriggerMetadataPresets[]

regexPatterns?​

optional regexPatterns?: string[]

triggerType​

triggerType: AutoModerationTriggerTypes

Defined in: discordeno/autoModeration.ts:64

The type of trigger to use for the rule.