discord.js | AutoModerationRule

Search...

AutoModerationRule

export class AutoModerationRule extends Base

export class AutoModerationRule extends Base

Represents an auto moderation rule.

Extends

Base

actions:AutoModerationAction[]

The actions of this auto moderation rule.

Readonly

client:Client<true>

The client that instantiated this

Inherited from Base

creatorId:Snowflake

The user that created this auto moderation rule.

enabled:boolean

Whether this auto moderation rule is enabled.

eventType:AutoModerationRuleEventType

The event type of this auto moderation rule.

exemptChannels:Collection<Snowflake, GuildBasedChannel>

The channels exempt by this auto moderation rule.

exemptRoles:Collection<Snowflake, Role>

The roles exempt by this auto moderation rule.

guild:Guild

The guild this auto moderation rule is for.

id:Snowflake

The id of this auto moderation rule.

name:string

The name of this auto moderation rule.

triggerMetadata:AutoModerationTriggerMetadata

The trigger metadata of the rule.

triggerType:AutoModerationRuleTriggerType

The trigger type of this auto moderation rule.

delete(reason?):Promise<void>

Deletes this auto moderation rule.

Name	Type	Optional	Description
reason	string	Yes	The reason for deleting this auto moderation rule

edit(options):Promise<AutoModerationRule>

Edits this auto moderation rule.

Name	Type	Optional	Description
options	AutoModerationRuleEditOptions	No	Options for editing this auto moderation rule

setActions(actions, reason?):Promise<AutoModerationRule>

Sets the actions for this auto moderation rule.

Name	Type	Optional	Description
actions	readonly AutoModerationActionOptions[]	No	The actions of this auto moderation rule
reason	string	Yes	The reason for changing the actions of this auto moderation rule

setAllowList(allowList, reason?):Promise<AutoModerationRule>

Sets the allow list for this auto moderation rule.

Name	Type	Optional	Description
allowList	readonly string[]	No	The substrings that will be exempt from triggering AutoModerationRuleTriggerType.Keyword, AutoModerationRuleTriggerType.KeywordPreset, and AutoModerationRuleTriggerType.MemberProfile
reason	string	Yes	The reason for changing the allow list of this auto moderation rule

setEnabled(enabled?, reason?):Promise<AutoModerationRule>

Sets whether this auto moderation rule should be enabled.

Name	Type	Optional	Description
enabled	boolean	Yes	Whether to enable this auto moderation rule
reason	string	Yes	The reason for enabling or disabling this auto moderation rule

setEventType(eventType, reason?):Promise<AutoModerationRule>

Sets the event type for this auto moderation rule.

Name	Type	Optional	Description
eventType	AutoModerationRuleEventType	No	The event type of this auto moderation rule
reason	string	Yes	The reason for changing the event type of this auto moderation rule

setExemptChannels(exemptChannels, reason?):Promise<AutoModerationRule>

Sets the exempt channels for this auto moderation rule.

Name	Type	Optional	Description
exemptChannels	ReadonlyCollection<Snowflake, GuildBasedChannel> \| readonly GuildChannelResolvable[]	No	The channels that should not be affected by the auto moderation rule
reason	string	Yes	The reason for changing the exempt channels of this auto moderation rule

setExemptRoles(exemptRoles, reason?):Promise<AutoModerationRule>

Sets the exempt roles for this auto moderation rule.

Name	Type	Optional	Description
exemptRoles	ReadonlyCollection<Snowflake, Role> \| readonly RoleResolvable[]	No	The roles that should not be affected by the auto moderation rule
reason	string	Yes	The reason for changing the exempt roles of this auto moderation rule

setKeywordFilter(keywordFilter, reason?):Promise<AutoModerationRule>

Sets the keyword filter for this auto moderation rule.

Name	Type	Optional	Description
keywordFilter	readonly string[]	No	The keyword filter of this auto moderation rule
reason	string	Yes	The reason for changing the keyword filter of this auto moderation rule

setMentionRaidProtectionEnabled(mentionRaidProtectionEnabled, reason?):Promise<AutoModerationRule>

Sets whether to enable mention raid protection for this auto moderation rule.

Name	Type	Optional	Description
mentionRaidProtectionEnabled	boolean	No	Whether to enable mention raid protection for this auto moderation rule
reason	string	Yes	The reason for changing the mention raid protection of this auto moderation rule

setMentionTotalLimit(mentionTotalLimit, reason?):Promise<AutoModerationRule>

Sets the mention total limit for this auto moderation rule.

Name	Type	Optional	Description
mentionTotalLimit	number	No	The total number of unique role and user mentions allowed per message
reason	string	Yes	The reason for changing the mention total limit of this auto moderation rule

setName(name, reason?):Promise<AutoModerationRule>

Sets the name for this auto moderation rule.

Name	Type	Optional	Description
name	string	No	The name of this auto moderation rule
reason	string	Yes	The reason for changing the name of this auto moderation rule

setPresets(presets, reason?):Promise<AutoModerationRule>

Sets the presets for this auto moderation rule.

Name	Type	Optional	Description
presets	readonly AutoModerationRuleKeywordPresetType[]	No	The presets of this auto moderation rule
reason	string	Yes	The reason for changing the presets of this auto moderation rule

setRegexPatterns(regexPatterns, reason?):Promise<AutoModerationRule>

Sets the regular expression patterns for this auto moderation rule.

Name	Type	Optional	Description
regexPatterns	readonly string[]	No	The regular expression patterns of this auto moderation rule Only Rust-flavored regular expressions are supported.
reason	string	Yes	The reason for changing the regular expression patterns of this auto moderation rule

toJSON(...props):unknown

Name	Type	Optional	Description
...props	Record<string, boolean \| string>[]	No	None

Inherited from Base

valueOf():string