MeManager | spotify.js documentation

Hierarchy

Manager
- MeManager

Index

Constructors

constructor

Methods

Constructors

constructor

new MeManager(config: SpotifyConfig, privateConfig: PrivateConfig): MeManager

Inherited from Manager.constructor
- Defined in src/lib/Manager.ts:7
Parameters
- config: SpotifyConfig
- privateConfig: PrivateConfig
Returns MeManager

Methods

containTracks

containTracks(ids: string[]): Promise<boolean[]>

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

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

get

get(): Promise<UserPrivate>

- Defined in src/lib/me/MeManager.ts:55
description
Get current user's (private) data. (required scropes: user-read-private, user-read-email).

Returns Promise<UserPrivate>

getPlaybackState

getPlaybackState(): Promise<PlayerState>

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

Returns Promise<PlayerState>
Returns a promise with the current playback state.

playlists

playlists(options?: { limit?: number; offset?: number }): Promise<CursorPagingObject<Playlist>>

- Defined in src/lib/me/MeManager.ts:158
Parameters
- Optional options: { limit?: number; offset?: number }
  - Optional limit?: number
  - Optional offset?: number
Returns Promise<CursorPagingObject<Playlist>>

recentlyPlayed

recentlyPlayed(options?: { after?: number; before?: number; limit?: number }): Promise<CursorPagingObject<RecentlyPlayed>>

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

Parameters
- Optional options: { after?: number; before?: number; limit?: number }
  - Optional after?: number
  - Optional before?: number
  - Optional limit?: number
Returns Promise<CursorPagingObject<RecentlyPlayed>>
Returns a promise with the RecentlyPlayed items.

saveTracks

saveTracks(ids: string[]): Promise<void>

- Defined in src/lib/me/MeManager.ts:142
description
Save multiple tracks by ID. (required scropes: user-library-read).

Parameters
- ids: string[]
  Array of IDs.
Returns Promise<void>

savedTracks

savedTracks(options?: { limit?: number; market?: Markets; offset?: number }): Promise<CursorPagingObject<LibraryTrack>>

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

Parameters
- Optional options: { limit?: number; market?: Markets; offset?: number }
  - Optional limit?: number
  - Optional market?: Markets
  - Optional offset?: number
Returns Promise<CursorPagingObject<LibraryTrack>>
Returns a promise with the an array of booleans.

top

top(type: "artists", options?: TopOptions): Promise<PagingObject<Artist>>
top(type: "tracks", options?: TopOptions): Promise<PagingObject<Track>>

- Defined in src/lib/me/MeManager.ts:24
description
Get current user's top artists.

Parameters
- type: "artists"
- Optional options: TopOptions
Returns Promise<PagingObject<Artist>>
Returns a promise with the paginated Artist.
- Defined in src/lib/me/MeManager.ts:32
description
Get current user's top tracks.

Parameters
- type: "tracks"
- Optional options: TopOptions
Returns Promise<PagingObject<Track>>
Returns a promise with the paginated Track.

unfollowPlaylist

unfollowPlaylist(id: string): Promise<void>

- Defined in src/lib/me/MeManager.ts:178
description
Remove the current user as a follower of a playlist.

Parameters
- id: string
  The Spotify ID of the playlist to unfollow.
Returns Promise<void>

unsaveTracks

unsaveTracks(ids: string[]): Promise<void>

- Defined in src/lib/me/MeManager.ts:152
description
Remove multiple saved tracks by ID. (required scropes: user-library-read).

Parameters
- ids: string[]
  Array of IDs.
Returns Promise<void>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

config: SpotifyConfig

privateConfig: PrivateConfig

Returns MeManager

Methods

containTracks

Parameters

ids: string[]

Returns Promise<boolean[]>

get

Returns Promise<UserPrivate>

getPlaybackState

Returns Promise<PlayerState>

playlists

Parameters

Optional options: { limit?: number; offset?: number }

Optional limit?: number

Optional offset?: number

Returns Promise<CursorPagingObject<Playlist>>

recentlyPlayed

Parameters

Optional options: { after?: number; before?: number; limit?: number }

Optional after?: number

Optional before?: number

Optional limit?: number

Returns Promise<CursorPagingObject<RecentlyPlayed>>

saveTracks

Parameters

ids: string[]

Returns Promise<void>

savedTracks

Parameters

Optional options: { limit?: number; market?: Markets; offset?: number }

Optional limit?: number

Optional market?: Markets

Optional offset?: number

Returns Promise<CursorPagingObject<LibraryTrack>>

top

Parameters

type: "artists"

Optional options: TopOptions

Returns Promise<PagingObject<Artist>>

Parameters

type: "tracks"

Optional options: TopOptions

Returns Promise<PagingObject<Track>>

unfollowPlaylist

Parameters

id: string

Returns Promise<void>

unsaveTracks

Parameters

ids: string[]

Returns Promise<void>