Package de.jsone_studios.wrapper.spotify.services

Interface AlbumsSpotifyService

public interface AlbumsSpotifyService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Album>	getAlbum(String albumId)	Get Spotify catalog information for a single album.
retrofit2.Call<Album>	getAlbum(String albumId, Map<String,Object> options)	Get Spotify catalog information for a single album.
retrofit2.Call<Albums>	getAlbums(String albumIds)	Get Spotify catalog information for multiple albums identified by their Spotify IDs.
retrofit2.Call<Albums>	getAlbums(String albumIds, Map<String,Object> options)	Get Spotify catalog information for multiple albums identified by their Spotify IDs.
retrofit2.Call<Pager<Track>>	getAlbumTracks(String albumId)	Get Spotify catalog information about an album’s tracks.
retrofit2.Call<Pager<Track>>	getAlbumTracks(String albumId, Map<String,Object> options)	Get Spotify catalog information about an album’s tracks.

Method Detail

getAlbum

@GET("albums/{id}")
retrofit2.Call<Album> getAlbum(@Path("id")
                               String albumId)

Get Spotify catalog information for a single album.

Parameters:

albumId - The Spotify ID for the album.

Returns:

Requested album information

See Also:

Get an Album

getAlbum

@GET("albums/{id}")
retrofit2.Call<Album> getAlbum(@Path("id")
                               String albumId,
                               @QueryMap
                               Map<String,Object> options)

Get Spotify catalog information for a single album.

Parameters:

albumId - The Spotify ID for the album.

options - Optional parameters. For list of supported parameters see endpoint documentation

Returns:

Requested album information

See Also:

Get an Album

getAlbumTracks

@GET("albums/{id}/tracks")
retrofit2.Call<Pager<Track>> getAlbumTracks(@Path("id")
                                            String albumId)

Get Spotify catalog information about an album’s tracks.

Parameters:

albumId - The Spotify ID for the album.

Returns:

List of simplified album objects wrapped in a Pager object

See Also:

Get an Album’s Tracks

getAlbumTracks

@GET("albums/{id}/tracks")
retrofit2.Call<Pager<Track>> getAlbumTracks(@Path("id")
                                            String albumId,
                                            @QueryMap
                                            Map<String,Object> options)

Get Spotify catalog information about an album’s tracks.

Parameters:

albumId - The Spotify ID for the album.

options - Optional parameters. For list of supported parameters see endpoint documentation

Returns:

List of simplified album objects wrapped in a Pager object

See Also:

Get an Album’s Tracks

getAlbums

@GET("albums")
retrofit2.Call<Albums> getAlbums(@Query("ids")
                                 String albumIds)

Get Spotify catalog information for multiple albums identified by their Spotify IDs.

Parameters:

albumIds - A comma-separated list of the Spotify IDs for the albums. Maximum: 20 IDs.

Returns:

Object whose key is "albums" and whose value is an array of album objects.

See Also:

Get Several Albums

getAlbums

@GET("albums")
retrofit2.Call<Albums> getAlbums(@Query("ids")
                                 String albumIds,
                                 @QueryMap
                                 Map<String,Object> options)

Get Spotify catalog information for multiple albums identified by their Spotify IDs.

Parameters:

albumIds - A comma-separated list of the Spotify IDs for the albums. Maximum: 20 IDs.

options - Optional parameters. For list of supported parameters see endpoint documentation

Returns:

Object whose key is "albums" and whose value is an array of album objects.

See Also:

Get Several Albums