Update documentation

discord-jda · Jun 28, 2022 · 70bbed5 · 70bbed5
1 parent 4fc8c35
commit 70bbed5
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 28 deletions.
diff --git a/src/examples/java/SlashBotExample.java b/src/examples/java/SlashBotExample.java
@@ -45,7 +45,7 @@ public static void main(String[] args) throws LoginException
                 .addEventListeners(new SlashBotExample())
                 .build();
 
-        // These commands take up to an hour to be activated after creation/update/delete
+        // These commands might take a few minutes to be active after creation/update/delete
         CommandListUpdateAction commands = jda.updateCommands();
 
         // Moderation commands with required options

diff --git a/src/main/java/net/dv8tion/jda/api/JDA.java b/src/main/java/net/dv8tion/jda/api/JDA.java
@@ -549,9 +549,6 @@ default RestAction<Command> retrieveCommandById(long id)
      *
      * <p>You need the OAuth2 scope {@code "applications.commands"} in order to add commands to a guild.
      *
-     * <p><b>Global commands can take up to <u>1 hour</u> to propagate to the clients.</b>
-     * For testing, it is recommended to use a test guild with guild commands.
-     *
      * @param  command
      *         The {@link CommandData} for the command
      *
@@ -580,9 +577,6 @@ default RestAction<Command> retrieveCommandById(long id)
      *
      * <p>You need the OAuth2 scope {@code "applications.commands"} in order to add commands to a guild.
      *
-     * <p><b>Global commands can take up to <u>1 hour</u> to propagate to the clients.</b>
-     * For testing, it is recommended to use a test guild with guild commands.
-     *
      * @param  name
      *         The lowercase alphanumeric (with dash) name, 1-32 characters
      * @param  description
@@ -611,18 +605,21 @@ default CommandCreateAction upsertCommand(@Nonnull String name, @Nonnull String
      *
      * <p>You need the OAuth2 scope {@code "applications.commands"} in order to add commands to a guild.
      *
-     * <p><b>Global commands can take up to <u>1 hour</u> to propagate to the clients.</b>
-     * For testing, it is recommended to use a test guild with guild commands.
+     * <p><b>Examples</b>
      *
-     * <h4>Examples</h4>
+     * <p>Set list to 2 commands:
      * <pre>{@code
-     * // Set list to 2 commands
      * jda.updateCommands()
      *   .addCommands(Commands.slash("ping", "Gives the current ping"))
      *   .addCommands(Commands.slash("ban", "Ban the target user")
+     *     .setGuildOnly(true)
+     *     .setDefaultPermissions(DefaultMemberPermissions.enabledFor(Permission.BAN_MEMBERS))
      *     .addOption(OptionType.USER, "user", "The user to ban", true))
      *   .queue();
-     * // Delete all commands
+     * }</pre>
+     *
+     * <p>Delete all commands:
+     * <pre>{@code
      * jda.updateCommands().queue();
      * }</pre>
      *
@@ -640,9 +637,6 @@ default CommandCreateAction upsertCommand(@Nonnull String name, @Nonnull String
      * <p>If there is no command with the provided ID,
      * this RestAction fails with {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_COMMAND ErrorResponse.UNKNOWN_COMMAND}
      *
-     * <p><b>Global commands can take up to <u>1 hour</u> to propagate to the clients.</b>
-     * For testing, it is recommended to use a test guild with guild commands.
-     *
      * @param  id
      *         The id of the command to edit
      *
@@ -661,9 +655,6 @@ default CommandCreateAction upsertCommand(@Nonnull String name, @Nonnull String
      * <p>If there is no command with the provided ID,
      * this RestAction fails with {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_COMMAND ErrorResponse.UNKNOWN_COMMAND}
      *
-     * <p><b>Global commands can take up to <u>1 hour</u> to propagate to the clients.</b>
-     * For testing, it is recommended to use a test guild with guild commands.
-     *
      * @param  id
      *         The id of the command to edit
      *
@@ -682,9 +673,6 @@ default CommandEditAction editCommandById(long id)
      * <p>If there is no command with the provided ID,
      * this RestAction fails with {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_COMMAND ErrorResponse.UNKNOWN_COMMAND}
      *
-     * <p><b>Global commands can take up to <u>1 hour</u> to propagate to the clients.</b>
-     * For testing, it is recommended to use a test guild with guild commands.
-     *
      * @param  commandId
      *         The id of the command that should be deleted
      *
@@ -703,9 +691,6 @@ default CommandEditAction editCommandById(long id)
      * <p>If there is no command with the provided ID,
      * this RestAction fails with {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_COMMAND ErrorResponse.UNKNOWN_COMMAND}
      *
-     * <p><b>Global commands can take up to <u>1 hour</u> to propagate to the clients.</b>
-     * For testing, it is recommended to use a test guild with guild commands.
-     *
      * @param  commandId
      *         The id of the command that should be deleted
      *

diff --git a/src/main/java/net/dv8tion/jda/api/entities/Guild.java b/src/main/java/net/dv8tion/jda/api/entities/Guild.java
@@ -193,15 +193,20 @@ default CommandCreateAction upsertCommand(@Nonnull String name, @Nonnull String
      *
      * <p>You need the OAuth2 scope {@code "applications.commands"} in order to add commands to a guild.
      *
-     * <h4>Examples</h4>
+     * <p><b>Examples</b>
+     *
+     * <p>Set list to 2 commands:
      * <pre>{@code
-     * // Set list to 2 commands
      * guild.updateCommands()
      *   .addCommands(Commands.slash("ping", "Gives the current ping"))
      *   .addCommands(Commands.slash("ban", "Ban the target user")
      *     .addOption(OptionType.USER, "user", "The user to ban", true))
+     *     .setDefaultPermissions(DefaultMemberPermissions.enabledFor(Permission.BAN_MEMBERS))
      *   .queue();
-     * // Delete all commands
+     * }</pre>
+     *
+     * <p>Delete all commands:
+     * <pre>{@code
      * guild.updateCommands().queue();
      * }</pre>
      *

diff --git a/src/main/java/net/dv8tion/jda/api/interactions/commands/Command.java b/src/main/java/net/dv8tion/jda/api/interactions/commands/Command.java
@@ -49,7 +49,6 @@ public interface Command extends ISnowflake
 {
     /**
      * Delete this command.
-     * <br>If this is a global command it may take up to 1 hour to vanish from all clients.
      *
      * @throws IllegalStateException
      *         If this command is not owned by this bot