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 User's Playlists request

Required OAuth scopes

playlist-read-private, playlist-read-collaborative

Response

A paged set of playlists

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ApiCall<Paging<SimplifiedPlaylist>>	build()	Build the request into an executable api call
GetListUsersPlaylistsRequest	limit(int limit)
GetListUsersPlaylistsRequest	offset(int offset)

Methods inherited from class java.lang.Object

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

Constructor Details

GetListUsersPlaylistsRequest

public GetListUsersPlaylistsRequest(ApiClient apiClient,
 String userId)

Get User's Playlists request

Parameters:

apiClient -

The API client

userId -

The user's Spotify user ID.

Method Details

limit

public GetListUsersPlaylistsRequest limit(int limit)

Parameters:

limit -

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

Returns:

this request

offset

public GetListUsersPlaylistsRequest offset(int offset)

Parameters:

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.

Returns:

this request

build

public ApiCall<Paging<SimplifiedPlaylist>> build()

Build the request into an executable api call

Returns:

an executable api call