Package net.dv8tion.jda.internal.entities.automod

Class AutoModRuleImpl

java.lang.Object

net.dv8tion.jda.internal.entities.automod.AutoModRuleImpl

All Implemented Interfaces:

AutoModRule, ISnowflake

public class AutoModRuleImpl
extends Object
implements AutoModRule

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.entities.automod.AutoModRule

AutoModRule.KeywordPreset

Field Summary

Fields inherited from interface net.dv8tion.jda.api.entities.automod.AutoModRule

MAX_ALLOWLIST_CUSTOM_AMOUNT, MAX_ALLOWLIST_PRESET_AMOUNT, MAX_EXEMPT_CHANNELS, MAX_EXEMPT_ROLES, MAX_KEYWORD_AMOUNT, MAX_KEYWORD_LENGTH, MAX_MENTION_LIMIT, MAX_PATTERN_AMOUNT, MAX_PATTERN_LENGTH, MAX_RULE_NAME_LENGTH

Constructor Summary

Constructors

Constructor	Description
AutoModRuleImpl(Guild guild, long id)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static AutoModRuleImpl	fromData(Guild guild, DataObject data)
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.
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.
long	getIdLong()	The Snowflake id of this entity.
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.
int	hashCode()
boolean	isEnabled()	Whether this rule is enabled.
boolean	isMentionRaidProtectionEnabled()	Whether this rule is using the raid protection feature.
AutoModRuleImpl	setActions(List<AutoModResponse> actions)
AutoModRuleImpl	setAllowlist(List<String> allowlist)
AutoModRuleImpl	setEnabled(boolean enabled)
AutoModRuleImpl	setEventType(AutoModEventType eventType)
AutoModRuleImpl	setExemptChannels(gnu.trove.list.TLongList exemptChannels)
AutoModRuleImpl	setExemptRoles(gnu.trove.list.TLongList exemptRoles)
AutoModRuleImpl	setFilteredKeywords(List<String> filteredKeywords)
AutoModRuleImpl	setFilteredPresets(EnumSet<AutoModRule.KeywordPreset> filteredPresets)
AutoModRuleImpl	setFilteredRegex(List<String> filteredRegex)
AutoModRuleImpl	setMentionLimit(int mentionLimit)
AutoModRuleImpl	setMentionRaidProtectionEnabled(boolean mentionRaidProtectionEnabled)
AutoModRuleImpl	setName(String name)
AutoModRuleImpl	setOwnerId(long ownerId)
AutoModRuleImpl	setTriggerType(AutoModTriggerType triggerType)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.entities.automod.AutoModRule

delete, getCreatorId, getManager

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

getId, getTimeCreated

Constructor Details

AutoModRuleImpl

public AutoModRuleImpl(Guild guild,
 long id)

Method Details

getIdLong

public long getIdLong()

Description copied from interface: ISnowflake

The Snowflake id of this entity. This is unique to every entity and will never change.

Specified by:

getIdLong in interface ISnowflake

Returns:

Long containing the Id.

getGuild

@Nonnull
public Guild getGuild()

Description copied from interface: AutoModRule

The Guild this rule belongs to.

Specified by:

getGuild in interface AutoModRule

Returns:

The guild

getCreatorIdLong

public long getCreatorIdLong()

Description copied from interface: AutoModRule

The user id of the creator of this rule.

Specified by:

getCreatorIdLong in interface AutoModRule

Returns:

The owner id

getName

@Nonnull
public String getName()

Description copied from interface: AutoModRule

The name of this rule.

Specified by:

getName in interface AutoModRule

Returns:

The name

getEventType

@Nonnull
public AutoModEventType getEventType()

Description copied from interface: AutoModRule

The type of event that triggers this rule.

Specified by:

getEventType in interface AutoModRule

Returns:

The event type

getTriggerType

@Nonnull
public AutoModTriggerType getTriggerType()

Description copied from interface: AutoModRule

The type of trigger that this rule uses.

Specified by:

getTriggerType in interface AutoModRule

Returns:

The trigger type

isEnabled

public boolean isEnabled()

Description copied from interface: AutoModRule

Whether this rule is enabled.

Specified by:

isEnabled in interface AutoModRule

Returns:

True, if enabled

getExemptRoles

@Nonnull
public List<Role> getExemptRoles()

Description copied from interface: AutoModRule

The roles which are exempt from the rule.

All members of the exempt roles will bypass the rule.

Specified by:

getExemptRoles in interface AutoModRule

Returns:

The exempt roles

getExemptChannels

@Nonnull
public List<GuildChannel> getExemptChannels()

Description copied from interface: AutoModRule

The channels which are exempt from the rule.

All messages in the listed channels will bypass the rule.

Specified by:

getExemptChannels in interface AutoModRule

Returns:

The exempt channels

getActions

@Nonnull
public List<AutoModResponse> getActions()

Description copied from interface: AutoModRule

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

Specified by:

getActions in interface AutoModRule

Returns:

The AutoModResponses

getFilteredKeywords

@Nonnull
public List<String> getFilteredKeywords()

Description copied from interface: AutoModRule

The keywords that are blocked by this rule.

Only applies to AutoModTriggerType.KEYWORD.

Specified by:

getFilteredKeywords in interface AutoModRule

Returns:

The blocked keywords

getFilteredRegex

@Nonnull
public List<String> getFilteredRegex()

Description copied from interface: AutoModRule

The regex patterns that are blocked by this rule.

Only applies to AutoModTriggerType.KEYWORD.

Specified by:

getFilteredRegex in interface AutoModRule

Returns:

The blocked regex patterns

getFilteredPresets

@Nonnull
public EnumSet<AutoModRule.KeywordPreset> getFilteredPresets()

Description copied from interface: AutoModRule

The keyword presets that are blocked by this rule.

Only applies to AutoModTriggerType.KEYWORD_PRESET.

Specified by:

getFilteredPresets in interface AutoModRule

Returns:

The blocked keyword presets

getAllowlist

@Nonnull
public List<String> getAllowlist()

Description copied from interface: AutoModRule

The whitelisted keywords that are allowed by this rule.

Only applies to AutoModTriggerType.KEYWORD and AutoModTriggerType.KEYWORD_PRESET.

Specified by:

getAllowlist in interface AutoModRule

Returns:

The whitelisted keywords

getMentionLimit

public int getMentionLimit()

Description copied from interface: AutoModRule

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

Only applies to AutoModTriggerType.MENTION_SPAM.

Specified by:

getMentionLimit in interface AutoModRule

Returns:

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

isMentionRaidProtectionEnabled

public boolean isMentionRaidProtectionEnabled()

Description copied from interface: AutoModRule

Whether this rule is using the raid protection feature.

Only applies to AutoModTriggerType.MENTION_SPAM.

Specified by:

isMentionRaidProtectionEnabled in interface AutoModRule

Returns:

True, if mention raid protection is enabled

setName

public AutoModRuleImpl setName(String name)

setEnabled

public AutoModRuleImpl setEnabled(boolean enabled)

setOwnerId

public AutoModRuleImpl setOwnerId(long ownerId)

setEventType

public AutoModRuleImpl setEventType(AutoModEventType eventType)

setTriggerType

public AutoModRuleImpl setTriggerType(AutoModTriggerType triggerType)

setExemptRoles

public AutoModRuleImpl setExemptRoles(gnu.trove.list.TLongList exemptRoles)

setExemptChannels

public AutoModRuleImpl setExemptChannels(gnu.trove.list.TLongList exemptChannels)

setActions

public AutoModRuleImpl setActions(List<AutoModResponse> actions)

setFilteredKeywords

public AutoModRuleImpl setFilteredKeywords(List<String> filteredKeywords)

setFilteredRegex

public AutoModRuleImpl setFilteredRegex(List<String> filteredRegex)

setFilteredPresets

public AutoModRuleImpl setFilteredPresets(EnumSet<AutoModRule.KeywordPreset> filteredPresets)

setAllowlist

public AutoModRuleImpl setAllowlist(List<String> allowlist)

setMentionLimit

public AutoModRuleImpl setMentionLimit(int mentionLimit)

setMentionRaidProtectionEnabled

public AutoModRuleImpl setMentionRaidProtectionEnabled(boolean mentionRaidProtectionEnabled)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

fromData

public static AutoModRuleImpl fromData(Guild guild,
 DataObject data)