ESDoc Home Reference Source Repository

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

public class | source

ArtistHandler

You can directly use instance of this class. artistHandler

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

See:

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

Method Summary

Public Methods
public	albums(id: String, query: Object): Promise Get Spotify catalog information about an artist’s albums.
public	convert(item: Object): Object Convert a valid object to a Artist entity
public	follow(artists: Array): Promise Add the current user as a follower of one or more artists.
public	get(ids: String \| Array, query: Object): Promise Get a single/collection of artist/s identified by its unique/list of Spotify ID.
public	relatedArtists(id: String, query: Object): Promise Get Spotify catalog information about artists similar to a given artist.
public	search(name: String, query: Object): Promise Get a collection of artists that match a keyword string.
public	topTracks(id: String, query: Object): Promise Get Spotify catalog information about an artist’s top tracks by country.
public	unfollow(artists: Array): Promise Remove the current user as a follower of one or more artists.

Public Methods

public albums(id: String, query: Object): Promise source

Get Spotify catalog information about an artist’s albums.

Params:

Name	Type	Attribute	Description
id	String		Artist id to retrive
query	Object	optional	Query parameters.

Return:

albumsCollection

See:

https://developer.spotify.com/web-api/get-artists-albums/

public convert(item: Object): Object source

Convert a valid object to a Artist entity

Params:

Name	Type	Attribute	Description
item	Object		Object to convert in entity

Return:

Artist

public follow(artists: Array): Promise source

Add the current user as a follower of one or more artists.

Params:

Name	Type	Attribute	Description
artists	Array		List of artists ids

Return:

JSON reponse

See:

https://developer.spotify.com/web-api/follow-artists-users/

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

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

Params:

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

Return:

Artist|artistCollection

See:

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

public relatedArtists(id: String, query: Object): Promise source

Get Spotify catalog information about artists similar to a given artist.

Params:

Name	Type	Attribute	Description
id	String		Artist id to retrive related artists
query	Object	optional	Query parameters.

Return:

albumsCollection

See:

https://developer.spotify.com/web-api/get-related-artists/

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

Get a collection of artists that match a keyword string.

Params:

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

Return:

artistCollection

See:

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

public topTracks(id: String, query: Object): Promise source

Get Spotify catalog information about an artist’s top tracks by country.

Params:

Name	Type	Attribute	Description
id	String		Artist id to retrive top tracks
query	Object	optional	Query parameters.

Return:

tracksCollection

See:

https://developer.spotify.com/web-api/get-artists-top-tracks/

public unfollow(artists: Array): Promise source

Remove the current user as a follower of one or more artists.

Params:

Name	Type	Attribute	Description
artists	Array		List of artists ids

Return:

JSON reponse

See:

https://developer.spotify.com/web-api/unfollow-artists-users/