Class AuditableRestAction<T>
- java.lang.Object
-
- net.dv8tion.jda.core.requests.RestAction<T>
-
- net.dv8tion.jda.core.requests.restaction.AuditableRestAction<T>
-
- Type Parameters:
T
- The return type
- Direct Known Subclasses:
AuditableRestAction.EmptyRestAction
,ChannelAction
,InviteAction
,net.dv8tion.jda.core.managers.impl.ManagerBase
,PermissionOverrideAction
,RoleAction
,WebhookAction
public abstract class 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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AuditableRestAction.EmptyRestAction<T>
Specialized form ofAuditableRestAction
that is used to provide information that has already been retrieved or generated so that another request does not need to be made to Discord.
-
Field Summary
-
Fields inherited from class net.dv8tion.jda.core.requests.RestAction
DEFAULT_FAILURE, DEFAULT_SUCCESS, LOG
-
-
Constructor Summary
Constructors Constructor Description AuditableRestAction(JDA api, net.dv8tion.jda.core.requests.Route.CompiledRoute route)
AuditableRestAction(JDA api, net.dv8tion.jda.core.requests.Route.CompiledRoute route, okhttp3.RequestBody data)
AuditableRestAction(JDA api, net.dv8tion.jda.core.requests.Route.CompiledRoute route, org.json.JSONObject data)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AuditableRestAction<T>
reason(java.lang.String reason)
Applies the specified reason as audit-log reason field.AuditableRestAction<T>
setCheck(java.util.function.BooleanSupplier checks)
Sets the last-second checks before finally executing the http request in the queue.-
Methods inherited from class net.dv8tion.jda.core.requests.RestAction
complete, complete, completeAfter, getJDA, isPassContext, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, setPassContext, submit, submit, submitAfter, submitAfter
-
-
-
-
Constructor Detail
-
AuditableRestAction
public AuditableRestAction(JDA api, net.dv8tion.jda.core.requests.Route.CompiledRoute route)
-
AuditableRestAction
public AuditableRestAction(JDA api, net.dv8tion.jda.core.requests.Route.CompiledRoute route, okhttp3.RequestBody data)
-
AuditableRestAction
public AuditableRestAction(JDA api, net.dv8tion.jda.core.requests.Route.CompiledRoute route, org.json.JSONObject data)
-
-
Method Detail
-
setCheck
public AuditableRestAction<T> setCheck(java.util.function.BooleanSupplier checks)
Description copied from class:RestAction
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.- Overrides:
setCheck
in classRestAction<T>
- Parameters:
checks
- The checks to run before executing the request, ornull
to run no checks- Returns:
- The current RestAction for chaining convenience
-
reason
@CheckReturnValue public AuditableRestAction<T> reason(java.lang.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.getAuditLogs()
!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.GuildController.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
-
-