Skip to content

Commit 60a711d

Browse files
jaw0r3kcodeofandrin
jaw0r3k
and
codeofandrin
authored
Document Blocking Words in Member Profiles Automod (#6040)
* feat: add blocking words in member profile * fix: allow type in trigger metadata Co-authored-by: Puncher <65789180+Puncher1@users.noreply.github.com> * chore: format --------- Co-authored-by: Puncher <65789180+Puncher1@users.noreply.github.com>
1 parent b034707 commit 60a711d

File tree

1 file changed

+31
-28
lines changed

1 file changed

+31
-28
lines changed

‎docs/resources/Auto_Moderation.md

Lines changed: 31 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -59,26 +59,27 @@ Rules can be configured to automatically execute actions whenever they trigger.
5959
###### Trigger Types
6060
Characterizes the type of content which can trigger the rule.
6161

62-
| Trigger Type | Value | Description | Max per Guild |
63-
|----------------|-------|----------------------------------------------------------------------|---------------|
64-
| KEYWORD | 1 | check if content contains words from a user defined list of keywords | 6 |
65-
| SPAM | 3 | check if content represents generic spam | 1 |
66-
| KEYWORD_PRESET | 4 | check if content contains words from internal pre-defined wordsets | 1 |
67-
| MENTION_SPAM | 5 | check if content contains more unique mentions than allowed | 1 |
62+
| Trigger Type | Value | Description | Max per Guild |
63+
|----------------|-------|-----------------------------------------------------------------------------|---------------|
64+
| KEYWORD | 1 | check if content contains words from a user defined list of keywords | 6 |
65+
| SPAM | 3 | check if content represents generic spam | 1 |
66+
| KEYWORD_PRESET | 4 | check if content contains words from internal pre-defined wordsets | 1 |
67+
| MENTION_SPAM | 5 | check if content contains more unique mentions than allowed | 1 |
68+
| MEMBER_PROFILE | 6 | check if member profile contains words from a user defined list of keywords | 1 |
6869

6970
###### Trigger Metadata
7071

7172
Additional data used to determine whether a rule should be triggered. Different fields are relevant based on the
7273
value of [trigger_type](#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-rule-object-trigger-types).
7374

74-
| Field | Type | Associated Trigger Types | Description |
75-
|---------------------------------|-------------------------------------------------------------------------------------------------------------------|--------------------------|-----------------------------------------------------------------------------------|
76-
| keyword_filter | array of strings * | KEYWORD | substrings which will be searched for in content (Maximum of 1000) |
77-
| regex_patterns | array of strings ** | KEYWORD | regular expression patterns which will be matched against content (Maximum of 10) |
78-
| presets | array of [keyword preset types](#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-rule-object-keyword-preset-types) | KEYWORD_PRESET | the internally pre-defined wordsets which will be searched for in content |
79-
| allow_list | array of strings *** | KEYWORD, KEYWORD_PRESET | substrings which should not trigger the rule (Maximum of 100 or 1000) |
80-
| mention_total_limit | integer | MENTION_SPAM | total number of unique role and user mentions allowed per message (Maximum of 50) |
81-
| mention_raid_protection_enabled | boolean | MENTION_SPAM | whether to automatically detect mention raids |
75+
| Field | Type | Associated Trigger Types | Description |
76+
|---------------------------------|-------------------------------------------------------------------------------------------------------------------|-----------------------------------------|-----------------------------------------------------------------------------------|
77+
| keyword_filter | array of strings * | KEYWORD, MEMBER_PROFILE | substrings which will be searched for in content (Maximum of 1000) |
78+
| regex_patterns | array of strings ** | KEYWORD, MEMBER_PROFILE | regular expression patterns which will be matched against content (Maximum of 10) |
79+
| presets | array of [keyword preset types](#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-rule-object-keyword-preset-types) | KEYWORD_PRESET | the internally pre-defined wordsets which will be searched for in content |
80+
| allow_list | array of strings *** | KEYWORD, KEYWORD_PRESET, MEMBER_PROFILE | substrings which should not trigger the rule (Maximum of 100 or 1000) |
81+
| mention_total_limit | integer | MENTION_SPAM | total number of unique role and user mentions allowed per message (Maximum of 50) |
82+
| mention_raid_protection_enabled | boolean | MENTION_SPAM | whether to automatically detect mention raids |
8283

8384
\* A keyword can be a phrase which contains multiple words. [Wildcard symbols](#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-rule-object-keyword-matching-strategies) can be used to customize how each keyword will be matched. Each keyword must be 60 characters or less.
8485

@@ -88,12 +89,12 @@ value of [trigger_type](#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-rule-obj
8889

8990
###### Trigger Metadata Field Limits
9091

91-
| Field | Trigger Type | MAX ARRAY LENGTH | MAX CHARACTERS PER STRING |
92-
|----------------|----------------|------------------|---------------------------|
93-
| keyword_filter | KEYWORD | 1000 | 60 |
94-
| regex_patterns | KEYWORD | 10 | 260 |
95-
| allow_list | KEYWORD | 100 | 60 |
96-
| allow_list | KEYWORD_PRESET | 1000 | 60 |
92+
| Field | Trigger Types | MAX ARRAY LENGTH | MAX CHARACTERS PER STRING |
93+
|----------------|-------------------------|------------------|---------------------------|
94+
| keyword_filter | KEYWORD, MEMBER_PROFILE | 1000 | 60 |
95+
| regex_patterns | KEYWORD, MEMBER_PROFILE | 10 | 260 |
96+
| allow_list | KEYWORD, MEMBER_PROFILE | 100 | 60 |
97+
| allow_list | KEYWORD_PRESET | 1000 | 60 |
9798

9899

99100
###### Keyword Preset Types
@@ -109,9 +110,10 @@ value of [trigger_type](#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-rule-obj
109110

110111
Indicates in what event context a rule should be checked.
111112

112-
| Event Type | Value | Description |
113-
|--------------|-------|-----------------------------------------------------|
114-
| MESSAGE_SEND | 1 | when a member sends or edits a message in the guild |
113+
| Event Type | Value | Description |
114+
|---------------|-------|-----------------------------------------------------|
115+
| MESSAGE_SEND | 1 | when a member sends or edits a message in the guild |
116+
| MEMBER_UPDATE | 2 | when a member edits their profile |
115117

116118

117119
###### Keyword Matching Strategies
@@ -169,11 +171,12 @@ An action which will execute whenever a rule is triggered.
169171

170172
###### Action Types
171173

172-
| Action Type | Value | Description |
173-
|--------------------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
174-
| BLOCK_MESSAGE | 1 | blocks a member's message and prevents it from being posted. A custom explanation can be specified and shown to members whenever their message is blocked. |
175-
| SEND_ALERT_MESSAGE | 2 | logs user content to a specified channel |
176-
| TIMEOUT | 3 | timeout user for a specified duration * |
174+
| Action Type | Value | Description |
175+
|--------------------------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
176+
| BLOCK_MESSAGE | 1 | blocks a member's message and prevents it from being posted. A custom explanation can be specified and shown to members whenever their message is blocked. |
177+
| SEND_ALERT_MESSAGE | 2 | logs user content to a specified channel |
178+
| TIMEOUT | 3 | timeout user for a specified duration * |
179+
| BLOCK_MEMBER_INTERACTION | 4 | prevents a member from using text, voice, or other interactions |
177180

178181
\* A `TIMEOUT` action can only be set up for `KEYWORD` and `MENTION_SPAM` rules. The `MODERATE_MEMBERS` permission is required to use the `TIMEOUT` action type.
179182

0 commit comments

Comments
 (0)