2017-10-27 16:37:28 +01:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta name = "author" content = "JohnnyCrazy" >
< link rel = "shortcut icon" href = "../../img/favicon.ico" >
< title > - Library - SpotifyAPI-NET< / title >
< link href = "../../css/bootstrap-custom.min.css" rel = "stylesheet" >
< link href = "../../css/font-awesome-4.0.3.css" rel = "stylesheet" >
< link href = "../../css/prettify-1.0.css" rel = "stylesheet" >
< link href = "../../css/base.css" rel = "stylesheet" >
< link rel = "stylesheet" href = "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.6/styles/agate.min.css" >
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- [if lt IE 9]>
< script src = "https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js" > < / script >
< script src = "https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js" > < / script >
<![endif]-->
< / head >
< body >
< div class = "navbar navbar-default navbar-fixed-top" role = "navigation" >
< div class = "container" >
<!-- Collapsed navigation -->
< div class = "navbar-header" >
<!-- Expander button -->
< button type = "button" class = "navbar-toggle" data-toggle = "collapse" data-target = ".navbar-collapse" >
< span class = "sr-only" > Toggle navigation< / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< / button >
<!-- Main title -->
< a class = "navbar-brand" href = "../.." > SpotifyAPI-NET< / a >
< / div >
<!-- Expanded navigation -->
< div class = "navbar-collapse collapse" >
<!-- Main navigation -->
< ul class = "nav navbar-nav" >
< li >
< a href = "../.." > Home< / a >
< / li >
< li class = "dropdown active" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > SpotifyWebAPI < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
< li >
< a href = "../gettingstarted/" > Getting started< / a >
< / li >
< li >
< a href = "../examples/" > Examples< / a >
< / li >
< li >
< a href = "../auth/" > Authentication< / a >
< / li >
2018-03-25 18:58:06 +01:00
< li >
< a href = "../proxy/" > Proxy< / a >
< / li >
2017-10-27 16:37:28 +01:00
< li >
< a href = "../albums/" > - Albums< / a >
< / li >
< li >
< a href = "../artists/" > - Artists< / a >
< / li >
< li >
< a href = "../browse/" > - Browse< / a >
< / li >
< li >
< a href = "../follow/" > - Follow< / a >
< / li >
< li class = "active" >
< a href = "./" > - Library< / a >
< / li >
2018-01-15 22:33:15 +00:00
< li >
< a href = "../personalization/" > - Personalization< / a >
< / li >
2017-10-27 16:37:28 +01:00
< li >
< a href = "../player/" > - Player< / a >
< / li >
< li >
< a href = "../playlists/" > - Playlists< / a >
< / li >
< li >
< a href = "../profiles/" > - Profiles< / a >
< / li >
< li >
< a href = "../search/" > - Search< / a >
< / li >
< li >
< a href = "../tracks/" > - Tracks< / a >
< / li >
< li >
< a href = "../util/" > - Util< / a >
< / li >
< / ul >
< / li >
< li >
< a href = "../../SpotifyLocalAPI/" > SpotifyLocalAPI< / a >
< / li >
< / ul >
<!-- Search, Navigation and Repo links -->
< ul class = "nav navbar-nav navbar-right" >
< li >
< a rel = "next" href = "../follow/" >
< i class = "fa fa-arrow-left" > < / i > Previous
< / a >
< / li >
< li >
2018-01-15 22:33:15 +00:00
< a rel = "prev" href = "../personalization/" >
2017-10-27 16:37:28 +01:00
Next < i class = "fa fa-arrow-right" > < / i >
< / a >
< / li >
< li >
< a href = "https://github.com/JohnnyCrazy/SpotifyAPI-NET" >
< i class = "fa fa-github" > < / i >
GitHub
< / a >
< / li >
< / ul >
< / div >
< / div >
< / div >
< div class = "container" >
< div class = "col-md-3" > < div class = "bs-sidebar hidden-print affix well" role = "complementary" style = "height=90%;" >
< ul class = "nav bs-sidenav" >
< li class = "main active" > < a href = "#savetracks" > SaveTracks< / a > < / li >
< li class = "main " > < a href = "#savetrack" > SaveTrack< / a > < / li >
< li class = "main " > < a href = "#getsavedtracks" > GetSavedTracks< / a > < / li >
< li class = "main " > < a href = "#removesavedtracks" > RemoveSavedTracks< / a > < / li >
< li class = "main " > < a href = "#checksavedtracks" > CheckSavedTracks< / a > < / li >
< li class = "main " > < a href = "#savealbums" > SaveAlbums< / a > < / li >
< li class = "main " > < a href = "#savealbum" > SaveAlbum< / a > < / li >
< li class = "main " > < a href = "#getsavedalbums" > GetSavedAlbums< / a > < / li >
< li class = "main " > < a href = "#removesavedalbums" > RemoveSavedAlbums< / a > < / li >
< li class = "main " > < a href = "#checksavedalbums" > CheckSavedAlbums< / a > < / li >
< / ul >
< / div > < / div >
< div class = "col-md-9" role = "main" >
< h2 id = "savetracks" > SaveTracks< / h2 >
< p > < span class = "label label-warning" > AUTH REQUIRED< / span > < / p >
< blockquote >
< p > Save one or more tracks to the current user’ < / p >
< / blockquote >
< p > < strong > Paramters< / strong > < / p >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Description< / th >
< th > Example< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > ids< / td >
< td > A list of the Spotify IDs< / td >
< td > < code > new List< String> { "3Hvu1pq89D4R0lyPBoujSv" }< / code > < / td >
< / tr >
< / tbody >
< / table >
< p > Returns a < strong > ErrorResponse< / strong > which just contains a possible error. (< code > response.HasError()< / code > and < code > response.Error< / code > )< / p >
< p > < strong > Usage< / strong > < / p >
< pre > < code class = "cs" > ErrorResponse response = _spotify.SaveTracks(new List< string> { " 3Hvu1pq89D4R0lyPBoujSv" });
if(!response.HasError())
Console.WriteLine(" success" );
< / code > < / pre >
< hr / >
< h2 id = "savetrack" > SaveTrack< / h2 >
< p > < span class = "label label-warning" > AUTH REQUIRED< / span > < / p >
< blockquote >
< p > Save one track to the current user’ < / p >
< / blockquote >
< p > < strong > Paramters< / strong > < / p >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Description< / th >
< th > Example< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > id< / td >
< td > A Spotify ID< / td >
< td > < code > "3Hvu1pq89D4R0lyPBoujSv"< / code > < / td >
< / tr >
< / tbody >
< / table >
< p > Returns a < strong > ErrorResponse< / strong > which just contains a possible error. (< code > response.HasError()< / code > and < code > response.Error< / code > )< / p >
< p > < strong > Usage< / strong > < / p >
< pre > < code class = "cs" > ErrorResponse response = _spotify.SaveTrack(" 3Hvu1pq89D4R0lyPBoujSv" );
if(!response.HasError())
Console.WriteLine(" success" );
< / code > < / pre >
< hr / >
< h2 id = "getsavedtracks" > GetSavedTracks< / h2 >
< p > < span class = "label label-warning" > AUTH REQUIRED< / span > < / p >
< blockquote >
< p > Get a list of the songs saved in the current Spotify user’ < / p >
< / blockquote >
< p > < strong > Paramters< / strong > < / p >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Description< / th >
< th > Example< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > [limit]< / td >
< td > The maximum number of objects to return. Default: 20. Minimum: 1. Maximum: 50.< / td >
< td > < code > 20< / code > < / td >
< / tr >
< tr >
< td > [offset]< / td >
< td > The index of the first object to return. Default: 0 (i.e., the first object)< / td >
< td > < code > 0< / code > < / td >
< / tr >
< tr >
< td > [market]< / td >
< td > An ISO 3166-1 alpha-2 country code. Provide this parameter if you want to apply Track Relinking.< / td >
< td > < code > DE< / code > < / td >
< / tr >
< / tbody >
< / table >
< p > Returns a < strong > Paging< SavedTrack > < / strong > , < strong > SavedTrack< / strong > contains 2 properties, < code > DateTime AddedAt< / code > and < code > FullTrack Track< / code > < / p >
< p > < strong > Usage< / strong > < / p >
< pre > < code class = "cs" > Paging< SavedTrack> savedTracks = _spotify.GetSavedTracks();
savedTracks.Items.ForEach(track => Console.WriteLine(track.Track.Name));
< / code > < / pre >
< hr / >
< h2 id = "removesavedtracks" > RemoveSavedTracks< / h2 >
< p > < span class = "label label-warning" > AUTH REQUIRED< / span > < / p >
< blockquote >
< p > Remove one or more tracks from the current user’ < / p >
< / blockquote >
< p > < strong > Paramters< / strong > < / p >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Description< / th >
< th > Example< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > ids< / td >
< td > A list of the Spotify IDs.< / td >
< td > < code > new List< String> { "3Hvu1pq89D4R0lyPBoujSv" }< / code > < / td >
< / tr >
< / tbody >
< / table >
< p > Returns a < strong > ErrorResponse< / strong > which just contains a possible error. (< code > response.HasError()< / code > and < code > response.Error< / code > )< / p >
< p > < strong > Usage< / strong > < / p >
< pre > < code class = "cs" > ErrorResponse response = _spotify.RemoveSavedTracks(new List< string> { " 3Hvu1pq89D4R0lyPBoujSv" });
if(!response.HasError())
Console.WriteLine(" success" );
< / code > < / pre >
< hr / >
< h2 id = "checksavedtracks" > CheckSavedTracks< / h2 >
< p > < span class = "label label-warning" > AUTH REQUIRED< / span > < / p >
< blockquote >
< p > Check if one or more tracks is already saved in the current Spotify user’ < / p >
< / blockquote >
< p > < strong > Paramters< / strong > < / p >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Description< / th >
< th > Example< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > ids< / td >
< td > A list of the Spotify IDs.< / td >
< td > < code > new List< String> { "3Hvu1pq89D4R0lyPBoujSv" }< / code > < / td >
< / tr >
< / tbody >
< / table >
< p > Returns a < strong > ListResponse< bool > < / strong > which contains a property, < code > List< bool> List< / code > < / p >
< p > < strong > Usage< / strong > < / p >
< pre > < code class = "cs" > ListResponse< bool> tracksSaved = _spotify.CheckSavedTracks(new List< String> { " 3Hvu1pq89D4R0lyPBoujSv" });
if(tracksSaved.List[0])
Console.WriteLine(" The track is in your library!" );
< / code > < / pre >
< hr / >
< h2 id = "savealbums" > SaveAlbums< / h2 >
< p > < span class = "label label-warning" > AUTH REQUIRED< / span > < / p >
< blockquote >
< p > Save one or more albums to the current user’ < / p >
< / blockquote >
< p > < strong > Paramters< / strong > < / p >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Description< / th >
< th > Example< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > ids< / td >
< td > A list of the Spotify IDs< / td >
< td > < code > new List< String> { "1cq06d0kTUnFmJHixz1RaF" }< / code > < / td >
< / tr >
< / tbody >
< / table >
< p > Returns a < strong > ErrorResponse< / strong > which just contains a possible error. (< code > response.HasError()< / code > and < code > response.Error< / code > )< / p >
< p > < strong > Usage< / strong > < / p >
< pre > < code class = "cs" > ErrorResponse response = _spotify.SaveAlbums(new List< string> { " 1cq06d0kTUnFmJHixz1RaF" });
if(!response.HasError())
Console.WriteLine(" success" );
< / code > < / pre >
< hr / >
< h2 id = "savealbum" > SaveAlbum< / h2 >
< p > < span class = "label label-warning" > AUTH REQUIRED< / span > < / p >
< blockquote >
< p > Save one album to the current user’ < / p >
< / blockquote >
< p > < strong > Paramters< / strong > < / p >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Description< / th >
< th > Example< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > id< / td >
< td > A Spotify ID< / td >
< td > < code > "1cq06d0kTUnFmJHixz1RaF"< / code > < / td >
< / tr >
< / tbody >
< / table >
< p > Returns a < strong > ErrorResponse< / strong > which just contains a possible error. (< code > response.HasError()< / code > and < code > response.Error< / code > )< / p >
< p > < strong > Usage< / strong > < / p >
< pre > < code class = "cs" > ErrorResponse response = _spotify.SaveAlbum(" 1cq06d0kTUnFmJHixz1RaF" );
if(!response.HasError())
Console.WriteLine(" success" );
< / code > < / pre >
< hr / >
< h2 id = "getsavedalbums" > GetSavedAlbums< / h2 >
< p > < span class = "label label-warning" > AUTH REQUIRED< / span > < / p >
< blockquote >
< p > Get a list of the albums saved in the current Spotify user’ < / p >
< / blockquote >
< p > < strong > Paramters< / strong > < / p >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Description< / th >
< th > Example< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > [limit]< / td >
< td > The maximum number of objects to return. Default: 20. Minimum: 1. Maximum: 50.< / td >
< td > < code > 20< / code > < / td >
< / tr >
< tr >
< td > [offset]< / td >
< td > The index of the first object to return. Default: 0 (i.e., the first object)< / td >
< td > < code > 0< / code > < / td >
< / tr >
< tr >
< td > [market]< / td >
< td > An ISO 3166-1 alpha-2 country code. Provide this parameter if you want to apply Track Relinking.< / td >
< td > < code > DE< / code > < / td >
< / tr >
< / tbody >
< / table >
< p > Returns a < code > Paging< SavedAlbum> < / code > , < strong > SavedAlbum< / strong > contains 2 properties, < code > DateTime AddedAt< / code > and < code > FullAlbum Album< / code > < / p >
< p > < strong > Usage< / strong > < / p >
< pre > < code class = "cs" > Paging< SavedAlbum> savedAlbums = _spotify.GetSavedAlbums();
savedAlbums.Items.ForEach(album => Console.WriteLine(album.Album.Name));
< / code > < / pre >
< hr / >
< h2 id = "removesavedalbums" > RemoveSavedAlbums< / h2 >
< p > < span class = "label label-warning" > AUTH REQUIRED< / span > < / p >
< blockquote >
< p > Remove one or more albums from the current user’ < / p >
< / blockquote >
< p > < strong > Paramters< / strong > < / p >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Description< / th >
< th > Example< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > ids< / td >
< td > A list of the Spotify IDs.< / td >
< td > < code > new List< String> { "1cq06d0kTUnFmJHixz1RaF" }< / code > < / td >
< / tr >
< / tbody >
< / table >
< p > Returns a < strong > ErrorResponse< / strong > which just contains a possible error. (< code > response.HasError()< / code > and < code > response.Error< / code > )< / p >
< p > < strong > Usage< / strong > < / p >
< pre > < code class = "cs" > ErrorResponse response = _spotify.RemoveSavedAlbums(new List< string> { " 1cq06d0kTUnFmJHixz1RaF" });
if(!response.HasError())
Console.WriteLine(" success" );
< / code > < / pre >
< hr / >
< h2 id = "checksavedalbums" > CheckSavedAlbums< / h2 >
< p > < span class = "label label-warning" > AUTH REQUIRED< / span > < / p >
< blockquote >
< p > Check if one or more albums is already saved in the current Spotify user’ < / p >
< / blockquote >
< p > < strong > Paramters< / strong > < / p >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Description< / th >
< th > Example< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > ids< / td >
< td > A list of the Spotify IDs.< / td >
< td > < code > new List< String> { "1cq06d0kTUnFmJHixz1RaF" }< / code > < / td >
< / tr >
< / tbody >
< / table >
< p > Returns a < strong > ListResponse< bool > < / strong > which contains a property, < code > List< bool> List< / code > < / p >
< p > < strong > Usage< / strong > < / p >
< pre > < code class = "cs" > ListResponse< bool> albumsSaved = _spotify.CheckSavedAlbums(new List< String> { " 1cq06d0kTUnFmJHixz1RaF" });
if(albumsSaved.List[0])
Console.WriteLine(" The album is in your library!" );
< / code > < / pre >
< hr / > < / div >
< / div >
< script src = "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.4/highlight.min.js" > < / script >
< script src = "https://code.jquery.com/jquery-1.10.2.min.js" > < / script >
< script src = "../../js/bootstrap-3.0.3.min.js" > < / script >
< script src = "../../js/base.js" > < / script >
< script src = "../../highlight.js" > < / script >
< / body >
< / html >
