Interface IPagingCursorbasedRequestBuilder<T, A, BT extends IRequest.Builder<PagingCursorbased<T>, ?>>

Type Parameters:

T - the type of objects contained in the paging result

A - the type of the cursor/after parameter

BT - the specific builder type extending this interface

All Superinterfaces:

IRequest.Builder<PagingCursorbased<T>, BT>

All Known Implementing Classes:

AbstractDataPagingCursorbasedRequest.Builder, GetFollowedArtistsRequest.Builder, GetRecentlyPlayedTracksRequest.Builder

public interface IPagingCursorbasedRequestBuilder<T, A, BT extends IRequest.Builder<PagingCursorbased<T>, ?>>
extends IRequest.Builder<PagingCursorbased<T>, BT>

Interface for request builders that support cursor-based paging functionality.

Method Summary

Modifier and Type	Method	Description
BT	after(A after)	Sets the cursor position to start returning results from.
BT	limit(Integer limit)	Sets the maximum number of items to return in the response.

Methods inherited from interface IRequest.Builder

build, setBody, setBodyParameter, setContentType, setDefaults, setHeader, setHost, setHttpManager, setPath, setPathParameter, setPort, setQueryParameter, setScheme

Modifier and Type	Method	Description
IRequest<PagingCursorbased<T>>	build()	Build the request.
BT	setBody(org.apache.hc.core5.http.HttpEntity httpEntity)	Set the body for the request.
<ST> BT	setBodyParameter(String name, ST value)	Set a body parameter for the request.
BT	setContentType(org.apache.hc.core5.http.ContentType contentType)	Set the content type for the request.
BT	setDefaults(IHttpManager httpManager, String scheme, String host, Integer port)	Set default values for the request.
<ST> BT	setHeader(String name, ST value)	Set a header for the request.
BT	setHost(String host)	Set the host for the request.
BT	setHttpManager(IHttpManager httpManager)	Set the HTTP manager for the request.
BT	setPath(String path)	Set the path for the request.
BT	setPathParameter(String name, String value)	Set a path parameter for the request.
BT	setPort(Integer port)	Set the port for the request.
<ST> BT	setQueryParameter(String name, ST value)	Set a query parameter for the request.
BT	setScheme(String scheme)	Set the scheme for the request.

Method Details

limit

BT limit(Integer limit)

Sets the maximum number of items to return in the response.

Parameters:

limit - the maximum number of items to return

Returns:

this builder instance for method chaining

after

BT after(A after)

Sets the cursor position to start returning results from.

Parameters:

after - the cursor value to start returning results after

Returns:

this builder instance for method chaining