Package de.sonallux.spotify.api.apis.browse

Class GetFeaturedPlaylistsRequest

java.lang.Object

de.sonallux.spotify.api.apis.browse.GetFeaturedPlaylistsRequest

public class GetFeaturedPlaylistsRequest
extends Object

Get All Featured Playlists request

Response

On success, the HTTP status code in the response header is 200 OK and the response body contains a message and a playlists object. The playlists object 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.

Once you have retrieved the list of playlist objects, you can use Get a Playlist and Get a Playlist's Tracks to drill down further.

Constructor Summary

Constructors

Constructor	Description
GetFeaturedPlaylistsRequest(ApiClient apiClient)	Get All Featured Playlists request

Method Summary

Modifier and Type	Method	Description
ApiCall<FeaturedPlaylist>	build()	Build the request into an executable call
GetFeaturedPlaylistsRequest	country(String country)	A country: an ISO 3166-1 alpha-2 country code.
GetFeaturedPlaylistsRequest	limit(int limit)	The maximum number of items to return.
GetFeaturedPlaylistsRequest	locale(String locale)	The desired language, consisting of a lowercase ISO 639-1 language code and an uppercase ISO 3166-1 alpha-2 country code, joined by an underscore.
GetFeaturedPlaylistsRequest	offset(int offset)	The index of the first item to return.
GetFeaturedPlaylistsRequest	timestamp(String timestamp)	A timestamp in ISO 8601 format: yyyy-MM-ddTHH:mm:ss.

Methods inherited from class java.lang.Object

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

Constructor Detail

GetFeaturedPlaylistsRequest

public GetFeaturedPlaylistsRequest(ApiClient apiClient)

Get All Featured Playlists request

Parameters:

apiClient -

The API client

Method Detail

country

public GetFeaturedPlaylistsRequest country(String country)

A country: an ISO 3166-1 alpha-2 country code. Provide this parameter if you want the list of returned items to be relevant to a particular country. If omitted, the returned items will be relevant to all countries.

locale

public GetFeaturedPlaylistsRequest locale(String locale)

The desired language, consisting of a lowercase ISO 639-1 language code and an uppercase ISO 3166-1 alpha-2 country code, joined by an underscore. For example: es_MX, meaning "Spanish (Mexico)". Provide this parameter if you want the results returned in a particular language (where available). Note that, if locale is not supplied, or if the specified language is not available, all strings will be returned in the Spotify default language (American English). The locale parameter, combined with the country parameter, may give odd results if not carefully matched. For example country=SE&locale=de_DE will return a list of categories relevant to Sweden but as German language strings.

timestamp

public GetFeaturedPlaylistsRequest timestamp(String timestamp)

A timestamp in ISO 8601 format: yyyy-MM-ddTHH:mm:ss. Use this parameter to specify the user's local time to get results tailored for that specific date and time in the day. If not provided, the response defaults to the current UTC time. Example: "2014-10-23T09:00:00" for a user whose local time is 9AM. If there were no featured playlists (or there is no data) at the specified time, the response will revert to the current UTC time.

limit

public GetFeaturedPlaylistsRequest limit(int limit)

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

offset

public GetFeaturedPlaylistsRequest offset(int offset)

The index of the first item to return. Default: 0 (the first object). Use with limit to get the next set of items.

build

public ApiCall<FeaturedPlaylist> build()

Build the request into an executable call