list method

Pages<Category> list({
  1. Market? country,
  2. String? locale,
})

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 - 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.

Implementation

Pages<Category> list({Market? country, String? locale}) {
  final query = _buildQuery({'country': country?.name, 'locale': locale});

  return _getPages(
    '$_path?$query',
    (json) => Category.fromJson(json),
    'categories',
    (json) => Category.fromJson(json),
  );
}