Class MeManager

Hierarchy (view full)

Manager
- MeManager

Index

Constructors

constructor

Methods

containTracks get getPlaybackState playlists recentlyPlayed saveTracks savedTracks top unfollowPlaylist unsaveTracks

Constructors

constructor

new MeManager(http): MeManager
Parameters
- http: HttpClient
Returns MeManager
Inherited from Manager.constructor
- Defined in src/lib/Manager.ts:5

Methods

containTracks

containTracks(ids): Promise<boolean[]>
Parameters
- ids: string[]
Returns Promise<boolean[]>
Returns a promise with the an array of booleans.

Description
Check if one or more tracks is saved in the current user's library. (required scropes: user-library-read).
- Defined in src/lib/me/MeManager.ts:132

get

get(): Promise<UserPrivate>
Returns Promise<UserPrivate>
Description
Get current user's (private) data. (required scropes: user-read-private, user-read-email).
- Defined in src/lib/me/MeManager.ts:57

getPlaybackState

getPlaybackState(): Promise<PlayerState>
Returns Promise<PlayerState>
Returns a promise with the current playback state.

Description
Get information about the user’s current playback state, including track or episode, progress, and active device.
- Defined in src/lib/me/MeManager.ts:98

playlists

playlists(options?): Promise<CursorPagingObject<Playlist>>
Parameters
- Optionaloptions: {
  limit?: number;
  offset?: number;
  }
  - Optionallimit?: number
  - Optionaloffset?: number
Returns Promise<CursorPagingObject<Playlist>>
- Defined in src/lib/me/MeManager.ts:160

recentlyPlayed

recentlyPlayed(options?): Promise<CursorPagingObject<RecentlyPlayed>>
Parameters
- Optionaloptions: {
      after?: number;
      before?: number;
      limit?: number;
  }
  - Optionalafter?: number
  - Optionalbefore?: number
  - Optionallimit?: number
Returns Promise<CursorPagingObject<RecentlyPlayed>>
Returns a promise with the RecentlyPlayed items.

Description
Get current user's recently played tracks. (required scoped: user-read-recently-played).
- Defined in src/lib/me/MeManager.ts:68

saveTracks

saveTracks(ids): Promise<void>
Parameters
- ids: string[]
  Array of IDs.
Returns Promise<void>
Description
Save multiple tracks by ID. (required scropes: user-library-read).
- Defined in src/lib/me/MeManager.ts:144

savedTracks

savedTracks(options?): Promise<CursorPagingObject<LibraryTrack>>
Parameters
- Optionaloptions: {
      limit?: number;
      market?: Markets;
      offset?: number;
  }
  - Optionallimit?: number
  - Optionalmarket?: Markets
  - Optionaloffset?: number
Returns Promise<CursorPagingObject<LibraryTrack>>
Returns a promise with the an array of booleans.

Description
Check if one or more tracks is saved in the current user's library. (required scropes: user-library-read).
- Defined in src/lib/me/MeManager.ts:110

top

top(type, options?): Promise<PagingObject<Artist>>
Parameters
- type: "artists"
- Optionaloptions: TopOptions
Returns Promise<PagingObject<Artist>>
Returns a promise with the paginated Artist.

Description
Get current user's top artists.
- Defined in src/lib/me/MeManager.ts:25
top(type, options?): Promise<PagingObject<Track>>
Parameters
- type: "tracks"
- Optionaloptions: TopOptions
Returns Promise<PagingObject<Track>>
Returns a promise with the paginated Track.

Description
Get current user's top tracks.
- Defined in src/lib/me/MeManager.ts:34

unfollowPlaylist

unfollowPlaylist(id): Promise<void>
Parameters
- id: string
  The Spotify ID of the playlist to unfollow.
Returns Promise<void>
Description
Remove the current user as a follower of a playlist.
- Defined in src/lib/me/MeManager.ts:180

unsaveTracks

unsaveTracks(ids): Promise<void>
Parameters
- ids: string[]
  Array of IDs.
Returns Promise<void>
Description
Remove multiple saved tracks by ID. (required scropes: user-library-read).
- Defined in src/lib/me/MeManager.ts:154

Class MeManager

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MeManager

Methods

containTracks

Parameters

Returns Promise<boolean[]>

Description

get

Returns Promise<UserPrivate>

Description

getPlaybackState

Returns Promise<PlayerState>

Description

playlists

Parameters

Optionallimit?: number

Optionaloffset?: number

Returns Promise<CursorPagingObject<Playlist>>

recentlyPlayed

Parameters

Optionalafter?: number

Optionalbefore?: number

Optionallimit?: number

Returns Promise<CursorPagingObject<RecentlyPlayed>>

Description

saveTracks

Parameters

Returns Promise<void>

Description

savedTracks

Parameters

Optionallimit?: number

Optionalmarket?: Markets

Optionaloffset?: number

Returns Promise<CursorPagingObject<LibraryTrack>>

Description

top

Parameters

Returns Promise<PagingObject<Artist>>

Description

Parameters

Returns Promise<PagingObject<Track>>

Description

unfollowPlaylist

Parameters

Returns Promise<void>

Description

unsaveTracks

Parameters

Returns Promise<void>

Description

Settings

On This Page

`Optional`limit?: number

`Optional`offset?: number

`Optional`after?: number

`Optional`before?: number

`Optional`limit?: number

`Optional`limit?: number

`Optional`market?: Markets

`Optional`offset?: number