Module io.github._4drian3d.jdwebhooks

Package io.github._4drian3d.jdwebhooks

Class WebHookClient

java.lang.Object

io.github._4drian3d.jdwebhooks.WebHookClient

public final class WebHookClient
extends Object

An object capable of sending requests to publish WebHooks in a given Discord channel.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	WebHookClient.Builder	Builder for the creation of a new WebHookClient.

Method Summary

Modifier and Type	Method	Description
static WebHookClient.Builder	builder()	Get a builder for the creation of a new WebHookClient.
static WebHookClient	from(@NotNull String id, @NotNull String token)	Creates a new WebHookClient based on its id and token.
static WebHookClient	fromURL(@NotNull String uri)	Creates a new WebHookClient based on a URI.
CompletableFuture<HttpResponse<String>>	sendWebHook(@NotNull WebHook webHook)	Sends the specified WebHook.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static WebHookClient.Builder builder()

Get a builder for the creation of a new WebHookClient.
It is recommended to use a builder instead of the static factory to be able to configure a user agent corresponding to your application.

Returns:

a new WebHookClient Builder

fromURL

public static WebHookClient fromURL(@NotNull
 @NotNull String uri)

Creates a new WebHookClient based on a URI.

Parameters:

uri - the webhook url provided

Returns:

a new WebHookClient

Throws:

IllegalArgumentException - if the provided URL is invalid

from

public static WebHookClient from(@NotNull
 @NotNull String id,
 @NotNull
 @NotNull String token)

Creates a new WebHookClient based on its id and token.

Parameters:

id - the webhook id

token - the webhook token

Returns:

a new WebHookClient

Throws:

IllegalArgumentException - if the provided id or token are is invalid

See Also:

• fromURL(String)

sendWebHook

public CompletableFuture<HttpResponse<String>> sendWebHook(@NotNull
 @NotNull WebHook webHook)

Sends the specified WebHook.

Parameters:

webHook - the webhook to send

Returns:

a CompletableFuture with the result of this request