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

Class GetListUsersPlaylistsRequest

java.lang.Object

de.sonallux.spotify.api.apis.playlists.GetListUsersPlaylistsRequest

public class GetListUsersPlaylistsRequest
extends Object

Get a List of a 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.

Constructor Summary

Constructors

Constructor	Description
GetListUsersPlaylistsRequest(ApiClient apiClient, String userId)	Get a List of a User's Playlists request

Method Summary

Modifier and Type	Method	Description
ApiCall<Paging<SimplifiedPlaylist>>	build()	Build the request into an executable call
GetListUsersPlaylistsRequest	limit(int limit)	The maximum number of playlists to return.
GetListUsersPlaylistsRequest	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

GetListUsersPlaylistsRequest

public GetListUsersPlaylistsRequest(ApiClient apiClient,
                                    String userId)

Get a List of a User's Playlists request

Parameters:

apiClient -

The API client

userId -

The user's Spotify user ID.

Method Detail

limit

public GetListUsersPlaylistsRequest limit(int limit)

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

offset

public GetListUsersPlaylistsRequest 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