club.minnced.discord.webhook.external

Class JavacordWebhookClient

java.lang.Object

club.minnced.discord.webhook.WebhookClient

club.minnced.discord.webhook.external.JavacordWebhookClient

All Implemented Interfaces:

java.lang.AutoCloseable

public class JavacordWebhookClient
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
JavacordWebhookClient(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, org.javacord.api.entity.message.embed.Embed embed) Edits the target message with the provided Embed to the webhook.
@NotNull java.util.concurrent.CompletableFuture<ReadonlyMessage>	edit(long messageId, org.javacord.api.entity.message.Message message) Edits the target message with the provided Message to the webhook.
static @NotNull WebhookClient	from(org.javacord.api.entity.webhook.Webhook webhook) Creates a WebhookClient for the provided webhook.
@NotNull java.util.concurrent.CompletableFuture<ReadonlyMessage>	send(org.javacord.api.entity.message.embed.Embed embed) Sends the provided Embed to the webhook.
@NotNull java.util.concurrent.CompletableFuture<ReadonlyMessage>	send(org.javacord.api.entity.message.Message message) Sends the provided Message 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

JavacordWebhookClient

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

Method Detail

from

@NotNull
public static @NotNull WebhookClient from(@NotNull
                                                    org.javacord.api.entity.webhook.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
                                                                                       org.javacord.api.entity.message.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.fromJavacord(org.javacord.api.entity.message.Message)

send

@NotNull
public @NotNull java.util.concurrent.CompletableFuture<ReadonlyMessage> send(@NotNull
                                                                                       org.javacord.api.entity.message.embed.Embed embed)

Sends the provided Embed to the webhook.

Parameters:

embed - The embed to send

Returns:

CompletableFuture

Throws:

java.lang.NullPointerException - If null is provided

See Also:

WebhookClient.isWait(), WebhookEmbedBuilder.fromJavacord(org.javacord.api.entity.message.embed.Embed)

edit

@NotNull
public @NotNull java.util.concurrent.CompletableFuture<ReadonlyMessage> edit(long messageId,
                                                                                       @NotNull
                                                                                       org.javacord.api.entity.message.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.fromJavacord(org.javacord.api.entity.message.Message)

edit

@NotNull
public @NotNull java.util.concurrent.CompletableFuture<ReadonlyMessage> edit(long messageId,
                                                                                       @NotNull
                                                                                       org.javacord.api.entity.message.embed.Embed embed)

Edits the target message with the provided Embed 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.fromJavacord(org.javacord.api.entity.message.embed.Embed)