Package se.michaelthelin.spotify.requests.data.playlists

Class GetListOfUsersPlaylistsRequest.Builder

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<T,BT>

se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<Paging<T>,BT>

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

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

All Implemented Interfaces:

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

Enclosing class:

GetListOfUsersPlaylistsRequest

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

Builder class for building a GetListOfUsersPlaylistsRequest.

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class se.michaelthelin.spotify.requests.AbstractRequest.Builder

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface se.michaelthelin.spotify.requests.IRequest.Builder

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

Constructor Detail

Builder

public Builder(String accessToken)

Create a new GetListOfUsersPlaylistsRequest.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 Detail

user_id

public GetListOfUsersPlaylistsRequest.Builder user_id(String user_id)

The user ID setter.

Parameters:

user_id - The user's Spotify user ID.

Returns:

A GetListOfUsersPlaylistsRequest.Builder.

See Also:

Spotify: URIs & IDs

limit

public GetListOfUsersPlaylistsRequest.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 GetListOfUsersPlaylistsRequest.Builder.

offset

public GetListOfUsersPlaylistsRequest.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 GetListOfUsersPlaylistsRequest.Builder.

build

public GetListOfUsersPlaylistsRequest build()

The request build method.

Returns:

A custom GetListOfUsersPlaylistsRequest.

self

protected GetListOfUsersPlaylistsRequest.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>,GetListOfUsersPlaylistsRequest.Builder>

Returns:

This instance.