Interface WebhookAction
- All Superinterfaces:
AuditableRestAction<Webhook>,RestAction<Webhook>
Webhook Builder system created as an extension of RestAction
Provides an easy way to gather and deliver information to Discord to create
Webhooks.- See Also:
-
Field Summary
Fields inherited from interface net.dv8tion.jda.api.requests.restaction.AuditableRestAction
MAX_REASON_LENGTH -
Method Summary
Modifier and TypeMethodDescriptiondeadline(long timestamp) Similar toRestAction.timeout(long, TimeUnit)but schedules a deadline at which the request has to be completed.Thechannelto create this webhook in.default GuildgetGuild()TheGuildto create this webhook inSets the Avatar for the custom Webhook UsersetCheck(BooleanSupplier checks) Sets the last-second checks before finally executing the http request in the queue.Sets the Name for the custom Webhook UserTimeout for this RestAction instance.Methods inherited from interface net.dv8tion.jda.api.requests.restaction.AuditableRestAction
reasonMethods 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
-
Method Details
-
setCheck
Description copied from interface:AuditableRestActionSets the last-second checks before finally executing the http request in the queue.
If the provided supplier evaluates tofalseor 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:
setCheckin interfaceAuditableRestAction<Webhook>- Specified by:
setCheckin interfaceRestAction<Webhook>- Parameters:
checks- The checks to run before executing the request, ornullto run no checks- Returns:
- The current RestAction for chaining convenience
- See Also:
-
timeout
Description copied from interface:AuditableRestActionTimeout 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 asdeadline(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:
timeoutin interfaceAuditableRestAction<Webhook>- Specified by:
timeoutin interfaceRestAction<Webhook>- Parameters:
timeout- The timeout to useunit-Unitfor the timeout value- Returns:
- The same RestAction instance with the applied timeout
- See Also:
-
deadline
Description copied from interface:AuditableRestActionSimilar toRestAction.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 aTimeoutException.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:
deadlinein interfaceAuditableRestAction<Webhook>- Specified by:
deadlinein interfaceRestAction<Webhook>- Parameters:
timestamp- Millisecond timestamp at which the request will timeout- Returns:
- The same RestAction with the applied deadline
- See Also:
-
getChannel
Thechannelto create this webhook in.- Returns:
- The channel
-
getGuild
TheGuildto create this webhook in- Returns:
- The guild
-
setName
Sets the Name for the custom Webhook User- Parameters:
name- A not-null String name for the new Webhook user.- Returns:
- The current WebhookAction for chaining convenience.
- Throws:
IllegalArgumentException- If the specified name is not in the range of 2-100.
-
setAvatar
Sets the Avatar for the custom Webhook User- Parameters:
icon- AnIconfor the new avatar. Or null to use default avatar.- Returns:
- The current WebhookAction for chaining convenience.
-