Playlist

Members

---

spotify :Spotify

Description

The spotify client.

Details

Type

Spotify

Source

structures/Playlist.js, line 26

Methods

---

play( options ) → {Promise.<(Status|HTTPError|ApiError)>}

Description

Shortcut to play the playlist.

Parameters

Name	Type	Description
options	StartOptions

Returns

Promise.<(Status|HTTPError|ApiError)>

Details

Source

structures/Playlist.js, line 34

---

modify( options ) → {Promise.<(Status|HTTPError|ApiError)>}

Description

Shortcut to modify the playlist.

Parameters

Name	Type	Description
options	ModifyOptions

Returns

Promise.<(Status|HTTPError|ApiError)>

Details

Source

structures/Playlist.js, line 43

---

add( uris [, position ] ) → {Promise.<(Status|HTTPError|ApiError)>}

Description

Shortcut to add tracks to a playlist.

Parameters

Name	Type	Attributes	Default	Description
uris	string | Array.<string>			A list of Spotify URIs to add, can be track or episode URIs.
position	number	<optional>	0	The position to insert the items, a zero-based index.

Returns

Promise.<(Status|HTTPError|ApiError)>

Details

Source

structures/Playlist.js, line 53

---

remove( uris [, snapshot ] ) → {Promise.<(Status|HTTPError|ApiError)>}

Description

Shortcut to remove a track from a playlist.

Parameters

Name	Type	Attributes	Description
uris	string | Array.<string>		A list of Spotify URIs to remove, can be track or episode URIs. Maximum: 100
snapshot	string	<optional>	The playlist's snapshot ID against which you want to make the changes.

Returns

Promise.<(Status|HTTPError|ApiError)>

Details

Source

structures/Playlist.js, line 63

---

follow() → {Promise.<(Status|HTTPError|ApiError)>}

Description

Shortcut to follow the playlist.

Returns

Promise.<(Status|HTTPError|ApiError)>

Details

Source

structures/Playlist.js, line 71

---

unfollow() → {Promise.<(Status|HTTPError|ApiError)>}

Description

Shortcut to unfollow the playlist.

Returns

Promise.<(Status|HTTPError|ApiError)>

Details

Source

structures/Playlist.js, line 79

---

following( users ) → {Promise.<(Array.<boolean>|HTTPError|ApiError)>}

Description

Shortcut to check user's following the playlist.

Parameters

Name	Type	Description
users	string | Array.<string>	A list of Spotify User IDs.

Returns

Promise.<(Array.<boolean>|HTTPError|ApiError)>

Details

Source

structures/Playlist.js, line 88

---

cover( [ image ] ) → {Promise.<(Image|Status|HTTPError|ApiError)>}

Description

Shortcut to upload cover art to a playlist.

Parameters

Name	Type	Attributes	Description
image	string	<optional>	The Base64 image encoded to upload as cover art.

Returns

Promise.<(Image|Status|HTTPError|ApiError)>

Details

Source

structures/Playlist.js, line 97