Class GetCategoriesPlaylistsRequest
- java.lang.Object
-
- de.sonallux.spotify.api.apis.browse.GetCategoriesPlaylistsRequest
-
public class GetCategoriesPlaylistsRequest extends Object
Get a Category's Playlists requestResponse
On success, the HTTP status code in the response header is
200OK 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.Once you have retrieved the list, you can use Get a Playlist and Get a Playlist's Tracks to drill down further.
-
-
Constructor Summary
Constructors Constructor Description GetCategoriesPlaylistsRequest(ApiClient apiClient, String categoryId)Get a Category's Playlists request
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ApiCall<PlaylistPaging>build()Build the request into an executable callGetCategoriesPlaylistsRequestcountry(String country)A country: an ISO 3166-1 alpha-2 country code.GetCategoriesPlaylistsRequestlimit(int limit)The maximum number of items to return.GetCategoriesPlaylistsRequestoffset(int offset)The index of the first item to return.
-
-
-
Constructor Detail
-
GetCategoriesPlaylistsRequest
public GetCategoriesPlaylistsRequest(ApiClient apiClient, String categoryId)
Get a Category's Playlists request
- Parameters:
apiClient-The API client
categoryId-The Spotify category ID for the category.
-
-
Method Detail
-
country
public GetCategoriesPlaylistsRequest country(String country)
A country: an ISO 3166-1 alpha-2 country code. Provide this parameter to ensure that the category exists for a particular country.
-
limit
public GetCategoriesPlaylistsRequest limit(int limit)
The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
-
offset
public GetCategoriesPlaylistsRequest offset(int offset)
The index of the first item to return. Default: 0 (the first object). Use with
limitto get the next set of items.
-
build
public ApiCall<PlaylistPaging> build()
Build the request into an executable call
-
-