Interface AuditableRestAction<T>
-
- Type Parameters:
T
- The return type
- All Superinterfaces:
RestAction<T>
- All Known Subinterfaces:
AccountManager
,ChannelAction<T>
,ChannelManager
,EmoteManager
,GuildManager
,InviteAction
,Manager<M>
,PermissionOverrideAction
,PermOverrideManager
,RoleAction
,RoleManager
,WebhookAction
,WebhookManager
public interface AuditableRestAction<T> extends RestAction<T>
Extension of RestAction to allow setting a reason, only available to accounts ofAccountType.BOT
This will automatically use the
ThreadLocalReason
if no reason was specified viareason(String)
.- Since:
- 3.3.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AuditableRestAction<T>
reason(String reason)
Applies the specified reason as audit-log reason field.AuditableRestAction<T>
setCheck(BooleanSupplier checks)
Sets the last-second checks before finally executing the http request in the queue.-
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
-
reason
@Nonnull AuditableRestAction<T> reason(@Nullable String reason)
Applies the specified reason as audit-log reason field.
When the provided reason is empty ornull
it will be treated as not set.Reasons for any AuditableRestAction may be retrieved via
AuditLogEntry.getReason()
in iterableAuditLogPaginationActions
fromGuild.retrieveAuditLogs()
!This will specify the reason via the
X-Audit-Log-Reason
Request Header.
Note: This may not be available to accounts forAccountType.CLIENT
.
Using methods with a reason parameter will always work and override this header. (ct.Guild.ban(User, int, String)
)- Parameters:
reason
- The reason for this action which should be logged in the Guild's AuditLogs- Returns:
- The current AuditableRestAction instance for chaining convenience
- See Also:
ThreadLocalReason
-
setCheck
@Nonnull AuditableRestAction<T> setCheck(@Nullable BooleanSupplier checks)
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 interfaceRestAction<T>
- Parameters:
checks
- The checks to run before executing the request, ornull
to run no checks- Returns:
- The current RestAction for chaining convenience
-
-