Preview environment

interface AutoModerationRuleCreateOptions

export interface AutoModerationRuleCreateOptions

Options used to create an auto moderation rule.

actions : readonly AutoModerationActionOptions[]

The actions that will execute when the auto moderation rule is triggered

optional
enabled? : boolean

Whether the auto moderation rule should be enabled

The event type of the auto moderation rule

optional
exemptChannels? : ReadonlyCollection<Snowflake, GuildBasedChannel> | readonly GuildChannelResolvable[]

The channels that should not be affected by the auto moderation rule

optional
exemptRoles? : ReadonlyCollection<Snowflake, Role> | readonly RoleResolvable[]

The roles that should not be affected by the auto moderation rule

name : string

The name of the auto moderation rule

optional
reason? : string

The reason for creating the auto moderation rule

optional
triggerMetadata? : AutoModerationTriggerMetadataOptions

The trigger metadata of the auto moderation rule This property is required if using a triggerType of AutoModerationRuleTriggerType.Keyword, AutoModerationRuleTriggerType.KeywordPreset, AutoModerationRuleTriggerType.MentionSpam, or AutoModerationRuleTriggerType.MemberProfile.

The trigger type of the auto moderation rule