net.dv8tion.jda.api.entities.automod.AutoModRule Maven / Gradle / Ivy
Show all versions of JDA Show documentation
/*
* Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.dv8tion.jda.api.entities.automod;
import net.dv8tion.jda.api.entities.Guild;
import net.dv8tion.jda.api.entities.ISnowflake;
import net.dv8tion.jda.api.entities.Role;
import net.dv8tion.jda.api.entities.automod.build.AutoModRuleData;
import net.dv8tion.jda.api.entities.automod.build.TriggerConfig;
import net.dv8tion.jda.api.entities.channel.middleman.GuildChannel;
import net.dv8tion.jda.api.exceptions.InsufficientPermissionException;
import net.dv8tion.jda.api.managers.AutoModRuleManager;
import net.dv8tion.jda.api.requests.restaction.AuditableRestAction;
import javax.annotation.Nonnull;
import java.util.EnumSet;
import java.util.List;
/**
* Rule used for auto-moderation in a {@link Guild}.
*
* @see Guild#retrieveAutoModRules()
* @see Guild#createAutoModRule(AutoModRuleData)
*/
public interface AutoModRule extends ISnowflake
{
/**
* The maximum length of a rule name. ({@value})
*/
int MAX_RULE_NAME_LENGTH = 100;
/**
* The maximum length of a keyword in {@link TriggerConfig#keywordFilter(String...)}. ({@value})
*/
int MAX_KEYWORD_LENGTH = 60;
/**
* The maximum amount of keywords in {@link TriggerConfig#keywordFilter(String...)}. ({@value})
*/
int MAX_KEYWORD_AMOUNT = 1000;
/**
* The maximum amount of whitelisted keywords in {@link TriggerConfig#keywordFilter(String...)}. ({@value})
*/
int MAX_ALLOWLIST_CUSTOM_AMOUNT = 100;
/**
* The maximum amount of whitelisted keywords in {@link TriggerConfig#presetKeywordFilter(KeywordPreset...)}. ({@value})
*/
int MAX_ALLOWLIST_PRESET_AMOUNT = 1000;
/**
* The maximum length of a regex pattern in {@link TriggerConfig#patternFilter(String...)}. ({@value})
*/
int MAX_PATTERN_LENGTH = 260;
/**
* The maximum amount of regex patterns in {@link TriggerConfig#patternFilter(String...)}. ({@value})
*/
int MAX_PATTERN_AMOUNT = 10;
/**
* The maximum limit of mentions in {@link TriggerConfig#mentionSpam(int)}. ({@value})
*/
int MAX_MENTION_LIMIT = 50;
/**
* The maximum amount of roles that can be added to {@link AutoModRule#getExemptRoles()}. ({@value})
*/
int MAX_EXEMPT_ROLES = 20;
/**
* The maximum amount of channels that can be added to {@link AutoModRule#getExemptChannels()}. ({@value})
*/
int MAX_EXEMPT_CHANNELS = 50;
/**
* The {@link Guild} this rule belongs to.
*
* @return The guild
*/
@Nonnull
Guild getGuild();
/**
* The user id of the creator of this rule.
*
* @return The owner id
*/
long getCreatorIdLong();
/**
* The user id of the creator of this rule.
*
* @return The owner id
*/
@Nonnull
default String getCreatorId()
{
return Long.toUnsignedString(getCreatorIdLong());
}
/**
* The name of this rule.
*
* @return The name
*/
@Nonnull
String getName();
/**
* The type of event that triggers this rule.
*
* @return The event type
*/
@Nonnull
AutoModEventType getEventType();
/**
* The type of trigger that this rule uses.
*
* @return The trigger type
*/
@Nonnull
AutoModTriggerType getTriggerType();
/**
* Whether this rule is enabled.
*
* @return True, if enabled
*/
boolean isEnabled();
/**
* The roles which are exempt from the rule.
* All members of the exempt roles will bypass the rule.
*
* @return The exempt roles
*/
@Nonnull
List getExemptRoles();
/**
* The channels which are exempt from the rule.
* All messages in the listed channels will bypass the rule.
*
* @return The exempt channels
*/
@Nonnull
List getExemptChannels();
/**
* The automated {@link AutoModResponse AutoModResponses} that will be activated when the rule is triggered.
*
* @return The {@link AutoModResponse AutoModResponses}
*/
@Nonnull
List getActions();
/**
* The keywords that are blocked by this rule.
* Only applies to {@link AutoModTriggerType#KEYWORD}.
*
* @return The blocked keywords
*/
@Nonnull
List getFilteredKeywords();
/**
* The regex patterns that are blocked by this rule.
* Only applies to {@link AutoModTriggerType#KEYWORD}.
*
* @return The blocked regex patterns
*/
@Nonnull
List getFilteredRegex();
/**
* The keyword presets that are blocked by this rule.
* Only applies to {@link AutoModTriggerType#KEYWORD_PRESET}.
*
* @return The blocked keyword presets
*/
@Nonnull
EnumSet getFilteredPresets();
/**
* The whitelisted keywords that are allowed by this rule.
* Only applies to {@link AutoModTriggerType#KEYWORD} and {@link AutoModTriggerType#KEYWORD_PRESET}.
*
* @return The whitelisted keywords
*/
@Nonnull
List getAllowlist();
/**
* The maximum amount of mentions that are allowed in a message.
* Only applies to {@link AutoModTriggerType#MENTION_SPAM}.
*
* @return The mention limit, or 0 if this is not using {@link AutoModTriggerType#MENTION_SPAM}
*/
int getMentionLimit();
/**
* Whether this rule is using the raid protection feature.
*
Only applies to {@link AutoModTriggerType#MENTION_SPAM}.
*
* @return True, if mention raid protection is enabled
*/
boolean isMentionRaidProtectionEnabled();
/**
* Returns an {@link 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 {@link net.dv8tion.jda.api.requests.RestAction#queue() RestAction.queue()}.
*
* @throws InsufficientPermissionException
* If the currently logged in account does not have the {@link net.dv8tion.jda.api.Permission#MANAGE_SERVER MANAGE_SERVER} permission.
*
* @return The manager instance
*/
@Nonnull
default AutoModRuleManager getManager()
{
return getGuild().modifyAutoModRuleById(getId());
}
/**
* Deletes this rule.
*
* @throws InsufficientPermissionException
* If the currently logged in account does not have the {@link net.dv8tion.jda.api.Permission#MANAGE_SERVER MANAGE_SERVER} permission.
*
* @return {@link net.dv8tion.jda.api.requests.RestAction RestAction} - Type: {@link Void}
*/
@Nonnull
default AuditableRestAction delete()
{
return getGuild().deleteAutoModRuleById(getId());
}
/**
* Keyword presets that can be used in {@link AutoModRule#getFilteredPresets()}.
*/
enum KeywordPreset
{
/**
* Words that can be considered as swearing or cursing.
*/
PROFANITY(1),
/**
* Words that can be considered as sexual in nature.
*/
SEXUAL_CONTENT(2),
/**
* Words that can be considered as slurs or insults.
*/
SLURS(3),
/**
* Placeholder for unknown values.
*/
UNKNOWN(-1);
private final int key;
KeywordPreset(int key)
{
this.key = key;
}
/**
* The raw value used by Discord to represent this preset.
*
* @return The raw value
*/
public int getKey()
{
return key;
}
/**
* The {@link KeywordPreset} represented by the provided key.
*
* @param key
* The raw key
*
* @return The {@link KeywordPreset} or {@link #UNKNOWN}
*/
@Nonnull
public static KeywordPreset fromKey(int key)
{
for (KeywordPreset preset : values())
{
if (preset.key == key)
return preset;
}
return UNKNOWN;
}
}
}