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

Class EntitlementPaginationActionImpl

java.lang.Object

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

net.dv8tion.jda.internal.requests.restaction.pagination.PaginationActionImpl<Entitlement,EntitlementPaginationAction>

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

All Implemented Interfaces:

Iterable<Entitlement>, RestAction<@Unmodifiable List<Entitlement>>, EntitlementPaginationAction, PaginationAction<Entitlement,EntitlementPaginationAction>

public class EntitlementPaginationActionImpl
extends PaginationActionImpl<Entitlement,EntitlementPaginationAction>
implements EntitlementPaginationAction

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
EntitlementPaginationActionImpl(JDA api)

Method Summary

Modifier and Type	Method	Description
EntitlementPaginationAction	excludeEnded(boolean excludeEnded)	Whether to exclude subscriptions which have gone past their end date.
EnumSet<PaginationAction.PaginationOrder>	getSupportedOrders()	The supported PaginationOrders for this pagination action.
EntitlementPaginationAction	guild(long guildId)	Filters Entitlements by a guild id
EntitlementPaginationAction	skuIds(long... skuIds)	Filters Entitlements by their SKU id
EntitlementPaginationAction	skuIds(String... skuIds)	Filters Entitlements by their SKU id
EntitlementPaginationAction	skuIds(Collection<String> skuIds)	Filters Entitlements by their SKU id
EntitlementPaginationAction	user(UserSnowflake user)	Filter Entitlements to retrieve by the given user ID

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 net.dv8tion.jda.api.requests.restaction.pagination.EntitlementPaginationAction

guild, guild

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

EntitlementPaginationActionImpl

public EntitlementPaginationActionImpl(JDA api)

Method Details

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

Returns:

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

user

@Nonnull
public EntitlementPaginationAction user(@Nullable
 UserSnowflake user)

Description copied from interface: EntitlementPaginationAction

Filter Entitlements to retrieve by the given user ID

Specified by:

user in interface EntitlementPaginationAction

Parameters:

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

Returns:

The current EntitlementPaginationAction for chaining convenience

skuIds

@Nonnull
public EntitlementPaginationAction skuIds(long... skuIds)

Description copied from interface: EntitlementPaginationAction

Filters Entitlements by their SKU id

Specified by:

skuIds in interface EntitlementPaginationAction

Parameters:

skuIds - The SKU ids to filter by

Returns:

The current EntitlementPaginationAction for chaining convenience

skuIds

@Nonnull
public EntitlementPaginationAction skuIds(@Nonnull
 String... skuIds)

Description copied from interface: EntitlementPaginationAction

Filters Entitlements by their SKU id

Specified by:

skuIds in interface EntitlementPaginationAction

Parameters:

skuIds - The SKU ids to filter by

Returns:

The current EntitlementPaginationAction for chaining convenience

skuIds

@Nonnull
public EntitlementPaginationAction skuIds(@Nonnull
 Collection<String> skuIds)

Description copied from interface: EntitlementPaginationAction

Filters Entitlements by their SKU id

Specified by:

skuIds in interface EntitlementPaginationAction

Parameters:

skuIds - The SKU ids to filter by

Returns:

The current EntitlementPaginationAction for chaining convenience

guild

@Nonnull
public EntitlementPaginationAction guild(long guildId)

Description copied from interface: EntitlementPaginationAction

Filters Entitlements by a guild id

Specified by:

guild in interface EntitlementPaginationAction

Parameters:

guildId - The guild id to filter by

Returns:

The current EntitlementPaginationAction for chaining convenience

excludeEnded

@Nonnull
public EntitlementPaginationAction excludeEnded(boolean excludeEnded)

Description copied from interface: EntitlementPaginationAction

Whether to exclude subscriptions which have gone past their end date.

Test entitlements which are created through the API do not have an end date.

Specified by:

excludeEnded in interface EntitlementPaginationAction

Parameters:

excludeEnded - Whether to exclude ended subscriptions from returned Entitlements

Returns:

The current EntitlementPaginationAction for chaining convenience