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

Interface AutoModRule

All Superinterfaces:

ISnowflake

public interface AutoModRule
extends ISnowflake

Rule used for auto-moderation in a Guild.

See Also:

• Guild.retrieveAutoModRules()
• Guild.createAutoModRule(AutoModRuleData)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	AutoModRule.KeywordPreset	Keyword presets that can be used in getFilteredPresets().

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_ALLOWLIST_CUSTOM_AMOUNT	The maximum amount of whitelisted keywords in TriggerConfig.keywordFilter(String...).
static final int	MAX_ALLOWLIST_PRESET_AMOUNT	The maximum amount of whitelisted keywords in TriggerConfig.presetKeywordFilter(KeywordPreset...).
static final int	MAX_EXEMPT_CHANNELS	The maximum amount of channels that can be added to getExemptChannels().
static final int	MAX_EXEMPT_ROLES	The maximum amount of roles that can be added to getExemptRoles().
static final int	MAX_KEYWORD_AMOUNT	The maximum amount of keywords in TriggerConfig.keywordFilter(String...).
static final int	MAX_KEYWORD_LENGTH	The maximum length of a keyword in TriggerConfig.keywordFilter(String...).
static final int	MAX_MENTION_LIMIT	The maximum limit of mentions in TriggerConfig.mentionSpam(int).
static final int	MAX_PATTERN_AMOUNT	The maximum amount of regex patterns in TriggerConfig.patternFilter(String...).
static final int	MAX_PATTERN_LENGTH	The maximum length of a regex pattern in TriggerConfig.patternFilter(String...).
static final int	MAX_RULE_NAME_LENGTH	The maximum length of a rule name.

Method Summary

Modifier and Type	Method	Description
default AuditableRestAction<Void>	delete()	Deletes this rule.
List<AutoModResponse>	getActions()	The automated AutoModResponses that will be activated when the rule is triggered.
List<String>	getAllowlist()	The whitelisted keywords that are allowed by this rule.
default String	getCreatorId()	The user id of the creator of this rule.
long	getCreatorIdLong()	The user id of the creator of this rule.
AutoModEventType	getEventType()	The type of event that triggers this rule.
List<GuildChannel>	getExemptChannels()	The channels which are exempt from the rule.
List<Role>	getExemptRoles()	The roles which are exempt from the rule.
List<String>	getFilteredKeywords()	The keywords that are blocked by this rule.
EnumSet<AutoModRule.KeywordPreset>	getFilteredPresets()	The keyword presets that are blocked by this rule.
List<String>	getFilteredRegex()	The regex patterns that are blocked by this rule.
Guild	getGuild()	The Guild this rule belongs to.
default AutoModRuleManager	getManager()	Returns an AutoModRuleManager, which can be used to modify this rule.
int	getMentionLimit()	The maximum amount of mentions that are allowed in a message.
String	getName()	The name of this rule.
AutoModTriggerType	getTriggerType()	The type of trigger that this rule uses.
boolean	isEnabled()	Whether this rule is enabled.
boolean	isMentionRaidProtectionEnabled()	Whether this rule is using the raid protection feature.

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getIdLong, getTimeCreated

Field Details

MAX_RULE_NAME_LENGTH

static final int MAX_RULE_NAME_LENGTH

The maximum length of a rule name. (100)

See Also:

• Constant Field Values

MAX_KEYWORD_LENGTH

static final int MAX_KEYWORD_LENGTH

The maximum length of a keyword in TriggerConfig.keywordFilter(String...). (60)

See Also:

• Constant Field Values

MAX_KEYWORD_AMOUNT

static final int MAX_KEYWORD_AMOUNT

The maximum amount of keywords in TriggerConfig.keywordFilter(String...). (1000)

See Also:

• Constant Field Values

MAX_ALLOWLIST_CUSTOM_AMOUNT

static final int MAX_ALLOWLIST_CUSTOM_AMOUNT

The maximum amount of whitelisted keywords in TriggerConfig.keywordFilter(String...). (100)

See Also:

• Constant Field Values

MAX_ALLOWLIST_PRESET_AMOUNT

static final int MAX_ALLOWLIST_PRESET_AMOUNT

The maximum amount of whitelisted keywords in TriggerConfig.presetKeywordFilter(KeywordPreset...). (1000)

See Also:

• Constant Field Values

MAX_PATTERN_LENGTH

static final int MAX_PATTERN_LENGTH

The maximum length of a regex pattern in TriggerConfig.patternFilter(String...). (260)

See Also:

• Constant Field Values

MAX_PATTERN_AMOUNT

static final int MAX_PATTERN_AMOUNT

The maximum amount of regex patterns in TriggerConfig.patternFilter(String...). (10)

See Also:

• Constant Field Values

MAX_MENTION_LIMIT

static final int MAX_MENTION_LIMIT

The maximum limit of mentions in TriggerConfig.mentionSpam(int). (50)

See Also:

• Constant Field Values

MAX_EXEMPT_ROLES

static final int MAX_EXEMPT_ROLES

The maximum amount of roles that can be added to getExemptRoles(). (20)

See Also:

• Constant Field Values

MAX_EXEMPT_CHANNELS

static final int MAX_EXEMPT_CHANNELS

The maximum amount of channels that can be added to getExemptChannels(). (50)

See Also:

• Constant Field Values

Method Details

getGuild

@Nonnull
Guild getGuild()

The Guild this rule belongs to.

Returns:

The guild

getCreatorIdLong

long getCreatorIdLong()

The user id of the creator of this rule.

Returns:

The owner id

getCreatorId

@Nonnull
default String getCreatorId()

The user id of the creator of this rule.

Returns:

The owner id

getName

@Nonnull
String getName()

The name of this rule.

Returns:

The name

getEventType

@Nonnull
AutoModEventType getEventType()

The type of event that triggers this rule.

Returns:

The event type

getTriggerType

@Nonnull
AutoModTriggerType getTriggerType()

The type of trigger that this rule uses.

Returns:

The trigger type

isEnabled

boolean isEnabled()

Whether this rule is enabled.

Returns:

True, if enabled

getExemptRoles

@Nonnull
List<Role> getExemptRoles()

The roles which are exempt from the rule.

All members of the exempt roles will bypass the rule.

Returns:

The exempt roles

getExemptChannels

@Nonnull
List<GuildChannel> getExemptChannels()

The channels which are exempt from the rule.

All messages in the listed channels will bypass the rule.

Returns:

The exempt channels

getActions

@Nonnull
List<AutoModResponse> getActions()

The automated AutoModResponses that will be activated when the rule is triggered.

Returns:

The AutoModResponses

getFilteredKeywords

@Nonnull
List<String> getFilteredKeywords()

The keywords that are blocked by this rule.

Only applies to AutoModTriggerType.KEYWORD.

Returns:

The blocked keywords

getFilteredRegex

@Nonnull
List<String> getFilteredRegex()

The regex patterns that are blocked by this rule.

Only applies to AutoModTriggerType.KEYWORD.

Returns:

The blocked regex patterns

getFilteredPresets

@Nonnull
EnumSet<AutoModRule.KeywordPreset> getFilteredPresets()

The keyword presets that are blocked by this rule.

Only applies to AutoModTriggerType.KEYWORD_PRESET.

Returns:

The blocked keyword presets

getAllowlist

@Nonnull
List<String> getAllowlist()

The whitelisted keywords that are allowed by this rule.

Only applies to AutoModTriggerType.KEYWORD and AutoModTriggerType.KEYWORD_PRESET.

Returns:

The whitelisted keywords

getMentionLimit

int getMentionLimit()

The maximum amount of mentions that are allowed in a message.

Only applies to AutoModTriggerType.MENTION_SPAM.

Returns:

The mention limit, or 0 if this is not using AutoModTriggerType.MENTION_SPAM

isMentionRaidProtectionEnabled

boolean isMentionRaidProtectionEnabled()

Whether this rule is using the raid protection feature.

Only applies to AutoModTriggerType.MENTION_SPAM.

Returns:

True, if mention raid protection is enabled

getManager

@Nonnull
@CheckReturnValue
default AutoModRuleManager getManager()

Returns an AutoModRuleManager, which can be used to modify this rule.

The manager allows modifying multiple fields in a single request.
You modify multiple fields in one request by chaining setters before calling RestAction.queue().

Returns:

The manager instance

Throws:

InsufficientPermissionException - If the currently logged in account does not have the MANAGE_SERVER permission.

delete

@Nonnull
@CheckReturnValue
default AuditableRestAction<Void> delete()

Deletes this rule.

Returns:

RestAction - Type: Void

Throws:

InsufficientPermissionException - If the currently logged in account does not have the MANAGE_SERVER permission.