/
AutoModTriggerType.java
135 lines (124 loc) · 4 KB
/
AutoModTriggerType.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/*
* 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.annotations.Incubating;
import net.dv8tion.jda.internal.utils.Helpers;
import javax.annotation.Nonnull;
import java.util.EnumSet;
/**
* The type which defines what triggers an {@link AutoModRule}.
*/
public enum AutoModTriggerType
{
/**
* The rule is triggered by user message content containing specific keywords or phrases.
*/
KEYWORD(1, 6, AutoModEventType.MESSAGE_SEND, AutoModEventType.MEMBER_UPDATE),
/**
* The rule is triggered by user message content containing classified spam content.
*/
SPAM(3, 1, AutoModEventType.MESSAGE_SEND),
/**
* The rule is triggered by user message content containing keywords from a predefined list (such as {@link AutoModRule.KeywordPreset#SLURS slurs}).
*/
KEYWORD_PRESET(4, 1, AutoModEventType.MESSAGE_SEND),
/**
* The rule is triggered by user message content containing more than the allowed number of mentions.
*/
MENTION_SPAM(5, 1, AutoModEventType.MESSAGE_SEND),
/**
* The rule is triggered by a member profile containing specific keywords or phrases.
*
* @incubating This has not been officially released yet
*/
@Incubating
MEMBER_PROFILE_KEYWORD(6, 1, AutoModEventType.MEMBER_UPDATE),
/**
* Placeholder for unknown trigger types that haven't been added yet.
*/
UNKNOWN(-1, 0),
;
private final int key;
private final int maxPerGuild;
private final EnumSet<AutoModEventType> eventTypes;
AutoModTriggerType(int key, int maxPerGuild, AutoModEventType... supportedEvents)
{
this.key = key;
this.maxPerGuild = maxPerGuild;
if (supportedEvents.length > 0)
this.eventTypes = EnumSet.of(supportedEvents[0], supportedEvents);
else
this.eventTypes = EnumSet.noneOf(AutoModEventType.class);
}
/**
* The raw API key used to indicate this type.
*
* @return The int key
*/
public int getKey()
{
return key;
}
/**
* The maximum number of rules that can use this trigger type in a guild.
*
* @return The maximum number of rules
*/
public int getMaxPerGuild()
{
return maxPerGuild;
}
/**
* The {@link AutoModEventType AutoModEventTypes} that support this trigger type.
*
* @return The supported event types
*/
@Nonnull
public EnumSet<AutoModEventType> getSupportedEventTypes()
{
return Helpers.copyEnumSet(AutoModEventType.class, eventTypes);
}
/**
* Whether the provided {@link AutoModEventType} is supported by this trigger type.
*
* @param type
* The event type to check
*
* @return True, if the event type is supported
*/
public boolean isEventTypeSupported(@Nonnull AutoModEventType type)
{
return type != null && eventTypes.contains(type);
}
/**
* The {@link AutoModTriggerType} that matches the provided key.
*
* @param key
* The key to match
*
* @return The matching {@link AutoModTriggerType} or {@link #UNKNOWN}
*/
@Nonnull
public static AutoModTriggerType fromKey(int key)
{
for (AutoModTriggerType trigger : values())
{
if (trigger.key == key)
return trigger;
}
return UNKNOWN;
}
}