spotify-api-kotlin/com.adamratzman.spotify.endpoints.pub/PlaylistApi

PlaylistApi

open class PlaylistApi(val api: GenericSpotifyApi) : SpotifyEndpoint(source)

Endpoints for retrieving information about a user’s playlists

Api Reference

Inheritors

ClientPlaylistApi

Constructors

constructor(api: GenericSpotifyApi)

Properties

val api: GenericSpotifyApi

val cache: SpotifyCache

Functions

suspend fun getPlaylist(playlist: String, market: Market? = null): Playlist?

Get a playlist owned by a Spotify user.

getPlaylistCovers

suspend fun getPlaylistCovers(playlist: String): List<SpotifyImage>

Get the current image(s) associated with a specific playlist.

getPlaylistTracks

suspend fun getPlaylistTracks(playlist: String, limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, market: Market? = null): PagingObject<PlaylistTrack>

Get full details of the tracks of a playlist owned by a Spotify user.

getUserPlaylists

suspend fun getUserPlaylists(user: String, limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null): PagingObject<SimplePlaylist>

Get a list of the playlists owned or followed by a Spotify user. Lookups for non-existant users return an empty PagingObject (blame Spotify)