Package net.dv8tion.jda.api.requests.restaction.pagination

Interface BanPaginationAction

All Superinterfaces:

Iterable<Guild.Ban>, PaginationAction<Guild.Ban,BanPaginationAction>, RestAction<@Unmodifiable List<Guild.Ban>>

public interface BanPaginationAction
extends PaginationAction<Guild.Ban,BanPaginationAction>

PaginationAction that paginates the guild bans endpoint.
Note that this implementation is not considered thread-safe as modifications to the cache are not done with a lock. Calling methods on this class from multiple threads is not recommended.

Must provide not-null Guild to compile a valid pagination route.

Limits:
Minimum - 1
Maximum - 1000

Example

 // Revoke all bans from a guild with a certain reason
 public static void findBansWithReason(Guild guild, String reason) {
     BanPaginationAction bans = guild.retrieveBanList();
     bans.forEachAsync((ban) -> {
         if (reason.equals(ban.getReason())) {
             guild.unban(ban.getUser()).queue();
         }
         return true; // continues iterating if this returns true
     });
 }
 

See Also:

• Guild.retrieveBanList()
• Guild.retrieveBan(net.dv8tion.jda.api.entities.UserSnowflake)

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.requests.restaction.pagination.PaginationAction

PaginationAction.PaginationIterator<E>, PaginationAction.PaginationOrder

Method Summary

Modifier and Type	Method	Description
Guild	getGuild()	The current target Guild for this BanPaginationAction.

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface net.dv8tion.jda.api.requests.restaction.pagination.PaginationAction

cache, cacheSize, deadline, forEachAsync, forEachAsync, forEachRemaining, forEachRemainingAsync, forEachRemainingAsync, getCached, getFirst, getLast, getLastKey, getLimit, getMaxLimit, getMinLimit, getOrder, getSupportedOrders, isCacheEnabled, isEmpty, iterator, limit, order, parallelStream, reverse, setCheck, skipTo, spliterator, stream, takeAsync, takeRemainingAsync, takeUntilAsync, takeUntilAsync, takeWhileAsync, takeWhileAsync, timeout

Methods 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

getGuild

@Nonnull
Guild getGuild()

The current target Guild for this BanPaginationAction.

Returns:

The never-null target Guild