Skip to content

Commit

Permalink
Document join raid and mention raid protection (discord#5778)
Browse files Browse the repository at this point in the history 
Document join raid and mention raid protection
  • Loading branch information
@advaith1 @shaydewael
advaith1 authored and shaydewael committed May 14, 2024
1 parent c087d54 commit 9662d89
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 58 deletions.
15 changes: 8 additions & 7 deletions docs/resources/Auto_Moderation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,14 @@ Characterizes the type of content which can trigger the rule.
Additional data used to determine whether a rule should be triggered. Different fields are relevant based on the
value of [trigger_type](#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-rule-object-trigger-types).

| Field | Type | Associated Trigger Types | Description |
| ------------------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------ | ------------------------------------------------------------------------------------------------ |
| keyword_filter | array of strings * | KEYWORD | substrings which will be searched for in content (Maximum of 1000) |
| regex_patterns | array of strings ** | KEYWORD | regular expression patterns which will be matched against content (Maximum of 10) |
| 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 |
| allow_list | array of strings *** | KEYWORD, KEYWORD_PRESET | substrings which should not trigger the rule (Maximum of 100 or 1000) |
| mention_total_limit | integer | MENTION_SPAM | total number of unique role and user mentions allowed per message (Maximum of 50) |
| Field | Type | Associated Trigger Types | Description |
| ------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------ | --------------------------------------------------------------------------------- |
| keyword_filter | array of strings * | KEYWORD | substrings which will be searched for in content (Maximum of 1000) |
| regex_patterns | array of strings ** | KEYWORD | regular expression patterns which will be matched against content (Maximum of 10) |
| 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 |
| allow_list | array of strings *** | KEYWORD, KEYWORD_PRESET | substrings which should not trigger the rule (Maximum of 100 or 1000) |
| mention_total_limit | integer | MENTION_SPAM | total number of unique role and user mentions allowed per message (Maximum of 50) |
| mention_raid_protection_enabled | boolean | MENTION_SPAM | whether to automatically detect mention raids |

\* 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.

Expand Down
Loading

0 comments on commit 9662d89

Please sign in to comment.