club.minnced.discord.webhook.external

Class JDAWebhookClient

java.lang.Object

club.minnced.discord.webhook.WebhookClient

club.minnced.discord.webhook.external.JDAWebhookClient

All Implemented Interfaces:

java.lang.AutoCloseable

public class JDAWebhookClient
extends WebhookClient

Nested Class Summary

Nested classes/interfaces inherited from class club.minnced.discord.webhook.WebhookClient

WebhookClient.Bucket

Field Summary

Fields inherited from class club.minnced.discord.webhook.WebhookClient

allowedMentions, bucket, client, defaultTimeout, id, isQueued, isShutdown, parent, parseMessage, pool, queue, threadId, url, USER_AGENT, WEBHOOK_URL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JDAWebhookClient(JDAWebhookClient parent, long threadId)
	JDAWebhookClient(long id, java.lang.String token, boolean parseMessage, okhttp3.OkHttpClient client, java.util.concurrent.ScheduledExecutorService pool, AllowedMentions mentions)
	JDAWebhookClient(long id, java.lang.String token, boolean parseMessage, okhttp3.OkHttpClient client, java.util.concurrent.ScheduledExecutorService pool, AllowedMentions mentions, long threadId)

Method Summary

Modifier and Type	Method and Description
@NotNull java.util.concurrent.CompletableFuture<ReadonlyMessage>	edit(long messageId, net.dv8tion.jda.api.entities.Message message) Edits the target message with the provided Message to the webhook.
@NotNull java.util.concurrent.CompletableFuture<ReadonlyMessage>	edit(long messageId, net.dv8tion.jda.api.entities.MessageEmbed embed) Edits the target message with the provided MessageEmbed to the webhook.
@NotNull java.util.concurrent.CompletableFuture<ReadonlyMessage>	edit(@NotNull java.lang.String messageId, net.dv8tion.jda.api.entities.Message message) Edits the target message with the provided Message to the webhook.
@NotNull java.util.concurrent.CompletableFuture<ReadonlyMessage>	edit(@NotNull java.lang.String messageId, net.dv8tion.jda.api.entities.MessageEmbed embed) Edits the target message with the provided MessageEmbed to the webhook.
static @NotNull JDAWebhookClient	from(net.dv8tion.jda.api.entities.Webhook webhook) Creates a WebhookClient for the provided webhook.
@NotNull JDAWebhookClient	onThread(long threadId) Returns a wrapper of this WebhookClient that targets the specified thread.
@NotNull java.util.concurrent.CompletableFuture<ReadonlyMessage>	send(net.dv8tion.jda.api.entities.Message message) Sends the provided Message to the webhook.
@NotNull java.util.concurrent.CompletableFuture<ReadonlyMessage>	send(net.dv8tion.jda.api.entities.MessageEmbed embed) Sends the provided MessageEmbed to the webhook.
static @NotNull JDAWebhookClient	withId(long id, @NotNull java.lang.String token) Factory method to create a basic JDAWebhookClient with the provided id and token.
static @NotNull JDAWebhookClient	withUrl(@NotNull java.lang.String url) Factory method to create a basic JDAWebhookClient with the provided id and token.

Methods inherited from class club.minnced.discord.webhook.WebhookClient

backoffQueue, checkShutdown, close, delete, delete, drainQueue, edit, edit, edit, edit, edit, edit, edit, edit, execute, execute, failure, get, get, getId, getThreadId, getTimeout, getUrl, isShutdown, isWait, newBody, newRequest, queueRequest, schedule, send, send, send, send, send, send, send, send, setTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

JDAWebhookClient

public JDAWebhookClient(long id,
                        java.lang.String token,
                        boolean parseMessage,
                        okhttp3.OkHttpClient client,
                        java.util.concurrent.ScheduledExecutorService pool,
                        AllowedMentions mentions)

JDAWebhookClient

public JDAWebhookClient(long id,
                        java.lang.String token,
                        boolean parseMessage,
                        okhttp3.OkHttpClient client,
                        java.util.concurrent.ScheduledExecutorService pool,
                        AllowedMentions mentions,
                        long threadId)

JDAWebhookClient

protected JDAWebhookClient(JDAWebhookClient parent,
                           long threadId)

Method Detail

from

@NotNull
public static @NotNull JDAWebhookClient from(@NotNull
                                                       net.dv8tion.jda.api.entities.Webhook webhook)

Creates a WebhookClient for the provided webhook.

You can use onThread(long) to target specific threads on the channel.

Parameters:

webhook - The webhook

Returns:

The JDAWebhookClient

Throws:

java.lang.NullPointerException - If the webhook is null or does not provide a token

withId

@NotNull
public static @NotNull JDAWebhookClient withId(long id,
                                                         @NotNull
                                                         @NotNull java.lang.String token)

Factory method to create a basic JDAWebhookClient with the provided id and token.

You can use onThread(long) to target specific threads on the channel.

Parameters:

id - The webhook id

token - The webhook token

Returns:

The JDAWebhookClient for the provided id and token

Throws:

java.lang.NullPointerException - If provided with null

withUrl

@NotNull
public static @NotNull JDAWebhookClient withUrl(@NotNull
                                                          @NotNull java.lang.String url)

Factory method to create a basic JDAWebhookClient with the provided id and token.

You can use onThread(long) to target specific threads on the channel.

Parameters:

url - The url for the webhook

Returns:

The JDAWebhookClient for the provided url

Throws:

java.lang.NullPointerException - If provided with null

java.lang.NumberFormatException - If no valid id is part o the url

onThread

@NotNull
public @NotNull JDAWebhookClient onThread(long threadId)

Description copied from class: WebhookClient

Returns a wrapper of this WebhookClient that targets the specified thread.
The thread should be on the same channel as the webhook.

The returned webhook client inherits all the settings (including the thread pool) from this client instance. If either of the clients is shutdown/closed, the other instance will no longer send any messages.

Overrides:

onThread in class WebhookClient

Parameters:

threadId - The target thread id, or 0 to send directly to the parent channel

Returns:

A new webhook client instance which targets the specified thread

send

@NotNull
public @NotNull java.util.concurrent.CompletableFuture<ReadonlyMessage> send(@NotNull
                                                                                       net.dv8tion.jda.api.entities.Message message)

Sends the provided Message to the webhook.

Parameters:

message - The message to send

Returns:

CompletableFuture

Throws:

java.lang.NullPointerException - If null is provided

See Also:

WebhookClient.isWait(), WebhookMessageBuilder.fromJDA(Message)

send

@NotNull
public @NotNull java.util.concurrent.CompletableFuture<ReadonlyMessage> send(@NotNull
                                                                                       net.dv8tion.jda.api.entities.MessageEmbed embed)

Sends the provided MessageEmbed to the webhook.

Parameters:

embed - The embed to send

Returns:

CompletableFuture

Throws:

java.lang.NullPointerException - If null is provided

See Also:

WebhookClient.isWait(), WebhookEmbedBuilder.fromJDA(net.dv8tion.jda.api.entities.MessageEmbed)

edit

@NotNull
public @NotNull java.util.concurrent.CompletableFuture<ReadonlyMessage> edit(long messageId,
                                                                                       @NotNull
                                                                                       net.dv8tion.jda.api.entities.Message message)

Edits the target message with the provided Message to the webhook.

Parameters:

messageId - The target message id

message - The message to send

Returns:

CompletableFuture

Throws:

java.lang.NullPointerException - If null is provided

See Also:

WebhookClient.isWait(), WebhookMessageBuilder.fromJDA(Message)

edit

@NotNull
public @NotNull java.util.concurrent.CompletableFuture<ReadonlyMessage> edit(long messageId,
                                                                                       @NotNull
                                                                                       net.dv8tion.jda.api.entities.MessageEmbed embed)

Edits the target message with the provided MessageEmbed to the webhook.

Parameters:

messageId - The target message id

embed - The embed to send

Returns:

CompletableFuture

Throws:

java.lang.NullPointerException - If null is provided

See Also:

WebhookClient.isWait(), WebhookEmbedBuilder.fromJDA(net.dv8tion.jda.api.entities.MessageEmbed)

edit

@NotNull
public @NotNull java.util.concurrent.CompletableFuture<ReadonlyMessage> edit(@NotNull
                                                                                       @NotNull java.lang.String messageId,
                                                                                       @NotNull
                                                                                       net.dv8tion.jda.api.entities.Message message)

Edits the target message with the provided Message to the webhook.

Parameters:

messageId - The target message id

message - The message to send

Returns:

CompletableFuture

Throws:

java.lang.NullPointerException - If null is provided

See Also:

WebhookClient.isWait(), WebhookMessageBuilder.fromJDA(Message)

edit

@NotNull
public @NotNull java.util.concurrent.CompletableFuture<ReadonlyMessage> edit(@NotNull
                                                                                       @NotNull java.lang.String messageId,
                                                                                       @NotNull
                                                                                       net.dv8tion.jda.api.entities.MessageEmbed embed)

Edits the target message with the provided MessageEmbed to the webhook.

Parameters:

messageId - The target message id

embed - The embed to send

Returns:

CompletableFuture

Throws:

java.lang.NullPointerException - If null is provided

See Also:

WebhookClient.isWait(), WebhookEmbedBuilder.fromJDA(net.dv8tion.jda.api.entities.MessageEmbed)