AlbumApi

class AlbumApi(api: GenericSpotifyApi) : SpotifyEndpoint
Content copied to clipboard

Endpoints for retrieving information about one or more albums from the Spotify catalog.

Api Reference

Constructors

AlbumApi
Link copied to clipboard
common
fun AlbumApi(api: GenericSpotifyApi)
Content copied to clipboard

Functions

getAlbum
Link copied to clipboard
common
suspend fun getAlbum(album: String, market: Market? = null): Album?
Content copied to clipboard
Get Spotify catalog information for a single album.
getAlbumRestAction
Link copied to clipboard
common
fun getAlbumRestAction(album: String, market: Market? = null): SpotifyRestAction<Album?>
Content copied to clipboard
Get Spotify catalog information for a single album.
getAlbums
Link copied to clipboard
common
suspend fun getAlbums(vararg albums: String, market: Market? = null): List<Album?>
Content copied to clipboard
Get Spotify catalog information for multiple albums identified by their Spotify IDs.
getAlbumsRestAction
Link copied to clipboard
common
fun getAlbumsRestAction(vararg albums: String, market: Market? = null): SpotifyRestAction<List<Album?>>
Content copied to clipboard
Get Spotify catalog information for multiple albums identified by their Spotify IDs.
getAlbumTracks
Link copied to clipboard
common
suspend fun getAlbumTracks(album: String, limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, market: Market? = null): PagingObject<SimpleTrack>
Content copied to clipboard
Get Spotify catalog information about an album’s tracks.
getAlbumTracksRestAction
Link copied to clipboard
common
fun getAlbumTracksRestAction(album: String, limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, market: Market? = null): SpotifyRestAction<PagingObject<SimpleTrack>>
Content copied to clipboard
Get Spotify catalog information about an album’s tracks.

Properties

api
Link copied to clipboard
common
val api: GenericSpotifyApi
Content copied to clipboard
cache
Link copied to clipboard
common
val cache: SpotifyCache
Content copied to clipboard

Sources

common source
Link copied to clipboard