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, parseMessage, pool, queue, url, USER_AGENT, WEBHOOK_URL

Constructor Summary

Constructors

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

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.
static @NotNull WebhookClient	fromJDA(net.dv8tion.jda.api.entities.Webhook webhook) Creates a WebhookClient for the provided webhook.
@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.

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

backoffQueue, checkShutdown, close, delete, drainQueue, edit, edit, edit, edit, execute, execute, failure, getId, getTimeout, getUrl, isShutdown, isWait, newBody, newRequest, queueRequest, send, send, send, send, send, send, send, send, setTimeout, withId, withUrl

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)

Method Detail

fromJDA

@NotNull
public static @NotNull WebhookClient fromJDA(@NotNull
                                                       net.dv8tion.jda.api.entities.Webhook webhook)

Creates a WebhookClient for the provided webhook.

Parameters:

webhook - The webhook

Returns:

The WebhookClient

Throws:

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

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)