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

Interface ScheduledEventMembersPaginationAction

All Superinterfaces:

Iterable<Member>, PaginationAction<Member,ScheduledEventMembersPaginationAction>, RestAction<List<Member>>

public interface ScheduledEventMembersPaginationAction
extends PaginationAction<Member,ScheduledEventMembersPaginationAction>

PaginationAction that paginates the scheduled event users 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.

Limits:
Minimum - 1
Maximum - 100

Example

 // Get every member interested in this event and add the members names to a list
 public static void getInterestedMembers(ScheduledEvent event) {
      // get paginator
      ScheduledEventMembersPaginationAction members = event.retrieveInterestedMembers();
      // add the name of every interested member to a list
      ArrayList<String> memberNames = new ArrayList();
      members.forEachAsync(member -> memberNames.add(member.getEffectiveName()));
 }
 

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 ScheduledEventMembersPaginationAction.

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 ScheduledEventMembersPaginationAction.

Returns:

The never-null target Guild