PlaylistApi

open class PlaylistApi(api: GenericSpotifyApi) : SpotifyEndpoint

Endpoints for retrieving information about a user’s playlists

Api Reference

Constructors

PlaylistApi

common

fun PlaylistApi(api: GenericSpotifyApi)

Functions

getPlaylist

common

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

Get a playlist owned by a Spotify user.

getPlaylistCovers

common

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

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

getPlaylistCoversRestAction

common

fun getPlaylistCoversRestAction(playlist: String): SpotifyRestAction<List<SpotifyImage>>

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

getPlaylistRestAction

common

fun getPlaylistRestAction(playlist: String, market: Market? = null): SpotifyRestAction<Playlist?>

Get a playlist owned by a Spotify user.

getPlaylistTracks

common

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.

getPlaylistTracksRestAction

common

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

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

getUserPlaylists

common

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.

getUserPlaylistsRestAction

common

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

Get a list of the playlists owned or followed by a Spotify user.

Properties

api

common

val api: GenericSpotifyApi

cache

common

val cache: SpotifyCache

Inheritors

ClientPlaylistApi

Sources

common source