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

Class GetCategoriesRequest

java.lang.Object

de.sonallux.spotify.api.apis.browse.GetCategoriesRequest

public class GetCategoriesRequest
extends Object

Get All Categories request

Response

On success, the HTTP status code in the response header is 200 OK and the response body contains an object with a categories field, with an array of category 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 Category to drill down further.

Constructor Summary

Constructors

Constructor	Description
GetCategoriesRequest(ApiClient apiClient)	Get All Categories request

Method Summary

Modifier and Type	Method	Description
ApiCall<Categories>	build()	Build the request into an executable call
GetCategoriesRequest	country(String country)	A country: an ISO 3166-1 alpha-2 country code.
GetCategoriesRequest	limit(int limit)	The maximum number of categories to return.
GetCategoriesRequest	locale(String locale)	The desired language, consisting of an ISO 639-1 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore.
GetCategoriesRequest	offset(int offset)	The index of the first item to return.

Methods inherited from class java.lang.Object

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

Constructor Detail

GetCategoriesRequest

public GetCategoriesRequest(ApiClient apiClient)

Get All Categories request

Parameters:

apiClient -

The API client

Method Detail

country

public GetCategoriesRequest country(String country)

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

locale

public GetCategoriesRequest locale(String locale)

The desired language, consisting of an ISO 639-1 language code and an 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 category metadata returned in a particular language. 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.

limit

public GetCategoriesRequest limit(int limit)

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

offset

public GetCategoriesRequest 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 categories.

build

public ApiCall<Categories> build()

Build the request into an executable call