Class GetCurrentUsersPlaylistsRequest.Builder

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<Paging<PlaylistSimplified>, GetCurrentUsersPlaylistsRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<Paging<PlaylistSimplified>, GetCurrentUsersPlaylistsRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataPagingRequest.Builder<PlaylistSimplified, GetCurrentUsersPlaylistsRequest.Builder>

se.michaelthelin.spotify.requests.data.playlists.GetCurrentUsersPlaylistsRequest.Builder

All Implemented Interfaces:

IPagingRequestBuilder<PlaylistSimplified, GetCurrentUsersPlaylistsRequest.Builder>, IRequest.Builder<Paging<PlaylistSimplified>, GetCurrentUsersPlaylistsRequest.Builder>

Enclosing class:

GetCurrentUsersPlaylistsRequest

public static final class GetCurrentUsersPlaylistsRequest.Builder
extends AbstractDataPagingRequest.Builder<PlaylistSimplified, GetCurrentUsersPlaylistsRequest.Builder>

Builder class for building a GetCurrentUsersPlaylistsRequest

Constructor Summary

Constructors

Constructor	Description
Builder(String accessToken)	Create a new GetCurrentUsersPlaylistsRequest.Builder.

Method Summary

Modifier and Type	Method	Description
GetCurrentUsersPlaylistsRequest	build()	The request build method.
GetCurrentUsersPlaylistsRequest.Builder	limit(Integer limit)	The limit setter.
GetCurrentUsersPlaylistsRequest.Builder	offset(Integer offset)	The offset setter.
protected GetCurrentUsersPlaylistsRequest.Builder	self()	Return this instance to simulate a self-type.

Methods inherited from class AbstractRequest.Builder

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

Methods inherited from class Object

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

Methods inherited from interface IRequest.Builder

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

Constructor Details

Builder

public Builder(String accessToken)

Create a new GetCurrentUsersPlaylistsRequest.Builder.

Private playlists are only retrievable for the current user and requires the playlist-read-private scope to have been authorized by the user. Note: This scope alone will not return collaborative playlists, even though they are always private.

Collaborative playlists are only retrievable for the current user and requires the playlist-read-collaborative scope to have been authorized by the user.

Parameters:

accessToken - Required. A valid access token from the Spotify Accounts service.

See Also:

• Spotify: Using Scopes

Method Details

limit

public GetCurrentUsersPlaylistsRequest.Builder limit(Integer limit)

The limit setter.

Parameters:

limit - Optional. The maximum number of playlists to return. Default: 20. Minimum: 1. Maximum: 50.

Returns:

A GetCurrentUsersPlaylistsRequest.Builder.

offset

public GetCurrentUsersPlaylistsRequest.Builder offset(Integer offset)

The offset setter.

Parameters:

offset - Optional. The index of the first playlist to return. Default: 0 (the first object). Maximum offset: 100.000. Use with limit(Integer) to get the next set of playlists.

Returns:

A GetCurrentUsersPlaylistsRequest.Builder.

build

public GetCurrentUsersPlaylistsRequest build()

The request build method.

Returns:

A custom GetCurrentUsersPlaylistsRequest.

self

protected GetCurrentUsersPlaylistsRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<Paging<PlaylistSimplified>, GetCurrentUsersPlaylistsRequest.Builder>

Returns:

This instance.