SimplePlaylist

@Serializable
data class SimplePlaylist(externalUrlsString: Map<String, String>, val href: String, val id: String, val uri: SpotifyUri, val collaborative: Boolean, val images: List<SpotifyImage>? = null, val name: String, val description: String? = null, val owner: SpotifyPublicUser, val primaryColor: String? = null, val public: Boolean? = null, snapshotIdString: String, val tracks: PlaylistTrackInfo, val type: String) : CoreObject(source)

Simplified Playlist object that can be used to retrieve a full Playlist

Parameters

collaborative

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

href

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

id

The Spotify ID for the playlist.

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. See Working with Playlists. 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

primaryColor

Unknown.

public

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

tracks

A collection containing a link ( href ) to the Web API endpoint where full details of the playlist’s tracks can be retrieved, along with the total number of tracks in the playlist.

type

The object type: “playlist”

description

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

Constructors

Link copied to clipboard
constructor(externalUrlsString: Map<String, String>, href: String, id: String, uri: SpotifyUri, collaborative: Boolean, images: List<SpotifyImage>? = null, name: String, description: String? = null, owner: SpotifyPublicUser, primaryColor: String? = null, public: Boolean? = null, snapshotIdString: String, tracks: PlaylistTrackInfo, type: String)

Properties

Link copied to clipboard
@Transient
lateinit var api: GenericSpotifyApi

The API client associated with the request

Link copied to clipboard
Link copied to clipboard
val description: String? = null
Link copied to clipboard

Known external URLs for this object

Link copied to clipboard
open override val href: String
Link copied to clipboard
open override val id: String
Link copied to clipboard
val images: List<SpotifyImage>? = null
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@SerialName(value = "primary_color")
val primaryColor: String? = null
Link copied to clipboard
val public: Boolean? = null
Link copied to clipboard

The version identifier for the current playlist. Can be supplied in other requests to target a specific playlist version

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val uri: SpotifyUri

The URI associated with the object

Functions

Link copied to clipboard
suspend fun toFullPlaylist(market: Market? = null): Playlist?

Converts this SimplePlaylist into a full Playlist object with the given market

Link copied to clipboard

Converts this SimplePlaylist into a full Playlist object with the given market