SpotifyApiSpotify LogoJS

Playlist src/structures/Playlist.ts#L102

Spotify api's playlist object.


Properties:

collaborative description externalURL id images name owner public snapshotID totalFollowers totalTracks tracks type uri

Methods:

makeCodeImage

constructor(data, client) src/structures/Playlist.ts#L102

No documentation found.

NameTypeDescription
dataPlaylist | SimplifiedPlaylistThe raw data received from the api.
clientClientThe spotify client.

.collaborative src/structures/Playlist.ts#L28

Type:

boolean

True if the owner allows other users to modify the playlist.

.description src/structures/Playlist.ts#L33

Type:

"null" | string

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

.externalURL src/structures/Playlist.ts#L38

Type:

ExternalUrl

Known external URLs for this playlist.

.id src/structures/Playlist.ts#L43

Type:

string

The Spotify ID for the playlist.

.images src/structures/Playlist.ts#L48

Type:

Image[]

Images for the playlist. The array may be empty or contain up to three images.

.name src/structures/Playlist.ts#L53

Type:

string

The name of the playlist.

.owner src/structures/Playlist.ts#L58

Type:

User

The user who owns the playlist.

.public src/structures/Playlist.ts#L88
OPTIONAL

Type:

boolean

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

.snapshotID src/structures/Playlist.ts#L63

Type:

string

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

.totalFollowers src/structures/Playlist.ts#L83
OPTIONAL

Type:

number

The total number of followers of the playlist.

.totalTracks src/structures/Playlist.ts#L68

Type:

number

The total number of tracks in the playlist.

.tracks src/structures/Playlist.ts#L93
OPTIONAL

Type:

PlaylistTrack[]

Information about the tracks of the playlist. Note, a track object may be null. This can happen if a track is no longer available.

.type src/structures/Playlist.ts#L78

Type:

SpotifyType

The object type: “playlist”

.uri src/structures/Playlist.ts#L73

Type:

string

The Spotify URI for the playlist.

.makeCodeImage(color) src/structures/Playlist.ts#L126

Returns a code image url from the spotify uri.

Returns:

string

Parameters:

NameTypeDescription
colorstringThe color code in hex.