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

Class AuditLogPaginationActionImpl

java.lang.Object

net.dv8tion.jda.internal.requests.RestActionImpl<List<AuditLogEntry>>

net.dv8tion.jda.internal.requests.restaction.pagination.PaginationActionImpl<AuditLogEntry,AuditLogPaginationAction>

net.dv8tion.jda.internal.requests.restaction.pagination.AuditLogPaginationActionImpl

All Implemented Interfaces:

Iterable<AuditLogEntry>, RestAction<@Unmodifiable List<AuditLogEntry>>, AuditLogPaginationAction, PaginationAction<AuditLogEntry,AuditLogPaginationAction>

public class AuditLogPaginationActionImpl
extends PaginationActionImpl<AuditLogEntry,AuditLogPaginationAction>
implements AuditLogPaginationAction

Nested Class Summary

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

PaginationAction.PaginationIterator<E>, PaginationAction.PaginationOrder

Field Summary

Fields inherited from class net.dv8tion.jda.internal.requests.RestActionImpl

LOG

Constructor Summary

Constructors

Constructor	Description
AuditLogPaginationActionImpl(Guild guild)

Method Summary

Modifier and Type	Method	Description
Guild	getGuild()	The current target Guild for this AuditLogPaginationAction.
EnumSet<PaginationAction.PaginationOrder>	getSupportedOrders()	The supported PaginationOrders for this pagination action.
AuditLogPaginationActionImpl	type(ActionType type)	Filters retrieved entities by the specified ActionType
AuditLogPaginationActionImpl	user(UserSnowflake user)	Filters retrieved entities by the specified UserSnowflake.

Methods inherited from class net.dv8tion.jda.internal.requests.restaction.pagination.PaginationActionImpl

cache, cacheSize, deadline, forEachAsync, forEachRemaining, forEachRemainingAsync, getCached, getFirst, getLast, getLastKey, getLimit, getMaxLimit, getMinLimit, getNextChunk, getOrder, isCacheEnabled, isEmpty, iterator, limit, order, setCheck, skipTo, takeAsync, takeRemainingAsync, timeout

Methods inherited from class net.dv8tion.jda.internal.requests.RestActionImpl

complete, getCheck, getDefaultFailure, getDefaultSuccess, getDefaultTimeout, getJDA, handleResponse, isPassContext, priority, queue, setDefaultFailure, setDefaultSuccess, setDefaultTimeout, setErrorMapper, setPassContext, submit

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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, 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

Constructor Details

AuditLogPaginationActionImpl

public AuditLogPaginationActionImpl(Guild guild)

Method Details

type

@Nonnull
public AuditLogPaginationActionImpl type(ActionType type)

Description copied from interface: AuditLogPaginationAction

Filters retrieved entities by the specified ActionType

Specified by:

type in interface AuditLogPaginationAction

Parameters:

type - ActionType used to filter, or null to remove type filtering

Returns:

The current AuditLogPaginationAction for chaining convenience

user

@Nonnull
public AuditLogPaginationActionImpl user(UserSnowflake user)

Description copied from interface: AuditLogPaginationAction

Filters retrieved entities by the specified UserSnowflake.
This specified the action issuer and not the target of an action. (Targets need not be users)

Specified by:

user in interface AuditLogPaginationAction

Parameters:

user - The UserSnowflake used to filter or null to remove user filtering. This can be a member or user instance or User.fromId(long).

Returns:

The current AuditLogPaginationAction for chaining convenience

getGuild

@Nonnull
public Guild getGuild()

Description copied from interface: AuditLogPaginationAction

The current target Guild for this AuditLogPaginationAction.

Specified by:

getGuild in interface AuditLogPaginationAction

Returns:

The never-null target Guild

getSupportedOrders

@Nonnull
public EnumSet<PaginationAction.PaginationOrder> getSupportedOrders()

Description copied from interface: PaginationAction

The supported PaginationOrders for this pagination action.
All enum values that are not returned will cause a throw for PaginationAction.order(PaginationOrder).

Most pagination endpoints only support a single order, however some endpoints such as message pagination supports both.

Specified by:

getSupportedOrders in interface PaginationAction<AuditLogEntry,AuditLogPaginationAction>

Returns:

EnumSet of PaginationAction.PaginationOrder (Modifying this set does not affect this class)