SimplePlaylist

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

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.

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

SimplePlaylist

common

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

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

Functions

component10

common

operator fun component10(): String?

component11

common

operator fun component11(): Boolean?

component13

common

operator fun component13(): PlaylistTrackInfo

component14

common

operator fun component14(): String

component2

common

operator fun component2(): String

component3

common

operator fun component3(): String

component4

common

operator fun component4(): SpotifyUri

component5

common

operator fun component5(): Boolean

component6

common

operator fun component6(): List<SpotifyImage>

component7

common

operator fun component7(): String

component8

common

operator fun component8(): String?

component9

common

operator fun component9(): SpotifyPublicUser

copy

common

fun copy(externalUrlsString: Map<String, String>, href: String, id: String, uri: SpotifyUri, collaborative: Boolean, images: List<SpotifyImage>, name: String, description: String? = null, owner: SpotifyPublicUser, primaryColor: String? = null, public: Boolean? = null, snapshotIdString: String, tracks: PlaylistTrackInfo, type: String): SimplePlaylist

equals

common

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

getMembersThatNeedApiInstantiation

common

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

hashCode

common

open override fun hashCode(): Int

toFullPlaylist

common

suspend fun toFullPlaylist(market: Market? = null): Playlist?

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

toFullPlaylistRestAction

common

fun toFullPlaylistRestAction(market: Market? = null): SpotifyRestAction<Playlist?>

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

toString

common

open override fun toString(): String

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

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.

snapshot

common

val snapshot: PlaylistSnapshot

The version identifier for the current playlist.

tracks

common

val tracks: PlaylistTrackInfo

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

common

val type: String

The object type: “playlist”

uri

common

open override val uri: SpotifyUri

The URI associated with the object

Sources

(source)