Package net.dv8tion.jda.internal.requests.restaction

Class WebhookActionImpl

java.lang.Object

net.dv8tion.jda.internal.requests.RestActionImpl<Webhook>

net.dv8tion.jda.internal.requests.restaction.AuditableRestActionImpl<Webhook>

net.dv8tion.jda.internal.requests.restaction.WebhookActionImpl

All Implemented Interfaces:

RestAction<Webhook>, AuditableRestAction<Webhook>, WebhookAction

public class WebhookActionImpl
extends AuditableRestActionImpl<Webhook>
implements WebhookAction

Webhook Builder system created as an extension of RestAction
Provides an easy way to gather and deliver information to Discord to create Webhooks.

Field Summary

Fields inherited from class net.dv8tion.jda.internal.requests.RestActionImpl

LOG

Fields inherited from interface net.dv8tion.jda.api.requests.restaction.AuditableRestAction

MAX_REASON_LENGTH

Constructor Summary

Constructors

Constructor	Description
WebhookActionImpl(JDA api, IWebhookContainer channel, String name)

Method Summary

Modifier and Type	Method	Description
WebhookActionImpl	deadline(long timestamp)	Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
okhttp3.RequestBody	finalizeData()
IWebhookContainerUnion	getChannel()	The channel to create this webhook in.
WebhookActionImpl	setAvatar(Icon icon)	Sets the Avatar for the custom Webhook User
WebhookActionImpl	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
WebhookActionImpl	setName(String name)	Sets the Name for the custom Webhook User
WebhookActionImpl	timeout(long timeout, TimeUnit unit)	Timeout for this RestAction instance.

Methods inherited from class net.dv8tion.jda.internal.requests.restaction.AuditableRestActionImpl

reason

Methods inherited from class net.dv8tion.jda.internal.requests.RestActionImpl

complete, getCheck, getDefaultFailure, getDefaultSuccess, getDefaultTimeout, getJDA, handleResponse, isPassContext, priority, queue, setDefaultFailure, setDefaultSuccess, setDefaultTimeout, setErrorMapper, setPassContext, submit

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.dv8tion.jda.api.requests.restaction.AuditableRestAction

reason

Methods inherited from interface net.dv8tion.jda.api.requests.RestAction

addCheck, and, and, complete, complete, completeAfter, delay, delay, delay, delay, flatMap, flatMap, getCheck, getJDA, map, mapToResult, onErrorFlatMap, onErrorFlatMap, onErrorMap, onErrorMap, onSuccess, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, submit, submit, submitAfter, submitAfter, zip

Methods inherited from interface net.dv8tion.jda.api.requests.restaction.WebhookAction

getGuild

Constructor Details

WebhookActionImpl

public WebhookActionImpl(JDA api,
 IWebhookContainer channel,
 String name)

Method Details

setCheck

@Nonnull
public WebhookActionImpl setCheck(BooleanSupplier checks)

Description copied from interface: RestAction

Sets the last-second checks before finally executing the http request in the queue.
If the provided supplier evaluates to false or throws an exception this will not be finished. When an exception is thrown from the supplier it will be provided to the failure callback.

Specified by:

setCheck in interface AuditableRestAction<Webhook>

Specified by:

setCheck in interface RestAction<Webhook>

Specified by:

setCheck in interface WebhookAction

Overrides:

setCheck in class AuditableRestActionImpl<Webhook>

Parameters:

checks - The checks to run before executing the request, or null to run no checks

Returns:

The current RestAction for chaining convenience

See Also:

• RestAction.getCheck()
• RestAction.addCheck(BooleanSupplier)

timeout

@Nonnull
public WebhookActionImpl timeout(long timeout,
 @Nonnull
 TimeUnit unit)

Description copied from interface: AuditableRestAction

Timeout for this RestAction instance.
If the request doesn't get executed within the timeout it will fail.

When a RestAction times out, it will fail with a TimeoutException. This is the same as deadline(System.currentTimeMillis() + unit.toMillis(timeout)).

Example

 action.timeout(10, TimeUnit.SECONDS) // 10 seconds from now
       .queueAfter(20, SECONDS); // request will not be executed within deadline and timeout immediately after 20 seconds
 

Specified by:

timeout in interface AuditableRestAction<Webhook>

Specified by:

timeout in interface RestAction<Webhook>

Specified by:

timeout in interface WebhookAction

Overrides:

timeout in class AuditableRestActionImpl<Webhook>

Parameters:

timeout - The timeout to use

unit - Unit for the timeout value

Returns:

The same RestAction instance with the applied timeout

See Also:

• RestAction.setDefaultTimeout(long, TimeUnit)

deadline

@Nonnull
public WebhookActionImpl deadline(long timestamp)

Description copied from interface: RestAction

Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
If the deadline is reached, the request will fail with a TimeoutException.

This does not mean that the request will immediately timeout when the deadline is reached. JDA will check the deadline right before executing the request or within intervals in a worker thread. This only means the request will timeout if the deadline has passed.

Example

 action.deadline(System.currentTimeMillis() + 10000) // 10 seconds from now
       .queueAfter(20, SECONDS); // request will not be executed within deadline and timeout immediately after 20 seconds
 

Specified by:

deadline in interface AuditableRestAction<Webhook>

Specified by:

deadline in interface RestAction<Webhook>

Specified by:

deadline in interface WebhookAction

Overrides:

deadline in class AuditableRestActionImpl<Webhook>

Parameters:

timestamp - Millisecond timestamp at which the request will timeout

Returns:

The same RestAction with the applied deadline

See Also:

• RestAction.timeout(long, TimeUnit)
• RestAction.setDefaultTimeout(long, TimeUnit)

getChannel

@Nonnull
public IWebhookContainerUnion getChannel()

Description copied from interface: WebhookAction

The channel to create this webhook in.

Specified by:

getChannel in interface WebhookAction

Returns:

The channel

setName

@Nonnull
@CheckReturnValue
public WebhookActionImpl setName(@Nonnull
 String name)

Description copied from interface: WebhookAction

Sets the Name for the custom Webhook User

Specified by:

setName in interface WebhookAction

Parameters:

name - A not-null String name for the new Webhook user.

Returns:

The current WebhookAction for chaining convenience.

setAvatar

@Nonnull
@CheckReturnValue
public WebhookActionImpl setAvatar(Icon icon)

Description copied from interface: WebhookAction

Sets the Avatar for the custom Webhook User

Specified by:

setAvatar in interface WebhookAction

Parameters:

icon - An Icon for the new avatar. Or null to use default avatar.

Returns:

The current WebhookAction for chaining convenience.

finalizeData

public okhttp3.RequestBody finalizeData()