Add required permissions to automod events (#2488)

discord-jda · Jun 26, 2023 · 043b0f5 · 043b0f5
1 parent 0a501e2
commit 043b0f5
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 4 deletions.
diff --git a/src/main/java/net/dv8tion/jda/api/events/automod/AutoModExecutionEvent.java b/src/main/java/net/dv8tion/jda/api/events/automod/AutoModExecutionEvent.java
@@ -34,6 +34,7 @@
  *
  * <p><b>Requirements</b><br>
  * This event requires the {@link GatewayIntent#AUTO_MODERATION_EXECUTION AUTO_MODERATION_EXECUTION} intent to be enabled.
+ * <br>This event will only fire for guilds where the bot has the {@link net.dv8tion.jda.api.Permission#MANAGE_SERVER MANAGE_SERVER} permission.
  * Additionally, access to {@link #getContent()} and {@link #getMatchedContent()} requires the {@link GatewayIntent#MESSAGE_CONTENT MESSAGE_CONTENT} intent to be enabled.
  */
 public class AutoModExecutionEvent extends Event implements AutoModExecution

diff --git a/src/main/java/net/dv8tion/jda/api/events/automod/AutoModRuleCreateEvent.java b/src/main/java/net/dv8tion/jda/api/events/automod/AutoModRuleCreateEvent.java
@@ -22,11 +22,12 @@
 import javax.annotation.Nonnull;
 
 /**
- * Indicates that a {@link AutoModRule} was created.
+ * Indicates that an {@link AutoModRule} was created.
  *
  * <p><b>Requirements</b><br>
  *
  * <p>These events require the {@link net.dv8tion.jda.api.requests.GatewayIntent#AUTO_MODERATION_CONFIGURATION AUTO_MODERATION_CONFIGURATION} intent to be enabled.
+ * <br>This event will only fire for guilds where the bot has the {@link net.dv8tion.jda.api.Permission#MANAGE_SERVER MANAGE_SERVER} permission.
  */
 public class AutoModRuleCreateEvent extends GenericAutoModRuleEvent
 {

diff --git a/src/main/java/net/dv8tion/jda/api/events/automod/AutoModRuleDeleteEvent.java b/src/main/java/net/dv8tion/jda/api/events/automod/AutoModRuleDeleteEvent.java
@@ -22,11 +22,12 @@
 import javax.annotation.Nonnull;
 
 /**
- * Indicates that a {@link AutoModRule} was deleted.
+ * Indicates that an {@link AutoModRule} was deleted.
  *
  * <p><b>Requirements</b><br>
  *
  * <p>These events require the {@link net.dv8tion.jda.api.requests.GatewayIntent#AUTO_MODERATION_CONFIGURATION AUTO_MODERATION_CONFIGURATION} intent to be enabled.
+ * <br>This event will only fire for guilds where the bot has the {@link net.dv8tion.jda.api.Permission#MANAGE_SERVER MANAGE_SERVER} permission.
  */
 public class AutoModRuleDeleteEvent extends GenericAutoModRuleEvent
 {

diff --git a/src/main/java/net/dv8tion/jda/api/events/automod/AutoModRuleUpdateEvent.java b/src/main/java/net/dv8tion/jda/api/events/automod/AutoModRuleUpdateEvent.java
@@ -22,11 +22,12 @@
 import javax.annotation.Nonnull;
 
 /**
- * Indicates that a {@link AutoModRule} was updated.
+ * Indicates that an {@link AutoModRule} was updated.
  *
  * <p><b>Requirements</b><br>
  *
  * <p>These events require the {@link net.dv8tion.jda.api.requests.GatewayIntent#AUTO_MODERATION_CONFIGURATION AUTO_MODERATION_CONFIGURATION} intent to be enabled.
+ * <br>This event will only fire for guilds where the bot has the {@link net.dv8tion.jda.api.Permission#MANAGE_SERVER MANAGE_SERVER} permission.
  */
 public class AutoModRuleUpdateEvent extends GenericAutoModRuleEvent
 {

diff --git a/src/main/java/net/dv8tion/jda/api/events/automod/GenericAutoModRuleEvent.java b/src/main/java/net/dv8tion/jda/api/events/automod/GenericAutoModRuleEvent.java
@@ -23,11 +23,12 @@
 import javax.annotation.Nonnull;
 
 /**
- * Indicates that na {@link AutoModRule} was created/removed/updated.
+ * Indicates that an {@link AutoModRule} was created/removed/updated.
  *
  * <p><b>Requirements</b><br>
  *
  * <p>These events require the {@link net.dv8tion.jda.api.requests.GatewayIntent#AUTO_MODERATION_CONFIGURATION AUTO_MODERATION_CONFIGURATION} intent to be enabled.
+ * <br>These events will only fire for guilds where the bot has the {@link net.dv8tion.jda.api.Permission#MANAGE_SERVER MANAGE_SERVER} permission.
  */
 public class GenericAutoModRuleEvent extends Event
 {