Playlist

data class Playlist(externalUrlsString: Map<String, String>, href: String, id: String, uri: PlaylistUri, collaborative: Boolean, description: String?, followers: Followers, primaryColor: String?, images: List<SpotifyImage>, name: String, owner: SpotifyPublicUser, public: Boolean?, snapshotIdString: String, tracks: PagingObject<PlaylistTrack>, type: String) : CoreObject

Represents a Playlist on Spotify

Parameters

collaborative

Returns true if context is not search and the owner allows other users to modify the playlist. Otherwise returns false.

description

The playlist description. Only returned for modified, verified playlists, otherwise null.

followers

href

A link to the Web API endpoint providing full details of the playlist.

The Spotify ID for the playlist.

primaryColor

Unknown.

images

Images for the playlist. The array may be empty or contain up to three images. The images are returned by size in descending order.Note: If returned, the source URL for the image ( url ) is temporary and will expire in less than a day.

name

The name of the playlist.

owner

The user who owns the playlist

public

The playlist’s public/private status: true the playlist is public, false the playlist is private, null the playlist status is not relevant a specific playlist version

tracks

Information about the tracks of the playlist.

type

The object type: “playlist”

Constructors

Playlist

common

fun Playlist(externalUrlsString: Map<String, String>, href: String, id: String, uri: PlaylistUri, collaborative: Boolean, description: String? = null, followers: Followers, primaryColor: String? = null, images: List<SpotifyImage>, name: String, owner: SpotifyPublicUser, public: Boolean? = null, snapshotIdString: String, tracks: PagingObject<PlaylistTrack>, type: String)

Returns true if context is not search and the owner allows other users to modify the playlist.

Functions

getMembersThatNeedApiInstantiation

common

open override fun getMembersThatNeedApiInstantiation(): List<NeedsApi?>

Properties

api

common

lateinit var api: GenericSpotifyApi

The API client associated with the request

collaborative

common

val collaborative: Boolean

Returns true if context is not search and the owner allows other users to modify the playlist.

description

common

val description: String? = null

The playlist description.

externalUrls

common

val externalUrls: List<ExternalUrl>

Known external URLs for this object

followers

common

val followers: Followers

href

common

open override val href: String

A link to the Web API endpoint providing full details of the playlist.

common

open override val id: String

The Spotify ID for the playlist.

images

common

val images: List<SpotifyImage>

Images for the playlist.

name

common

val name: String

The name of the playlist.

owner

common

val owner: SpotifyPublicUser

The user who owns the playlist

primaryColor

common

val primaryColor: String? = null

Unknown.

public

common

val public: Boolean? = null

The playlist’s public/private status: true the playlist is public, false the playlist is private, null the playlist status is not relevant a specific playlist version

snapshot

common

val snapshot: PlaylistSnapshot

The version identifier for the current playlist.

tracks

common

val tracks: PagingObject<PlaylistTrack>

Information about the tracks of the playlist.

type

common

val type: String

The object type: “playlist”