ClientPlaylistApi

class ClientPlaylistApi(api: GenericSpotifyApi) : PlaylistApi

Endpoints for retrieving information about a user’s playlists and for managing a user’s playlists.

Api Reference

Constructors

ClientPlaylistApi

common

fun ClientPlaylistApi(api: GenericSpotifyApi)

Functions

addPlayablesToClientPlaylist

common

suspend fun addPlayablesToClientPlaylist(playlist: String, vararg playables: PlayableUri, position: Int? = null)

Add a Playable to a user’s playlist.

addPlayablesToClientPlaylistRestAction

common

fun addPlayablesToClientPlaylistRestAction(playlist: String, vararg playables: PlayableUri, position: Int? = null): SpotifyRestAction<Unit>

Add a Playable to a user’s playlist.

addPlayableToClientPlaylist

common

suspend fun addPlayableToClientPlaylist(playlist: String, playable: PlayableUri, position: Int? = null)

Add a Playable to a user’s playlist.

addPlayableToClientPlaylistRestAction

common

fun addPlayableToClientPlaylistRestAction(playlist: String, playable: PlayableUri, position: Int? = null): SpotifyRestAction<Unit>

Add a Playable to a user’s playlist.

changeClientPlaylistDetails

common

suspend fun changeClientPlaylistDetails(playlist: String, name: String? = null, public: Boolean? = null, collaborative: Boolean? = null, description: String? = null)

Change a playlist’s name and public/private state.

changeClientPlaylistDetailsRestAction

common

fun changeClientPlaylistDetailsRestAction(playlist: String, name: String? = null, public: Boolean? = null, collaborative: Boolean? = null, description: String? = null): SpotifyRestAction<Unit>

Change a playlist’s name and public/private state.

createClientPlaylist

common

suspend fun createClientPlaylist(name: String, description: String? = null, public: Boolean? = null, collaborative: Boolean? = null, user: String? = null): Playlist

Create a playlist for a Spotify user.

createClientPlaylistRestAction

common

fun createClientPlaylistRestAction(name: String, description: String? = null, public: Boolean? = null, collaborative: Boolean? = null, user: String? = null): SpotifyRestAction<Playlist>

Create a playlist for a Spotify user.

deleteClientPlaylist

common

suspend fun deleteClientPlaylist(playlist: String): String

This method is equivalent to unfollowing a playlist with the given playlist.

deleteClientPlaylistRestAction

common

fun deleteClientPlaylistRestAction(playlist: String): SpotifyRestAction<String>

This method is equivalent to unfollowing a playlist with the given playlist.

getClientPlaylist

common

suspend fun getClientPlaylist(id: String): SimplePlaylist?

Find a client playlist by its id.

getClientPlaylistRestAction

common

fun getClientPlaylistRestAction(id: String): SpotifyRestAction<SimplePlaylist?>

Find a client playlist by its id.

getClientPlaylists

common

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

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

getClientPlaylistsRestAction

common

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

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

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.

removeAllClientPlaylistPlayables

common

suspend fun removeAllClientPlaylistPlayables(playlist: String)

Remove all the playables in a playlistApi Reference

removeAllClientPlaylistPlayablesRestAction

common

fun removeAllClientPlaylistPlayablesRestAction(playlist: String): SpotifyRestAction<Unit>

Remove all the playables in a playlistApi Reference

removePlayableFromClientPlaylist

common

suspend fun removePlayableFromClientPlaylist(playlist: String, playable: PlayableUri, snapshotId: String? = null): PlaylistSnapshot

Remove all occurrences of a playable from the specified playlist.

suspend fun removePlayableFromClientPlaylist(playlist: String, playable: PlayableUri, positions: SpotifyPlayablePositions, snapshotId: String? = null): PlaylistSnapshot

Remove a playable in the specified positions (zero-based) from the specified playlist.

removePlayableFromClientPlaylistRestAction

common

fun removePlayableFromClientPlaylistRestAction(playlist: String, playable: PlayableUri, snapshotId: String? = null): SpotifyRestAction<PlaylistSnapshot>

Remove all occurrences of a playable from the specified playlist.

fun removePlayableFromClientPlaylistRestAction(playlist: String, playable: PlayableUri, positions: SpotifyPlayablePositions, snapshotId: String? = null): SpotifyRestAction<PlaylistSnapshot>

Remove a playable in the specified positions (zero-based) from the specified playlist.

removePlayablesFromClientPlaylist

common

suspend fun removePlayablesFromClientPlaylist(playlist: String, vararg playables: PlayableUri, snapshotId: String? = null): PlaylistSnapshot

Remove all occurrences of the specified playables from the given playlist.

suspend fun removePlayablesFromClientPlaylist(playlist: String, vararg playables: Pair<PlayableUri, SpotifyPlayablePositions>, snapshotId: String? = null): PlaylistSnapshot

Remove playables (each with their own positions) from the given playlist.

removePlayablesFromClientPlaylistRestAction

common

fun removePlayablesFromClientPlaylistRestAction(playlist: String, vararg playables: PlayableUri, snapshotId: String? = null): SpotifyRestAction<PlaylistSnapshot>

Remove all occurrences of the specified playables from the given playlist.

fun removePlayablesFromClientPlaylistRestAction(playlist: String, vararg playables: Pair<PlayableUri, SpotifyPlayablePositions>, snapshotId: String? = null): SpotifyRestAction<PlaylistSnapshot>

Remove playables (each with their own positions) from the given playlist.

reorderClientPlaylistPlayables

common

suspend fun reorderClientPlaylistPlayables(playlist: String, reorderRangeStart: Int, reorderRangeLength: Int? = null, insertionPoint: Int, snapshotId: String? = null): PlaylistSnapshot

Reorder a playable or a group of playables in a playlist.

reorderClientPlaylistPlayablesRestAction

common

fun reorderClientPlaylistPlayablesRestAction(playlist: String, reorderRangeStart: Int, reorderRangeLength: Int? = null, insertionPoint: Int, snapshotId: String? = null): SpotifyRestAction<PlaylistSnapshot>

Reorder a playable or a group of playables in a playlist.

replaceClientPlaylistPlayables

common

suspend fun replaceClientPlaylistPlayables(playlist: String, vararg playables: PlayableUri)

Replace all the playables in a playlist, overwriting its existing playables.

replaceClientPlaylistPlayablesRestAction

common

fun replaceClientPlaylistPlayablesRestAction(playlist: String, vararg playables: PlayableUri): SpotifyRestAction<Unit>

Replace all the playables in a playlist, overwriting its existing playables.

setClientPlaylistPlayables

common

suspend fun setClientPlaylistPlayables(playlist: String, vararg playables: PlayableUri)

Replace all the playables in a playlist, overwriting its existing playables.

setClientPlaylistPlayablesRestAction

common

fun setClientPlaylistPlayablesRestAction(playlist: String, vararg playables: PlayableUri): SpotifyRestAction<Unit>

Replace all the playables in a playlist, overwriting its existing playables.

uploadClientPlaylistCover

common

suspend fun uploadClientPlaylistCover(playlist: String, imagePath: String? = null, imageFile: VfsFile? = null, image: BufferedImage? = null, imageData: String? = null, imageUrl: String? = null)

Replace the image used to represent a specific playlist.

uploadClientPlaylistCoverRestAction

common

fun uploadClientPlaylistCoverRestAction(playlist: String, imagePath: String? = null, imageFile: VfsFile? = null, image: BufferedImage? = null, imageData: String? = null, imageUrl: String? = null): SpotifyRestAction<Unit>

Replace the image used to represent a specific playlist.

Properties

api

common

val api: GenericSpotifyApi

cache

common

val cache: SpotifyCache

Sources

common source