Package de.sonallux.spotify.api.apis.categories

Class GetCategoriesRequest

java.lang.Object
de.sonallux.spotify.api.apis.categories.GetCategoriesRequest
public class GetCategoriesRequest extends Object

Get Several Browse Categories request

Response

A paged set of categories

  • Constructor Details

    • GetCategoriesRequest

      public GetCategoriesRequest(ApiClient apiClient)
      Get Several Browse Categories request
      Parameters:
      apiClient -

      The API client

  • Method Details

    • country

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

      Returns:
      this request

    • locale

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

    • limit

      public GetCategoriesRequest limit(int limit)
      Parameters:
      limit -

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

      Returns:
      this request

    • offset

      public GetCategoriesRequest 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<PagedCategories> build()
      Build the request into an executable api call
      Returns:
      an executable api call