ESDoc Home Reference Source Repository

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

public class | source

UserHandler

You can directly use instance of this class. userHandler

Methods for retrieving information about one or more user/s from the Spotify catalog.

See:

https://developer.spotify.com/web-api/user-profile-endpoints/

Method Summary

Public Methods
public	convert(item: object): Object Convert a valid object to a User entity
public	get(id: String): Promise Get public profile information about a Spotify user.
public	me(): Promise Get detailed profile information about the current user.
public	playlists(id: String, playlistId: String, query: Object): Promise Get a list of the playlists owned or followed by a Spotify user.

Public Methods

public convert(item: object): Object source

Convert a valid object to a User entity

Params:

Name	Type	Attribute	Description
item	object		Object to convert in entity

Return:

public get(id: String): Promise source

Get public profile information about a Spotify user.

Params:

Name	Type	Attribute	Description
id	String		User id to retrive

Return:

User

See:

https://developer.spotify.com/web-api/get-users-profile/

public me(): Promise source

Get detailed profile information about the current user.

Return:

User

See:

https://developer.spotify.com/web-api/get-current-users-profile/

public playlists(id: String, playlistId: String, query: Object): Promise source

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

Params:

Name	Type	Attribute	Description
id	String		User User id
playlistId	String	optional	id to retrive playlists
query	Object	optional	Query parameters.

Return:

playlistCollection

See:

https://developer.spotify.com/web-api/get-list-users-playlists/