club.minnced.discord.webhook.external

Class D4JWebhookClient

java.lang.Object

club.minnced.discord.webhook.WebhookClient

club.minnced.discord.webhook.external.D4JWebhookClient

All Implemented Interfaces:

java.lang.AutoCloseable

public class D4JWebhookClient
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	D4JWebhookClient(D4JWebhookClient parent, long threadId)
	D4JWebhookClient(long id, java.lang.String token, boolean parseMessage, okhttp3.OkHttpClient client, java.util.concurrent.ScheduledExecutorService pool, AllowedMentions mentions)
	D4JWebhookClient(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 reactor.core.publisher.Mono<ReadonlyMessage>	edit(long messageId, @NotNull java.util.function.Consumer<? super discord4j.core.spec.MessageCreateSpec> callback) Deprecated. Replace with edit(long, MessageEditSpec)
@NotNull reactor.core.publisher.Mono<ReadonlyMessage>	edit(long messageId, @NotNull discord4j.core.spec.MessageEditSpec spec) Edits the target message with the provided MessageCreateSpec to the webhook.
@NotNull reactor.core.publisher.Mono<ReadonlyMessage>	edit(@NotNull java.lang.String messageId, @NotNull java.util.function.Consumer<? super discord4j.core.spec.MessageCreateSpec> callback) Deprecated. Replace with edit(long, MessageEditSpec)
@NotNull reactor.core.publisher.Mono<ReadonlyMessage>	edit(@NotNull java.lang.String messageId, @NotNull discord4j.core.spec.MessageEditSpec spec) Edits the target message with the provided MessageCreateSpec to the webhook.
static @NotNull D4JWebhookClient	from(discord4j.core.object.entity.Webhook webhook) Creates a D4JWebhookClient for the provided webhook.
@NotNull D4JWebhookClient	onThread(long threadId) Returns a wrapper of this WebhookClient that targets the specified thread.
@NotNull reactor.core.publisher.Mono<ReadonlyMessage>	send(@NotNull java.util.function.Consumer<? super discord4j.core.spec.MessageCreateSpec> callback) Deprecated. Replace wth send(MessageCreateSpec)
@NotNull reactor.core.publisher.Mono<ReadonlyMessage>	send(@NotNull discord4j.core.spec.MessageCreateSpec spec) Sends the provided MessageCreateSpec to the webhook.
static @NotNull D4JWebhookClient	withId(long id, @NotNull java.lang.String token) Factory method to create a basic D4JWebhookClient with the provided id and token.
static @NotNull D4JWebhookClient	withUrl(@NotNull java.lang.String url) Factory method to create a basic D4JWebhookClient 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

D4JWebhookClient

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

D4JWebhookClient

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

D4JWebhookClient

protected D4JWebhookClient(D4JWebhookClient parent,
                           long threadId)

Method Detail

from

@NotNull
public static @NotNull D4JWebhookClient from(@NotNull
                                                       discord4j.core.object.entity.Webhook webhook)

Creates a D4JWebhookClient for the provided webhook.

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

Parameters:

webhook - The webhook

Returns:

The D4JWebhookClient

Throws:

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

withId

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

Factory method to create a basic D4JWebhookClient 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 D4JWebhookClient for the provided id and token

Throws:

java.lang.NullPointerException - If provided with null

withUrl

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

Factory method to create a basic D4JWebhookClient 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 D4JWebhookClient 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 D4JWebhookClient 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
 @Deprecated
 @CheckReturnValue
public @NotNull reactor.core.publisher.Mono<ReadonlyMessage> send(@NotNull
                                                                                                              @NotNull java.util.function.Consumer<? super discord4j.core.spec.MessageCreateSpec> callback)

Deprecated. Replace wth send(MessageCreateSpec)

Sends the provided MessageCreateSpec to the webhook.

Parameters:

callback - The callback used to specify the desired message settings

Returns:

Mono

Throws:

java.lang.NullPointerException - If null is provided

See Also:

WebhookClient.isWait(), WebhookMessageBuilder.fromD4J(Consumer)

edit

@NotNull
 @Deprecated
 @CheckReturnValue
public @NotNull reactor.core.publisher.Mono<ReadonlyMessage> edit(long messageId,
                                                                                                              @NotNull
                                                                                                              @NotNull java.util.function.Consumer<? super discord4j.core.spec.MessageCreateSpec> callback)

Deprecated. Replace with edit(long, MessageEditSpec)

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

Parameters:

messageId - The target message id

callback - The callback used to specify the desired message settings

Returns:

Mono

Throws:

java.lang.NullPointerException - If null is provided

See Also:

WebhookClient.isWait(), WebhookMessageBuilder.fromD4J(Consumer)

edit

@NotNull
 @Deprecated
 @CheckReturnValue
public @NotNull reactor.core.publisher.Mono<ReadonlyMessage> edit(@NotNull
                                                                                                              @NotNull java.lang.String messageId,
                                                                                                              @NotNull
                                                                                                              @NotNull java.util.function.Consumer<? super discord4j.core.spec.MessageCreateSpec> callback)

Deprecated. Replace with edit(long, MessageEditSpec)

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

Parameters:

messageId - The target message id

callback - The callback used to specify the desired message settings

Returns:

Mono

Throws:

java.lang.NullPointerException - If null is provided

See Also:

WebhookClient.isWait(), WebhookMessageBuilder.fromD4J(Consumer)

send

@NotNull
 @CheckReturnValue
public @NotNull reactor.core.publisher.Mono<ReadonlyMessage> send(@NotNull
                                                                                                @NotNull discord4j.core.spec.MessageCreateSpec spec)

Sends the provided MessageCreateSpec to the webhook.

Parameters:

spec - The message create spec used to specify the desired message settings

Returns:

Mono

Throws:

java.lang.NullPointerException - If null is provided

See Also:

WebhookClient.isWait(), WebhookMessageBuilder.fromD4J(MessageCreateSpec)

edit

@NotNull
 @CheckReturnValue
public @NotNull reactor.core.publisher.Mono<ReadonlyMessage> edit(long messageId,
                                                                                                @NotNull
                                                                                                @NotNull discord4j.core.spec.MessageEditSpec spec)

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

Parameters:

messageId - The target message id

spec - The message edit spec used to specify the desired message settings

Returns:

Mono

Throws:

java.lang.NullPointerException - If null is provided

See Also:

WebhookClient.isWait(), WebhookMessageBuilder.fromD4J(MessageEditSpec)

edit

@NotNull
 @CheckReturnValue
public @NotNull reactor.core.publisher.Mono<ReadonlyMessage> edit(@NotNull
                                                                                                @NotNull java.lang.String messageId,
                                                                                                @NotNull
                                                                                                @NotNull discord4j.core.spec.MessageEditSpec spec)

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

Parameters:

messageId - The target message id

spec - The message edit spec used to specify the desired message settings

Returns:

Mono

Throws:

java.lang.NullPointerException - If null is provided

See Also:

WebhookClient.isWait(), WebhookMessageBuilder.fromD4J(MessageEditSpec)