Package de.sonallux.spotify.api.apis.playlists

Class GetListOfCurrentUsersPlaylistsRequest

java.lang.Object

de.sonallux.spotify.api.apis.playlists.GetListOfCurrentUsersPlaylistsRequest

public class GetListOfCurrentUsersPlaylistsRequest
extends Object

Get a List of Current User's Playlists request

Required OAuth scopes

playlist-read-private, playlist-read-collaborative

Response

On success, the HTTP status code in the response header is 200 OK and the response body contains an array of simplified playlist objects (wrapped in a paging object) in JSON format. On error, the header status code is an error code and the response body contains an error object. Please note that the access token has to be tied to a user.

Constructor Summary

Constructors

Constructor	Description
GetListOfCurrentUsersPlaylistsRequest(ApiClient apiClient)	Get a List of Current User's Playlists request

Method Summary

Modifier and Type	Method	Description
ApiCall<Paging<SimplifiedPlaylist>>	build()	Build the request into an executable call
GetListOfCurrentUsersPlaylistsRequest	limit(int limit)	'The maximum number of playlists to return.
GetListOfCurrentUsersPlaylistsRequest	offset(int offset)	'The index of the first playlist to return.

Methods inherited from class java.lang.Object

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

Constructor Detail

GetListOfCurrentUsersPlaylistsRequest

public GetListOfCurrentUsersPlaylistsRequest(ApiClient apiClient)

Get a List of Current User's Playlists request

Parameters:

apiClient -

The API client

Method Detail

limit

public GetListOfCurrentUsersPlaylistsRequest limit(int limit)

'The maximum number of playlists to return. Default: 20. Minimum: 1. Maximum: 50.'

offset

public GetListOfCurrentUsersPlaylistsRequest offset(int offset)

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

build

public ApiCall<Paging<SimplifiedPlaylist>> build()

Build the request into an executable call