1. Home
  2. Classes
  3. PlaylistManager

new PlaylistManager( spotify )

Description

Manages spotify playing.

Parameters
Name Type Description
spotify Spotify

The spotify client.
Details

managers/Playlist.js, line 14

Members

spotify :Spotify

Description

The spotify client.

Details
Spotify

managers/Playlist.js, line 19

Methods

get( id, options ) → {Promise.<(Playlist|HTTPError|ApiError)>}

Description

Get a playlist owned by a Spotify user.

Parameters
Name Type Description
id string

The Spotify ID of the playlist.
options PlaylistOptions
Returns
Details

managers/Playlist.js, line 28

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

Description

Change a playlist's name and public/private state. (The user must, of course, own the playlist.)

Parameters
Name Type Description
id string

The Spotify ID of the playlist.
options ModifyOptions
Returns
Details

managers/Playlist.js, line 62

update( id, options ) → {Status|HTTPError|ApiError}

Description

Either reorder or replace items in a playlist depending on the request's parameters.

Parameters
Name Type Description
id Array.<string>

The Spotify ID of the playlist.
options UpdatePlaylistOptions
Returns
Details

managers/Playlist.js, line 98

tracks( id, options ) → {Promise.<(Array.<Track>|HTTPError|ApiError)>}

Description

Get full details of the items of a playlist owned by a Spotify user.

Parameters
Name Type Description
id string

The Spotify ID of the playlist.
options PlaylistTracksOptions
Returns
Details

managers/Playlist.js, line 142

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

Description

Add one or more items to a user's playlist.

Parameters
Name Type Attributes Default Description
id string

The Spotify ID of the playlist.
uris ContextURI | Array.<ContextURI>

A list of Spotify URIs to add, can be track or episode URIs. Maximum: 100
position number <optional>
 0

The position to insert the items, a zero-based index.
Returns
Details

managers/Playlist.js, line 184

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

Description

Remove one or more items from a user's playlist.

Parameters
Name Type Attributes Description
id string

The Spotify ID of the playlist.
uris ContextURI | Array.<ContextURI>

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
Details

managers/Playlist.js, line 220

users( [ id ], options ) → {Promise.<(Array.<Playlist>|HTTPError|ApiError)>}

Description

Get a list of the playlists owned or followed by the current Spotify user.

Parameters
Name Type Attributes Description
id string <optional>

The user's Spotify user ID - if not provided it will default to the current user.
options LimitOptions
Returns
Details

managers/Playlist.js, line 255

follow( id [, state ] ) → {Promise.<(Status|HTTPError|ApiError)>}

Description

Add the current user as a follower of a playlist.

Parameters
Name Type Attributes Default Description
id string

The Spotify ID of the playlist.
state boolean <optional>
 true

If the playlist will be included in user's public playlists.
Returns
Details

managers/Playlist.js, line 297

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

Description

Remove the current user as a follower of a playlist.

Parameters
Name Type Description
id string

The Spotify ID of the playlist.
Returns
Details

managers/Playlist.js, line 330

followers( id, users ) → {Array.<boolean>|HTTPError|ApiError}

Description

Check to see if one or more Spotify users are following a specified playlist.

Parameters
Name Type Description
id string

The Spotify ID of the playlist.
users string | Array.<string>

A list of Spotify User IDs.
Returns
Details

managers/Playlist.js, line 359

create( id, options ) → {Promise.<(Playlist|HTTPError|ApiError)>}

Description

Create a playlist for a Spotify user.

Parameters
Name Type Description
id string

The user's Spotify user ID.
options ModifyOptions
Returns
Details

managers/Playlist.js, line 391

Description

Get a list of Spotify featured playlists.

Parameters
Name Type Attributes Description
options FeaturedOptions <optional>
Returns
Details

managers/Playlist.js, line 431

categories( id, options ) → {Promise.<(Array.<Playlist>|HTTPError|ApiError)>}

Description

Get a list of Spotify playlists tagged with a particular category.

Parameters
Name Type Description
id string

The Spotify category ID for the category.
options LimitOptions
Returns
Details

managers/Playlist.js, line 474

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

Description

Get the current image associated with a specific playlist.

Parameters
Name Type Attributes Description
id string

The Spotify ID of the playlist.
image string <optional>

The Base64 image encoded to upload as cover art.
Returns
Details

managers/Playlist.js, line 511

Description

Get Spotify catalog information about playlists.

Parameters
Name Type Description
query string

Your search query.
options SearchOptions
Returns
Details

managers/Playlist.js, line 553