From 77cfad2dcad102e8bbab340db909fbc3c10437f7 Mon Sep 17 00:00:00 2001
From: "Vincent B." <79211348+Snabeldier@users.noreply.github.com>
Date: Tue, 7 Jan 2025 02:07:48 +0100
Subject: [PATCH] feat: make webhook sending asynchronous (#265)

---
 .../java/minevalley/core/api/discord/Webhook.java | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/src/main/java/minevalley/core/api/discord/Webhook.java b/src/main/java/minevalley/core/api/discord/Webhook.java
index 7698433a..a9643562 100644
--- a/src/main/java/minevalley/core/api/discord/Webhook.java
+++ b/src/main/java/minevalley/core/api/discord/Webhook.java
@@ -4,6 +4,9 @@
 
 import javax.annotation.Nonnull;
 import java.io.IOException;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.CompletionException;
+import java.util.function.Function;
 
 /**
  * This Webhook-builder is meant to help you to create discord-webhooks.
@@ -35,12 +38,16 @@ public interface Webhook {
     Webhook setAvatar(@Nonnull String url) throws IllegalArgumentException;
 
     /**
-     * Sends the given messages to the discord-webhook.
+     * Sends the given messages to the discord-webhook asynchronously.
+     * <p>
+     * <b>Note:</b> Due to its asynchronous nature, this method may throw a {@link CompletionException} if the sending fails.
+     * This exception acts as a wrapper for the underlying exception and can be handled using {@link CompletableFuture#exceptionally(Function)}. To get to the underlying {@link IOException} use {@link CompletionException#getCause()}.
      *
      * @param message The messages to send.
-     * @throws IOException              If an I/O error occurs.
-     * @throws IllegalArgumentException If the message is null, or the given {@code EmbeddedMessage} is another implementation than our internal.
+     * @return A future that will be completed when the message was sent.
+     * @throws IllegalArgumentException If the message is null, no one is given or the given {@code EmbeddedMessage} is another implementation than our internal.
      */
+    @Nonnull
     @Contract(pure = true)
-    void send(@Nonnull EmbeddedMessage... message) throws IOException, IllegalArgumentException;
+    CompletableFuture<Void> send(@Nonnull EmbeddedMessage... message) throws IllegalArgumentException;
 }
\ No newline at end of file