Interface IPagingRequestBuilder<T, BT extends IRequest.Builder<Paging<T>, ?>>

Type Parameters:

T - the type of objects contained in the paging result

BT - the specific builder type extending this interface

All Superinterfaces:

IRequest.Builder<Paging<T>, BT>

All Known Implementing Classes:

AbstractDataPagingRequest.Builder, GetAlbumTracksRequest.Builder, GetArtistsAlbumsRequest.Builder, GetAudiobookChaptersRequest.Builder, GetCategoryPlaylistsRequest.Builder, GetCurrentUsersPlaylistsRequest.Builder, GetNewReleasesRequest.Builder, GetPlaylistItemsDeprecatedRequest.Builder, GetPlaylistItemsRequest.Builder, GetSeveralBrowseCategoriesRequest.Builder, GetShowEpisodesRequest.Builder, GetUsersPlaylistsRequest.Builder, GetUsersSavedAlbumsRequest.Builder, GetUsersSavedAudiobooksRequest.Builder, GetUsersSavedEpisodesRequest.Builder, GetUsersSavedShowsRequest.Builder, GetUsersSavedTracksRequest.Builder, GetUsersTopArtistsAndTracksRequest.Builder, GetUsersTopArtistsRequest.Builder, GetUsersTopTracksRequest.Builder, SearchAlbumsRequest.Builder, SearchAlbumsSpecialRequest.Builder, SearchArtistsRequest.Builder, SearchAudiobooksRequest.Builder, SearchEpisodesRequest.Builder, SearchPlaylistsRequest.Builder, SearchShowsRequest.Builder, SearchTracksRequest.Builder

public interface IPagingRequestBuilder<T, BT extends IRequest.Builder<Paging<T>, ?>>
extends IRequest.Builder<Paging<T>, BT>

Interface for request builders that support paging functionality.

Method Summary

Modifier and Type	Method	Description
BT	limit(Integer limit)	Sets the maximum number of items to return in the response.
BT	offset(Integer offset)	Sets the index of the first item to return.

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<Paging<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 (1-50)

Returns:

this builder instance for method chaining

offset

BT offset(Integer offset)

Sets the index of the first item to return.

Parameters:

offset - the offset index (0-based)

Returns:

this builder instance for method chaining