Package de.sonallux.spotify.api.apis.artists

Class GetArtistsAlbumsRequest

java.lang.Object

de.sonallux.spotify.api.apis.artists.GetArtistsAlbumsRequest

public class GetArtistsAlbumsRequest
extends Object

Get an Artist's Albums request

Response

On success, the HTTP status code in the response header is 200 OK and the response body contains an array of simplified album 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.

Constructor Summary

Constructors

Constructor	Description
GetArtistsAlbumsRequest(ApiClient apiClient, String id)	Get an Artist's Albums request

Method Summary

Modifier and Type	Method	Description
ApiCall<Paging<SimplifiedAlbum>>	build()	Build the request into an executable call
GetArtistsAlbumsRequest	includeGroups(String includeGroups)	A comma-separated list of keywords that will be used to filter the response.
GetArtistsAlbumsRequest	limit(int limit)	The number of album objects to return.
GetArtistsAlbumsRequest	market(String market)	Synonym for country.
GetArtistsAlbumsRequest	offset(int offset)	The index of the first album to return.

Methods inherited from class java.lang.Object

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

Constructor Detail

GetArtistsAlbumsRequest

public GetArtistsAlbumsRequest(ApiClient apiClient,
                               String id)

Get an Artist's Albums request

Parameters:

apiClient -

The API client

id -

The Spotify ID for the artist.

Method Detail

includeGroups

public GetArtistsAlbumsRequest includeGroups(String includeGroups)

A comma-separated list of keywords that will be used to filter the response. If not supplied, all album types will be returned. Valid values are:

• album
• single
• appears_on
• compilation
  For example: include_groups=album,single.

market

public GetArtistsAlbumsRequest market(String market)

Synonym for country. An ISO 3166-1 alpha-2 country code or the string from_token.
Supply this parameter to limit the response to one particular geographical market. For example, for albums available in Sweden: market=SE.
If not given, results will be returned for all markets and you are likely to get duplicate results per album, one for each market in which the album is available!

limit

public GetArtistsAlbumsRequest limit(int limit)

The number of album objects to return. Default: 20. Minimum: 1. Maximum: 50. For example: limit=2

offset

public GetArtistsAlbumsRequest offset(int offset)

The index of the first album to return. Default: 0 (i.e., the first album). Use with limit to get the next set of albums.

build

public ApiCall<Paging<SimplifiedAlbum>> build()

Build the request into an executable call