Skip to main content

CreateAutoModerationRuleOptions

@discordeno/bot • Docs

Documentation / @discordeno/bot / CreateAutoModerationRuleOptions

Interface: CreateAutoModerationRuleOptions

Properties​

actions​

actions: object[]

The actions that will trigger for this rule

Defined in​

packages/types/dist/types/discordeno.d.ts:942

enabled?​

optional enabled: boolean

Whether the rule should be enabled, true by default.

Defined in​

packages/types/dist/types/discordeno.d.ts:954

eventType​

eventType: AutoModerationEventTypes

The type of event to trigger the rule on.

Defined in​

packages/types/dist/types/discordeno.d.ts:925

exemptChannels?​

optional exemptChannels: BigString[]

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

Defined in​

packages/types/dist/types/discordeno.d.ts:958

exemptRoles?​

optional exemptRoles: BigString[]

The role ids that should not be effected by the rule

Defined in​

packages/types/dist/types/discordeno.d.ts:956

name​

name: string

The name of the rule.

Defined in​

packages/types/dist/types/discordeno.d.ts:923

triggerMetadata​

triggerMetadata: object

The metadata to use for the trigger.

allowList?​

optional allowList: string[]

The substrings which will exempt from triggering the preset trigger type. Only present when TriggerType.KeywordPreset

keywordFilter?​

optional keywordFilter: string[]

The keywords needed to match. Only present when TriggerType.Keyword

mentionTotalLimit?​

optional mentionTotalLimit: number

Total number of mentions (role & user) allowed per message (Maximum of 50). Only present when TriggerType.MentionSpam

presets?​

optional presets: DiscordAutoModerationRuleTriggerMetadataPresets[]

The pre-defined lists of words to match from. Only present when TriggerType.KeywordPreset

regexPatterns?​

optional regexPatterns: string[]

Regular expression patterns which will be matched against content. Only present when TriggerType.Keyword

Defined in​

packages/types/dist/types/discordeno.d.ts:929

triggerType​

triggerType: AutoModerationTriggerTypes

The type of trigger to use for the rule.

Defined in​

packages/types/dist/types/discordeno.d.ts:927