Class LibraryApi

Hierarchy

LibraryApi

Index

Constructors

constructor

Properties

http

Constructors

constructor

new LibraryApi(http: Http): LibraryApi

- Defined in apis/LibraryApi.ts:15
Parameters
- http: Http
Returns LibraryApi

Properties

Private http

http: Http

Methods

areAlbumsSaved

areAlbumsSaved(albumIds: string[]): Promise<boolean[]>

- Defined in apis/LibraryApi.ts:28
Check User's Saved Albums

Check if one or more albums are saved in the current user's library.

Parameters
- albumIds: string[]
  
  The Spotify IDs of the albums.
Returns Promise<boolean[]>

areShowsSaved

areShowsSaved(showIds: string[]): Promise<boolean[]>

- Defined in apis/LibraryApi.ts:43
Check User's Saved Shows

Check if one or more shows are saved in the current user's library.

Parameters
- showIds: string[]
  
  The Spotify IDs of the shows.
Returns Promise<boolean[]>

areTracksSaved

areTracksSaved(trackIds: string[]): Promise<boolean[]>

- Defined in apis/LibraryApi.ts:58
Check User's Saved Tracks

Check if one or more tracks are saved in the current user's library.

Parameters
- trackIds: string[]
  
  The Spotify IDs of the tracks.
Returns Promise<boolean[]>

getSavedAlbums

getSavedAlbums(options?: GetSavedAlbumsOptions): Promise<GetSavedAlbumsResponse>

- Defined in apis/LibraryApi.ts:73
Get the Current User's Saved Albums

Get a list of albums saved in the current user's library.

Parameters
- Optional options: GetSavedAlbumsOptions
  
  Optional request information.
Returns Promise<GetSavedAlbumsResponse>

getSavedShows

getSavedShows(options?: GetSavedShowsOptions): Promise<GetSavedShowsResponse>

- Defined in apis/LibraryApi.ts:89
Get the Current User's Saved Shows

Get a list of shows saved in the current user's library.

Parameters
- Optional options: GetSavedShowsOptions
  
  Optional request information.
Returns Promise<GetSavedShowsResponse>

getSavedTracks

getSavedTracks(options?: GetSavedTracksOptions): Promise<GetSavedTracksResponse>

- Defined in apis/LibraryApi.ts:105
Get the Current User's Saved Tracks

Get a list of tracks saved in the current user's library.

Parameters
- Optional options: GetSavedTracksOptions
  
  Optional request information.
Returns Promise<GetSavedTracksResponse>

isAlbumSaved

isAlbumSaved(albumId: string): Promise<boolean>

- Defined in apis/LibraryApi.ts:121
Check User's Saved Albums

Check if an album is saved in the current user's library.

Parameters
- albumId: string
  
  The Spotify ID of the album.
Returns Promise<boolean>

isShowSaved

isShowSaved(showId: string): Promise<boolean>

- Defined in apis/LibraryApi.ts:133
Check User's Saved Shows

Check if a show is saved in the current user's library.

Parameters
- showId: string
  
  The Spotify ID of the show.
Returns Promise<boolean>

isTrackSaved

isTrackSaved(trackId: string): Promise<boolean>

- Defined in apis/LibraryApi.ts:145
Check User's Saved Tracks

Check if a track is saved in the current user's library.

Parameters
- trackId: string
  
  The Spotify ID of the track.
Returns Promise<boolean>

removeSavedAlbum

removeSavedAlbum(albumId: string): Promise<void>

- Defined in apis/LibraryApi.ts:157
Remove Album for the Current User

Remove an album from the current user's library.

Parameters
- albumId: string
  
  The Spotify ID of the album.
Returns Promise<void>

removeSavedAlbums

removeSavedAlbums(albumIds: string[]): Promise<void>

- Defined in apis/LibraryApi.ts:168
Remove Albums for the Current User

Remove one or more albums from the current user's library.

Parameters
- albumIds: string[]
  
  The Spotify IDs of the albums.
Returns Promise<void>

removeSavedShow

removeSavedShow(showId: string, options?: RemoveSavedShowsOptions): Promise<void>

- Defined in apis/LibraryApi.ts:184
Remove Show for the Current User

Remove a show from the current user's library.

Parameters
- showId: string
  
  The Spotify ID of the show.
- Optional options: RemoveSavedShowsOptions
  
  Optional request information.
Returns Promise<void>

removeSavedShows

removeSavedShows(showIds: string[], options?: RemoveSavedShowsOptions): Promise<void>

- Defined in apis/LibraryApi.ts:199
Remove Shows for the Current User

Remove one or more shows from the current user's library.

Parameters
- showIds: string[]
  
  The Spotify IDs of the shows.
- Optional options: RemoveSavedShowsOptions
  
  Optional request information.
Returns Promise<void>

removeSavedTrack

removeSavedTrack(trackId: string): Promise<void>

- Defined in apis/LibraryApi.ts:218
Remove Track for the Current User

Remove a track from the current user's library.

Parameters
- trackId: string
  
  The Spotify ID of the track.
Returns Promise<void>

removeSavedTracks

removeSavedTracks(trackIds: string[]): Promise<void>

- Defined in apis/LibraryApi.ts:229
Remove Tracks for the Current User

Remove one or more tracks from the current user's library.

Parameters
- trackIds: string[]
  
  The Spotify IDs of the tracks.
Returns Promise<void>

saveAlbum

saveAlbum(albumId: string): Promise<void>

- Defined in apis/LibraryApi.ts:244
Save Album for the Current User

Save an album to the current user's library.

Parameters
- albumId: string
  
  The Spotify ID of the album.
Returns Promise<void>

saveAlbums

saveAlbums(albumIds: string[]): Promise<void>

- Defined in apis/LibraryApi.ts:255
Save Albums for the Current User

Save one or more albums to the current user's library.

Parameters
- albumIds: string[]
  
  The Spotify IDs of the albums.
Returns Promise<void>

saveShow

saveShow(showId: string): Promise<void>

- Defined in apis/LibraryApi.ts:270
Save Show for the Current User

Save a show to the current user's library.

Parameters
- showId: string
  
  The Spotify ID of the show.
Returns Promise<void>

saveShows

saveShows(showIds: string[]): Promise<void>

- Defined in apis/LibraryApi.ts:281
Save Shows for the Current User

Save one or more shows to the current user's library.

Parameters
- showIds: string[]
  
  The Spotify IDs of the shows.
Returns Promise<void>

saveTrack

saveTrack(trackId: string): Promise<void>

- Defined in apis/LibraryApi.ts:296
Save Track for the Current User

Save a track to the current user's library.

Parameters
- trackId: string
  
  The Spotify ID of the track.
Returns Promise<void>

saveTracks

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

- Defined in apis/LibraryApi.ts:307
Save Tracks for the Current User

Save one or more tracks to the current user's library.

Parameters
- trackIds: string[]
  
  The Spotify IDs of the tracks.
Returns Promise<void>

Generated using TypeDoc