new AlbumManager( Spotify )

Description

Manages spotify albums.

Parameters
Name Type Description
Spotify Spotify

The spotify client.

Details

Members


spotify :Spotify

Description

The spotify client.

Details

Methods


get( id ) → {Promise.<(Album|HTTPError|ApiError)>}

Description

Get Spotify catalog information for a single album.

Parameters
Name Type Description
id string

The Spotify ID of the album.

Returns
Details

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

Description

Get Spotify catalog information about an album’s tracks.

Parameters
Name Type Description
id string

The Spotify ID of the album.

options LimitOptions
Returns
Details

saved( options ) → {Promise.<(Array.<Album>|HTTPError|ApiError)>}

Description

Get a list of the albums saved in the current Spotify user's 'Your Music' library.

Parameters
Name Type Description
options LimitOptions
Returns
Details

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

Description

Save one or more albums to the current user's 'Your Music' library.

Parameters
Name Type Description
ids string | Array.<string>

A list of the Spotify IDs for the albums.

Returns
Details

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

Description

Remove one or more albums to the current user's 'Your Music' library.

Parameters
Name Type Description
ids string | Array.<string>

A list of the Spotify IDs for the albums.

Returns
Details

starred( ids ) → {Promise.<(Array.<boolean>|HTTPError|ApiError)>}

Description

Check if one or more albums is already saved in the current Spotify user's 'Your Music' library.

Parameters
Name Type Description
ids string

A list of the Spotify IDs for the albums.

Returns
Details

releases( options ) → {Promise.<(Array.<Album>|HTTPError|ApiError)>}

Description

Get a list of new album releases featured in Spotify.

Parameters
Name Type Description
options LimitOptions
Returns
Details

Description

Get Spotify catalog information about albums.

Parameters
Name Type Description
query string

Your search query.

options SearchOptions
Returns
Details