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

Class GetFeaturedPlaylistsRequest

java.lang.Object
de.sonallux.spotify.api.apis.playlists.GetFeaturedPlaylistsRequest
public class GetFeaturedPlaylistsRequest extends Object

Get Featured Playlists request

Response

A paged set of playlists

  • Constructor Details

    • GetFeaturedPlaylistsRequest

      public GetFeaturedPlaylistsRequest(ApiClient apiClient)
      Get Featured Playlists request
      Parameters:
      apiClient -

      The API client

  • Method Details

    • country

      public GetFeaturedPlaylistsRequest country(String country)
      Parameters:
      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.

      Returns:
      this request

    • locale

      public GetFeaturedPlaylistsRequest locale(String locale)
      Parameters:
      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: 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.

      Returns:
      this request

    • timestamp

      public GetFeaturedPlaylistsRequest timestamp(String timestamp)
      Parameters:
      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.

      Returns:
      this request

    • limit

      public GetFeaturedPlaylistsRequest limit(int limit)
      Parameters:
      limit -

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

      Returns:
      this request

    • offset

      public GetFeaturedPlaylistsRequest offset(int offset)
      Parameters:
      offset -

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

      Returns:
      this request

    • build

      public ApiCall<PagingFeaturedPlaylist> build()
      Build the request into an executable api call
      Returns:
      an executable api call