From 757bed0b1f345a8963bc4eb680bed4462531fb49 Mon Sep 17 00:00:00 2001
From: Jiralite <33201955+Jiralite@users.noreply.github.com>
Date: Fri, 7 Jun 2024 23:04:56 +0100
Subject: [PATCH] docs: Update rule trigger types (#9708)
docs: update rule trigger types
---
.../src/managers/AutoModerationRuleManager.js | 10 +++++++---
.../discord.js/src/structures/AutoModerationRule.js | 8 ++++++--
2 files changed, 13 insertions(+), 5 deletions(-)
diff --git a/packages/discord.js/src/managers/AutoModerationRuleManager.js b/packages/discord.js/src/managers/AutoModerationRuleManager.js
index dd0ee4eea3ae..4e53ae964e80 100644
--- a/packages/discord.js/src/managers/AutoModerationRuleManager.js
+++ b/packages/discord.js/src/managers/AutoModerationRuleManager.js
@@ -57,7 +57,9 @@ class AutoModerationRuleManager extends CachedManager {
* @property {AutoModerationRuleKeywordPresetType[]} [presets]
* The internally pre-defined wordsets which will be searched for in the content
* @property {string[]} [allowList] The substrings that will be exempt from triggering
- * {@link AutoModerationRuleTriggerType.Keyword} and {@link AutoModerationRuleTriggerType.KeywordPreset}
+ * {@link AutoModerationRuleTriggerType.Keyword},
+ * {@link AutoModerationRuleTriggerType.KeywordPreset},
+ * and {@link AutoModerationRuleTriggerType.MemberProfile}
* @property {?number} [mentionTotalLimit] The total number of role & user mentions allowed per message
* @property {boolean} [mentionRaidProtectionEnabled] Whether to automatically detect mention raids
*/
@@ -87,8 +89,10 @@ class AutoModerationRuleManager extends CachedManager {
* @property {AutoModerationRuleTriggerType} triggerType The trigger type of the auto moderation rule
* @property {AutoModerationTriggerMetadataOptions} [triggerMetadata] The trigger metadata of the auto moderation rule
* This property is required if using a `triggerType` of
- * {@link AutoModerationRuleTriggerType.Keyword}, {@link AutoModerationRuleTriggerType.KeywordPreset},
- * or {@link AutoModerationRuleTriggerType.MentionSpam}.
+ * {@link AutoModerationRuleTriggerType.Keyword},
+ * {@link AutoModerationRuleTriggerType.KeywordPreset},
+ * {@link AutoModerationRuleTriggerType.MentionSpam},
+ * or {@link AutoModerationRuleTriggerType.MemberProfile}.
* @property {AutoModerationActionOptions[]} actions
* The actions that will execute when the auto moderation rule is triggered
* @property {boolean} [enabled] Whether the auto moderation rule should be enabled
diff --git a/packages/discord.js/src/structures/AutoModerationRule.js b/packages/discord.js/src/structures/AutoModerationRule.js
index e87f547eb37c..f6c872280a31 100644
--- a/packages/discord.js/src/structures/AutoModerationRule.js
+++ b/packages/discord.js/src/structures/AutoModerationRule.js
@@ -66,7 +66,9 @@ class AutoModerationRule extends Base {
* @property {AutoModerationRuleKeywordPresetType[]} presets
* The internally pre-defined wordsets which will be searched for in the content
* @property {string[]} allowList The substrings that will be exempt from triggering
- * {@link AutoModerationRuleTriggerType.Keyword} and {@link AutoModerationRuleTriggerType.KeywordPreset}
+ * {@link AutoModerationRuleTriggerType.Keyword},
+ * {@link AutoModerationRuleTriggerType.KeywordPreset},
+ * and {@link AutoModerationRuleTriggerType.MemberProfile}
* @property {?number} mentionTotalLimit The total number of role & user mentions allowed per message
* @property {boolean} mentionRaidProtectionEnabled Whether mention raid protection is enabled
*/
@@ -209,7 +211,9 @@ class AutoModerationRule extends Base {
/**
* Sets the allow list for this auto moderation rule.
* @param {string[]} allowList The substrings that will be exempt from triggering
- * {@link AutoModerationRuleTriggerType.Keyword} and {@link AutoModerationRuleTriggerType.KeywordPreset}
+ * {@link AutoModerationRuleTriggerType.Keyword},
+ * {@link AutoModerationRuleTriggerType.KeywordPreset},
+ * and {@link AutoModerationRuleTriggerType.MemberProfile}
* @param {string} [reason] The reason for changing the allow list of this auto moderation rule
* @returns {Promise}
*/