Package net.dv8tion.jda.api.entities.automod.build

Interface TriggerConfig

All Superinterfaces:

SerializableData

All Known Implementing Classes:

AbstractKeywordTriggerConfig, AbstractTriggerConfig, AntiSpamTriggerConfig, CustomKeywordTriggerConfig, MentionSpamTriggerConfig, PresetKeywordTriggerConfig

public interface TriggerConfig
extends SerializableData

Configuration for AutoModRule, which defines under what conditions the rule should be triggered.

Each rule is limited to a single trigger type. You can use the various factory methods on this interface to create a config.

Supported factories:

• mentionSpam(int) - Trigger on mention thresholds in messages
• antiSpam() - Trigger on spam content in messages (classified by Discord magic)
• keywordFilter(Collection)/patternFilter(Collection) - Trigger on messages containing certain keywords or regex patterns
• presetKeywordFilter(AutoModRule.KeywordPreset...) - Trigger on messages containing words from predefined lists

Example

 AutoModRuleData rule = AutoModRule.onMessage("Invite Links",
   TriggerConfig.keywordFilter("discord.gg/*") // trigger on all invite links
     .setAllowList("discord.gg/discord-api")   // except certain whitelisted ones
 );
 

See Also:

• AutoModRule

Method Summary

Modifier and Type	Method	Description
static AntiSpamTriggerConfig	antiSpam()	Trigger on spam content in messages (classified by Discord magic).
AutoModTriggerType	getType()	The type of trigger for this config.
static CustomKeywordTriggerConfig	keywordFilter(String... keywords)	Trigger on messages containing certain keywords or regex patterns.
static CustomKeywordTriggerConfig	keywordFilter(Collection<String> keywords)	Trigger on messages containing certain keywords or regex patterns.
static MentionSpamTriggerConfig	mentionSpam(int mentionLimit)	Trigger on mention thresholds in messages.
static CustomKeywordTriggerConfig	patternFilter(String... patterns)	Trigger on messages containing certain keywords regex patterns.
static CustomKeywordTriggerConfig	patternFilter(Collection<String> patterns)	Trigger on messages containing certain keywords regex patterns.
static PresetKeywordTriggerConfig	presetKeywordFilter(Collection<AutoModRule.KeywordPreset> presets)	Trigger on keywords from predefined lists.
static PresetKeywordTriggerConfig	presetKeywordFilter(AutoModRule.KeywordPreset... presets)	Trigger on keywords from predefined lists.

Methods inherited from interface net.dv8tion.jda.api.utils.data.SerializableData

toData

Method Details

getType

@Nonnull
AutoModTriggerType getType()

The type of trigger for this config.

Returns:

AutoModTriggerType

mentionSpam

@Nonnull
static MentionSpamTriggerConfig mentionSpam(int mentionLimit)

Trigger on mention thresholds in messages.

Parameters:

mentionLimit - The maximum number of unique mentions allowed in a message (1-50)

Returns:

MentionSpamTriggerConfig

Throws:

IllegalArgumentException - If the provided mention limit is not between 1 and 50

antiSpam

@Nonnull
static AntiSpamTriggerConfig antiSpam()

Trigger on spam content in messages (classified by Discord magic).

Returns:

AntiSpamTriggerConfig

keywordFilter

@Nonnull
static CustomKeywordTriggerConfig keywordFilter(@Nonnull
 Collection<String> keywords)

Trigger on messages containing certain keywords or regex patterns.
Keywords are matched case-insensitively, and may also contain whitespace.

You can use wildcards at the keyword boundaries to extend the matches:
"foo*" can match "foo", "foobar", "foo-bar", etc.
"*foo*" can match "foo", "foobar", "barfoo", etc.
"*foo" can match "foo", "barfoo", "bar-foo", etc.

You can also use regex patterns using patternFilter(Collection) or CustomKeywordTriggerConfig.addPatterns(Collection).

Parameters:

keywords - The keywords to match (case-insensitive)

Returns:

CustomKeywordTriggerConfig

Throws:

IllegalArgumentException -

• If any of the keywords are empty, blank, or null
• If more than 1000 keywords are added
• If any of the keywords is longer than 60 characters

keywordFilter

@Nonnull
static CustomKeywordTriggerConfig keywordFilter(@Nonnull
 String... keywords)

Trigger on messages containing certain keywords or regex patterns.
Keywords are matched case-insensitively, and may also contain whitespace.

You can use wildcards at the keyword boundaries to extend the matches:
"foo*" can match "foo", "foobar", "foo-bar", etc.
"*foo*" can match "foo", "foobar", "barfoo", etc.
"*foo" can match "foo", "barfoo", "bar-foo", etc.

You can also use regex patterns using patternFilter(String...) or CustomKeywordTriggerConfig.addPatterns(String...).

Parameters:

keywords - The keywords to match (case-insensitive)

Returns:

CustomKeywordTriggerConfig

Throws:

IllegalArgumentException -

• If any of the keywords are empty, blank, or null
• If more than 1000 keywords are added
• If any of the keywords is longer than 60 characters

patternFilter

@Nonnull
static CustomKeywordTriggerConfig patternFilter(@Nonnull
 Collection<String> patterns)

Trigger on messages containing certain keywords regex patterns.
Keyword patterns are matched case-insensitively, and may also contain whitespace.

Patterns may use anything supported by the rust regex crate. You can use a validator such as Rustexp to validate your pattern.

You can also use simple substring keywords using keywordFilter(String...) or CustomKeywordTriggerConfig.addKeywords(String...).

Parameters:

patterns - The keyword patterns to match

Returns:

CustomKeywordTriggerConfig

Throws:

IllegalArgumentException -

• If any of the patterns are empty, blank, or null
• If more than 10 patterns are added
• If any of the patterns is longer than 260 characters

patternFilter

@Nonnull
static CustomKeywordTriggerConfig patternFilter(@Nonnull
 String... patterns)

Trigger on messages containing certain keywords regex patterns.
Keyword patterns are matched case-insensitively, and may also contain whitespace.

Patterns may use anything supported by the rust regex crate. You can use a validator such as Rustexp to validate your pattern.

You can also use simple substring keywords using keywordFilter(String...) or CustomKeywordTriggerConfig.addKeywords(String...).

Parameters:

patterns - The keyword patterns to match

Returns:

CustomKeywordTriggerConfig

Throws:

IllegalArgumentException -

• If any of the patterns are empty, blank, or null
• If more than 10 patterns are added
• If any of the patterns is longer than 260 characters

presetKeywordFilter

@Nonnull
static PresetKeywordTriggerConfig presetKeywordFilter(@Nonnull
 Collection<AutoModRule.KeywordPreset> presets)

Trigger on keywords from predefined lists.

Parameters:

presets - The presets to enable

Returns:

PresetKeywordTriggerConfig

Throws:

IllegalArgumentException - If null or AutoModRule.KeywordPreset.UNKNOWN is provided

presetKeywordFilter

@Nonnull
static PresetKeywordTriggerConfig presetKeywordFilter(@Nonnull
 AutoModRule.KeywordPreset... presets)

Trigger on keywords from predefined lists.

Parameters:

presets - The presets to enable

Returns:

PresetKeywordTriggerConfig

Throws:

IllegalArgumentException - If null or AutoModRule.KeywordPreset.UNKNOWN is provided