Interface WebhookAction
-
- All Superinterfaces:
AuditableRestAction<Webhook>
,RestAction<Webhook>
public interface WebhookAction extends AuditableRestAction<Webhook>
Webhook
Builder system created as an extension ofRestAction
Provides an easy way to gather and deliver information to Discord to createWebhooks
.- See Also:
TextChannel.createWebhook(String)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description TextChannel
getChannel()
TheTextChannel
to create this webhook indefault Guild
getGuild()
TheGuild
to create this webhook inWebhookAction
setAvatar(Icon icon)
Sets the Avatar for the custom Webhook UserWebhookAction
setCheck(BooleanSupplier checks)
Sets the last-second checks before finally executing the http request in the queue.WebhookAction
setName(String name)
Sets the Name for the custom Webhook User-
Methods inherited from interface net.dv8tion.jda.api.requests.restaction.AuditableRestAction
reason
-
Methods inherited from interface net.dv8tion.jda.api.requests.RestAction
complete, complete, completeAfter, getJDA, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, submit, submit, submitAfter, submitAfter
-
-
-
-
Method Detail
-
setCheck
@Nonnull WebhookAction setCheck(@Nullable BooleanSupplier checks)
Description copied from interface:AuditableRestAction
Sets the last-second checks before finally executing the http request in the queue.
If the provided supplier evaluates tofalse
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 interfaceAuditableRestAction<Webhook>
- Specified by:
setCheck
in interfaceRestAction<Webhook>
- Parameters:
checks
- The checks to run before executing the request, ornull
to run no checks- Returns:
- The current RestAction for chaining convenience
-
getChannel
@Nonnull TextChannel getChannel()
TheTextChannel
to create this webhook in- Returns:
- The channel
-
setName
@Nonnull @CheckReturnValue WebhookAction setName(@Nonnull String name)
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
@Nonnull @CheckReturnValue WebhookAction setAvatar(@Nullable Icon icon)
Sets the Avatar for the custom Webhook User- Parameters:
icon
- AnIcon
for the new avatar. Or null to use default avatar.- Returns:
- The current WebhookAction for chaining convenience.
-
-