Class AuditableRestAction<T>

    • 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 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.
        Overrides:
        setCheck in class RestAction<T>
        Parameters:
        checks - The checks to run before executing the request, or null 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 or null it will be treated as not set.

        Reasons for any AuditableRestAction may be retrieved via AuditLogEntry.getReason() in iterable AuditLogPaginationActions from Guild.getAuditLogs()!

        This will specify the reason via the X-Audit-Log-Reason Request Header.
        Note: This may not be available to accounts for AccountType.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