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

addTracksToClientPlaylist

common

suspend fun addTracksToClientPlaylist(playlist: String, vararg tracks: String, position: Int? = null)

Add one or more tracks to a user’s playlist.

addTracksToClientPlaylistRestAction

common

fun addTracksToClientPlaylistRestAction(playlist: String, vararg tracks: String, position: Int? = null): SpotifyRestAction<Unit>

Add one or more tracks to a user’s playlist.

addTrackToClientPlaylist

common

suspend fun addTrackToClientPlaylist(playlist: String, track: String, position: Int? = null)

Add a track to a user’s playlist.

addTrackToClientPlaylistRestAction

common

fun addTrackToClientPlaylistRestAction(playlist: String, track: String, position: Int? = null): SpotifyRestAction<Unit>

Add a track 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.

equals

common

open operator fun equals(other: Any?): Boolean

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.

hashCode

common

open fun hashCode(): Int

removeAllClientPlaylistTracks

common

suspend fun removeAllClientPlaylistTracks(playlist: String)

Remove all the tracks in a playlistApi Reference

removeAllClientPlaylistTracksRestAction

common

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

Remove all the tracks in a playlistApi Reference

removeTrackFromClientPlaylist

common

suspend fun removeTrackFromClientPlaylist(playlist: String, track: String, snapshotId: String? = null): PlaylistSnapshot

Remove all occurrences of a track from the specified playlist.

suspend fun removeTrackFromClientPlaylist(playlist: String, track: String, positions: SpotifyTrackPositions, snapshotId: String? = null): PlaylistSnapshot

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

removeTrackFromClientPlaylistRestAction

common

fun removeTrackFromClientPlaylistRestAction(playlist: String, track: String, snapshotId: String? = null): SpotifyRestAction<PlaylistSnapshot>

Remove all occurrences of a track from the specified playlist.

fun removeTrackFromClientPlaylistRestAction(playlist: String, track: String, positions: SpotifyTrackPositions, snapshotId: String? = null): SpotifyRestAction<PlaylistSnapshot>

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

removeTracksFromClientPlaylist

common

suspend fun removeTracksFromClientPlaylist(playlist: String, vararg tracks: Pair<String, SpotifyTrackPositions>, snapshotId: String? = null): PlaylistSnapshot

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

suspend fun removeTracksFromClientPlaylist(playlist: String, vararg tracks: String, snapshotId: String? = null): PlaylistSnapshot

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

removeTracksFromClientPlaylistRestAction

common

fun removeTracksFromClientPlaylistRestAction(playlist: String, vararg tracks: Pair<String, SpotifyTrackPositions>, snapshotId: String? = null): SpotifyRestAction<PlaylistSnapshot>

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

fun removeTracksFromClientPlaylistRestAction(playlist: String, vararg tracks: String, snapshotId: String? = null): SpotifyRestAction<PlaylistSnapshot>

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

reorderClientPlaylistTracks

common

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

Reorder a track or a group of tracks in a playlist.

reorderClientPlaylistTracksRestAction

common

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

Reorder a track or a group of tracks in a playlist.

replaceClientPlaylistTracks

common

suspend fun replaceClientPlaylistTracks(playlist: String, vararg tracks: String)

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

replaceClientPlaylistTracksRestAction

common

fun replaceClientPlaylistTracksRestAction(playlist: String, vararg tracks: String): SpotifyRestAction<Unit>

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

setClientPlaylistTracks

common

suspend fun setClientPlaylistTracks(playlist: String, vararg tracks: String)

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

setClientPlaylistTracksRestAction

common

fun setClientPlaylistTracksRestAction(playlist: String, vararg tracks: String): SpotifyRestAction<Unit>

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

toString

common

open fun toString(): String

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

(source)