ESDoc Home Reference Source Repository

import AlbumHandler from 'spotify-sdk/src/handlers/AlbumHandler.js'

public class | source

AlbumHandler

You can directly use instance of this class. albumHandler

Methods for retrieving information about one or more albums from the Spotify catalog.

See:

https://developer.spotify.com/web-api/album-endpoints/

Method Summary

Public Methods
public	convert(item: Object): Object Convert a valid object to a Album entity
public	get(ids: String \| Array, query: Object): Promise Get a single/collection of album/s identified by its unique/list of Spotify ID.
public	newReleases(query: Object): Promise Get a list of new album releases featured in Spotify.
public	search(name: String, query: Object): Promise Get a collection of albums that match a keyword string.

Public Methods

public convert(item: Object): Object source

Convert a valid object to a Album entity

Params:

Name	Type	Attribute	Description
item	Object		Object to convert in entity

Return:

Album

public get(ids: String | Array, query: Object): Promise source

Get a single/collection of album/s identified by its unique/list of Spotify ID.

Params:

Name	Type	Attribute	Description
ids	String \| Array		Album id/ids to retrive
query	Object	optional	Query parameters.

Return:

Album|albumsCollection

See:

https://developer.spotify.com/web-api/get-album/

public newReleases(query: Object): Promise source

Get a list of new album releases featured in Spotify.

Params:

Name	Type	Attribute	Description
query	Object	optional	Query parameters.

Return:

albumsCollection

See:

https://developer.spotify.com/web-api/get-list-new-releases/

public search(name: String, query: Object): Promise source

Get a collection of albums that match a keyword string.

Params:

Name	Type	Attribute	Description
name	String		Name of the album.
query	Object	optional	Query parameters.

Return:

albumsCollection

See:

https://developer.spotify.com/web-api/search-item/