mirror of
https://github.com/Sarsoo/Spotify.NET.git
synced 2024-12-23 22:56:25 +00:00
Built mkdocs | Travis Build 16
This commit is contained in:
parent
8a5bf6b6bc
commit
a7d8f1e0c9
@ -107,6 +107,10 @@
|
|||||||
<a href="../SpotifyWebAPI/tracks/">- Tracks</a>
|
<a href="../SpotifyWebAPI/tracks/">- Tracks</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../SpotifyWebAPI/util/">- Util</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
@ -130,7 +134,7 @@
|
|||||||
<ul class="nav navbar-nav navbar-right">
|
<ul class="nav navbar-nav navbar-right">
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a rel="next" href="../SpotifyWebAPI/tracks/">
|
<a rel="next" href="../SpotifyWebAPI/util/">
|
||||||
<i class="fa fa-arrow-left"></i> Previous
|
<i class="fa fa-arrow-left"></i> Previous
|
||||||
</a>
|
</a>
|
||||||
</li>
|
</li>
|
||||||
|
@ -107,6 +107,10 @@
|
|||||||
<a href="../tracks/">- Tracks</a>
|
<a href="../tracks/">- Tracks</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../util/">- Util</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
@ -107,6 +107,10 @@
|
|||||||
<a href="../tracks/">- Tracks</a>
|
<a href="../tracks/">- Tracks</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../util/">- Util</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
@ -107,6 +107,10 @@
|
|||||||
<a href="../tracks/">- Tracks</a>
|
<a href="../tracks/">- Tracks</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../util/">- Util</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
@ -107,6 +107,10 @@
|
|||||||
<a href="../tracks/">- Tracks</a>
|
<a href="../tracks/">- Tracks</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../util/">- Util</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
@ -107,6 +107,10 @@
|
|||||||
<a href="../tracks/">- Tracks</a>
|
<a href="../tracks/">- Tracks</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../util/">- Util</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
@ -107,6 +107,10 @@
|
|||||||
<a href="../tracks/">- Tracks</a>
|
<a href="../tracks/">- Tracks</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../util/">- Util</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
@ -107,6 +107,10 @@
|
|||||||
<a href="../tracks/">- Tracks</a>
|
<a href="../tracks/">- Tracks</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../util/">- Util</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
@ -168,6 +172,8 @@
|
|||||||
|
|
||||||
<li><a href="#error-handling">Error-Handling</a></li>
|
<li><a href="#error-handling">Error-Handling</a></li>
|
||||||
|
|
||||||
|
<li><a href="#asynchronous">Asynchronous</a></li>
|
||||||
|
|
||||||
<li><a href="#api-reference">API-Reference</a></li>
|
<li><a href="#api-reference">API-Reference</a></li>
|
||||||
|
|
||||||
|
|
||||||
@ -223,6 +229,16 @@ if (profile.HasError())
|
|||||||
}
|
}
|
||||||
</code></pre>
|
</code></pre>
|
||||||
|
|
||||||
|
<h2 id="asynchronous">Asynchronous</h2>
|
||||||
|
<p>Every API-Call now has an asynchronous method. Just append <code>Async</code> to the Method-Name.<br />
|
||||||
|
Example:</p>
|
||||||
|
<pre><code class="cs">public async void Test()
|
||||||
|
{
|
||||||
|
var profile = await _spotify.GetPrivateProfileAsync();
|
||||||
|
Console.WriteLine(profile.DisplayName);
|
||||||
|
}
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
<hr />
|
<hr />
|
||||||
<h2 id="api-reference">API-Reference</h2>
|
<h2 id="api-reference">API-Reference</h2>
|
||||||
<h3 id="albums">Albums</h3>
|
<h3 id="albums">Albums</h3>
|
||||||
@ -291,6 +307,10 @@ if (profile.HasError())
|
|||||||
<ul>
|
<ul>
|
||||||
<li><a href="../../SpotifyWebAPI/tracks#getseveraltracks">GetSeveralTracks</a></li>
|
<li><a href="../../SpotifyWebAPI/tracks#getseveraltracks">GetSeveralTracks</a></li>
|
||||||
<li><a href="../../SpotifyWebAPI/tracks#gettrack">GetTrack</a></li>
|
<li><a href="../../SpotifyWebAPI/tracks#gettrack">GetTrack</a></li>
|
||||||
|
</ul>
|
||||||
|
<h3 id="util">Util</h3>
|
||||||
|
<ul>
|
||||||
|
<li><a href="../../SpotifyWebAPI/util">Utility-Functions</a></li>
|
||||||
</ul></div>
|
</ul></div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -107,6 +107,10 @@
|
|||||||
<a href="../tracks/">- Tracks</a>
|
<a href="../tracks/">- Tracks</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../util/">- Util</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
@ -107,6 +107,10 @@
|
|||||||
<a href="../tracks/">- Tracks</a>
|
<a href="../tracks/">- Tracks</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../util/">- Util</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
@ -107,6 +107,10 @@
|
|||||||
<a href="../tracks/">- Tracks</a>
|
<a href="../tracks/">- Tracks</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../util/">- Util</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
@ -107,6 +107,10 @@
|
|||||||
<a href="../tracks/">- Tracks</a>
|
<a href="../tracks/">- Tracks</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../util/">- Util</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
@ -107,6 +107,10 @@
|
|||||||
<a href="./">- Tracks</a>
|
<a href="./">- Tracks</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../util/">- Util</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
@ -135,7 +139,7 @@
|
|||||||
</a>
|
</a>
|
||||||
</li>
|
</li>
|
||||||
<li >
|
<li >
|
||||||
<a rel="prev" href="../../SpotifyLocalAPI/">
|
<a rel="prev" href="../util/">
|
||||||
Next <i class="fa fa-arrow-right"></i>
|
Next <i class="fa fa-arrow-right"></i>
|
||||||
</a>
|
</a>
|
||||||
</li>
|
</li>
|
||||||
|
195
SpotifyWebAPI/util/index.html
Normal file
195
SpotifyWebAPI/util/index.html
Normal file
@ -0,0 +1,195 @@
|
|||||||
|
<!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>- Util - 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>
|
||||||
|
|
||||||
|
<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 >
|
||||||
|
<a href="../library/">- Library</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 class="active">
|
||||||
|
<a href="./">- Util</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="dropdown">
|
||||||
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalAPI <b class="caret"></b></a>
|
||||||
|
<ul class="dropdown-menu">
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../SpotifyLocalAPI/">SpotifyLocalAPI</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<!-- Search, Navigation and Repo links -->
|
||||||
|
<ul class="nav navbar-nav navbar-right">
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a rel="next" href="../tracks/">
|
||||||
|
<i class="fa fa-arrow-left"></i> Previous
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li >
|
||||||
|
<a rel="prev" href="../../SpotifyLocalAPI/">
|
||||||
|
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="#paging-methods">Paging-Methods</a></li>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div></div>
|
||||||
|
<div class="col-md-9" role="main">
|
||||||
|
|
||||||
|
<h2 id="paging-methods">Paging-Methods</h2>
|
||||||
|
<p>The <code>SpotifyWebAPI</code> features two paging-helper Methods, <code>GetNextPage()</code> and <code>GetPreviousPage()</code>.
|
||||||
|
Both are an easy way to receive the next/previous page of a Paging-Object.</p>
|
||||||
|
<p>Sample:</p>
|
||||||
|
<pre><code class="csharp">var playlistTracks = _spotify.GetPlaylistTracks("1122095781", "4EcNf2l8rXInbJOf3tQdgU", "", 50);
|
||||||
|
while (true)
|
||||||
|
{
|
||||||
|
Console.WriteLine(playlistTracks.Items.Count);
|
||||||
|
if (!playlistTracks.HasNextPage())
|
||||||
|
break;
|
||||||
|
playlistTracks = _spotify.GetNextPage(playlistTracks);
|
||||||
|
}
|
||||||
|
</code></pre></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<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="//cdnjs.cloudflare.com/ajax/libs/highlight.js/8.4/highlight.min.js"></script>
|
||||||
|
<script src="../../highlight.js"></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
@ -107,6 +107,10 @@
|
|||||||
<a href="SpotifyWebAPI/tracks/">- Tracks</a>
|
<a href="SpotifyWebAPI/tracks/">- Tracks</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="SpotifyWebAPI/util/">- Util</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
@ -27,7 +27,7 @@
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"location": "/SpotifyWebAPI/gettingstarted/",
|
"location": "/SpotifyWebAPI/gettingstarted/",
|
||||||
"text": "Getting started\n\n\nThis API provides full access to the new SpotifyWebAPI introduced \nhere\n.\n\nWith it, you can search for Tracks/Albums/Artists and also get User-based information.\n\nIt's also possible to create new playlists and add tracks to it.\n\n\n\n\nFirst steps\n\n\nImports\n\nSo after you added the API to your project, you may want to add following imports to your files:\n\n\nusing SpotifyAPI.Web; //Base Namespace\nusing SpotifyAPI.Web.Auth; //All Authentication-related classes\nusing SpotifyAPI.Web.Enums; //Enums\nusing SpotifyAPI.Web.Models; //Models for the JSON-responses\n\n\n\n\nBasic-Usage\n\nNow you can actually start doing calls to the SpotifyAPI, just create a new Instance of SpotifyWebAPI:\n\n\nprivate static SpotifyWebAPI _spotify;\n\npublic static void Main(String[] args)\n{\n _spotify = new SpotifyWebAPI()\n {\n UseAuth = false, //This will disable Authentication.\n }\n FullTrack track = _spotify.GetTrack(\n3Hvu1pq89D4R0lyPBoujSv\n);\n Console.WriteLine(track.Name); //Yeay! We just printed a tracks name.\n //...\n}\n\n\n\n\n\n\nAuthentication\n\n\nIf you look through the available API-Methods, you will soon notice nearly all of them require Authentication.\nFurther infos on how to implement Authentication can be found \nhere\n\n\n\n\nExamples\n\n\nA list of small examples can be found \nhere\n. Do you think a specific example is missing? Feel free to open a PR/Issue!\n\n\n\n\nError-Handling\n\n\nEvery API-Call returns a reponse-model which consists of base-error model. To check if a specific API-Call was successful, use the following approach:\n\n\nPrivateProfile profile = _spotify.GetPrivateProfile();\nif (profile.HasError())\n{\n Console.WriteLine(\nError Status: \n + profile.Error.Status);\n Console.WriteLine(\nError Msg: \n + profile.Error.Message);\n}\n\n\n\n\n\n\nAPI-Reference\n\n\nAlbums\n\n\n\n\nGetAlbumTracks\n\n\nGetAlbum\n\n\nGetSeveralAlbums\n\n\n\n\nArtists\n\n\n\n\nGetArtist\n\n\nGetRelatedArtists\n\n\nGetArtistsTopTracks\n\n\nGetArtistsAlbums\n\n\nGetSeveralArtists\n\n\n\n\nBrowse\n\n\n\n\nGetFeaturedPlaylists\n\n\nGetNewAlbumReleases\n\n\nGetCategories\n\n\nGetCategory\n\n\nGetCategoryPlaylists\n\n\n\n\nFollow\n\n\n\n\nFollow\n\n\nUnfollow\n\n\nIsFollowing\n\n\nFollowPlaylist\n\n\nUnfollowPlaylist\n\n\nIsFollowingPlaylist\n\n\n\n\nLibrary\n\n\n\n\nSaveTracks\n\n\nSaveTrack\n\n\nGetSavedTracks\n\n\nRemoveSavedTracks\n\n\nCheckSavedTracks\n\n\n\n\nPlaylists\n\n\n\n\nGetUserPlaylists\n\n\nGetPlaylist\n\n\nGetPlaylistTracks\n\n\nCreatePlaylist\n\n\nUpdatePlaylist\n\n\nReplacePlaylistTracks\n\n\nRemovePlaylistTracks\n\n\nRemovePlaylistTrack\n\n\nAddPlaylistTracks\n\n\nAddPlaylistTrack\n\n\nReorderPlaylist\n\n\n\n\nProfiles\n\n\n\n\nGetPublicProfile\n\n\nGetPrivateProfile\n\n\n\n\nSearch\n\n\n\n\nSearchItems\n\n\n\n\nTracks\n\n\n\n\nGetSeveralTracks\n\n\nGetTrack",
|
"text": "Getting started\n\n\nThis API provides full access to the new SpotifyWebAPI introduced \nhere\n.\n\nWith it, you can search for Tracks/Albums/Artists and also get User-based information.\n\nIt's also possible to create new playlists and add tracks to it.\n\n\n\n\nFirst steps\n\n\nImports\n\nSo after you added the API to your project, you may want to add following imports to your files:\n\n\nusing SpotifyAPI.Web; //Base Namespace\nusing SpotifyAPI.Web.Auth; //All Authentication-related classes\nusing SpotifyAPI.Web.Enums; //Enums\nusing SpotifyAPI.Web.Models; //Models for the JSON-responses\n\n\n\n\nBasic-Usage\n\nNow you can actually start doing calls to the SpotifyAPI, just create a new Instance of SpotifyWebAPI:\n\n\nprivate static SpotifyWebAPI _spotify;\n\npublic static void Main(String[] args)\n{\n _spotify = new SpotifyWebAPI()\n {\n UseAuth = false, //This will disable Authentication.\n }\n FullTrack track = _spotify.GetTrack(\n3Hvu1pq89D4R0lyPBoujSv\n);\n Console.WriteLine(track.Name); //Yeay! We just printed a tracks name.\n //...\n}\n\n\n\n\n\n\nAuthentication\n\n\nIf you look through the available API-Methods, you will soon notice nearly all of them require Authentication.\nFurther infos on how to implement Authentication can be found \nhere\n\n\n\n\nExamples\n\n\nA list of small examples can be found \nhere\n. Do you think a specific example is missing? Feel free to open a PR/Issue!\n\n\n\n\nError-Handling\n\n\nEvery API-Call returns a reponse-model which consists of base-error model. To check if a specific API-Call was successful, use the following approach:\n\n\nPrivateProfile profile = _spotify.GetPrivateProfile();\nif (profile.HasError())\n{\n Console.WriteLine(\nError Status: \n + profile.Error.Status);\n Console.WriteLine(\nError Msg: \n + profile.Error.Message);\n}\n\n\n\n\nAsynchronous\n\n\nEvery API-Call now has an asynchronous method. Just append \nAsync\n to the Method-Name.\n\nExample:\n\n\npublic async void Test()\n{\n var profile = await _spotify.GetPrivateProfileAsync();\n Console.WriteLine(profile.DisplayName);\n}\n\n\n\n\n\n\nAPI-Reference\n\n\nAlbums\n\n\n\n\nGetAlbumTracks\n\n\nGetAlbum\n\n\nGetSeveralAlbums\n\n\n\n\nArtists\n\n\n\n\nGetArtist\n\n\nGetRelatedArtists\n\n\nGetArtistsTopTracks\n\n\nGetArtistsAlbums\n\n\nGetSeveralArtists\n\n\n\n\nBrowse\n\n\n\n\nGetFeaturedPlaylists\n\n\nGetNewAlbumReleases\n\n\nGetCategories\n\n\nGetCategory\n\n\nGetCategoryPlaylists\n\n\n\n\nFollow\n\n\n\n\nFollow\n\n\nUnfollow\n\n\nIsFollowing\n\n\nFollowPlaylist\n\n\nUnfollowPlaylist\n\n\nIsFollowingPlaylist\n\n\n\n\nLibrary\n\n\n\n\nSaveTracks\n\n\nSaveTrack\n\n\nGetSavedTracks\n\n\nRemoveSavedTracks\n\n\nCheckSavedTracks\n\n\n\n\nPlaylists\n\n\n\n\nGetUserPlaylists\n\n\nGetPlaylist\n\n\nGetPlaylistTracks\n\n\nCreatePlaylist\n\n\nUpdatePlaylist\n\n\nReplacePlaylistTracks\n\n\nRemovePlaylistTracks\n\n\nRemovePlaylistTrack\n\n\nAddPlaylistTracks\n\n\nAddPlaylistTrack\n\n\nReorderPlaylist\n\n\n\n\nProfiles\n\n\n\n\nGetPublicProfile\n\n\nGetPrivateProfile\n\n\n\n\nSearch\n\n\n\n\nSearchItems\n\n\n\n\nTracks\n\n\n\n\nGetSeveralTracks\n\n\nGetTrack\n\n\n\n\nUtil\n\n\n\n\nUtility-Functions",
|
||||||
"title": "Getting started"
|
"title": "Getting started"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@ -55,9 +55,14 @@
|
|||||||
"text": "Every API-Call returns a reponse-model which consists of base-error model. To check if a specific API-Call was successful, use the following approach: PrivateProfile profile = _spotify.GetPrivateProfile();\nif (profile.HasError())\n{\n Console.WriteLine( Error Status: + profile.Error.Status);\n Console.WriteLine( Error Msg: + profile.Error.Message);\n}",
|
"text": "Every API-Call returns a reponse-model which consists of base-error model. To check if a specific API-Call was successful, use the following approach: PrivateProfile profile = _spotify.GetPrivateProfile();\nif (profile.HasError())\n{\n Console.WriteLine( Error Status: + profile.Error.Status);\n Console.WriteLine( Error Msg: + profile.Error.Message);\n}",
|
||||||
"title": "Error-Handling"
|
"title": "Error-Handling"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"location": "/SpotifyWebAPI/gettingstarted/#asynchronous",
|
||||||
|
"text": "Every API-Call now has an asynchronous method. Just append Async to the Method-Name. \nExample: public async void Test()\n{\n var profile = await _spotify.GetPrivateProfileAsync();\n Console.WriteLine(profile.DisplayName);\n}",
|
||||||
|
"title": "Asynchronous"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"location": "/SpotifyWebAPI/gettingstarted/#api-reference",
|
"location": "/SpotifyWebAPI/gettingstarted/#api-reference",
|
||||||
"text": "Albums GetAlbumTracks GetAlbum GetSeveralAlbums Artists GetArtist GetRelatedArtists GetArtistsTopTracks GetArtistsAlbums GetSeveralArtists Browse GetFeaturedPlaylists GetNewAlbumReleases GetCategories GetCategory GetCategoryPlaylists Follow Follow Unfollow IsFollowing FollowPlaylist UnfollowPlaylist IsFollowingPlaylist Library SaveTracks SaveTrack GetSavedTracks RemoveSavedTracks CheckSavedTracks Playlists GetUserPlaylists GetPlaylist GetPlaylistTracks CreatePlaylist UpdatePlaylist ReplacePlaylistTracks RemovePlaylistTracks RemovePlaylistTrack AddPlaylistTracks AddPlaylistTrack ReorderPlaylist Profiles GetPublicProfile GetPrivateProfile Search SearchItems Tracks GetSeveralTracks GetTrack",
|
"text": "Albums GetAlbumTracks GetAlbum GetSeveralAlbums Artists GetArtist GetRelatedArtists GetArtistsTopTracks GetArtistsAlbums GetSeveralArtists Browse GetFeaturedPlaylists GetNewAlbumReleases GetCategories GetCategory GetCategoryPlaylists Follow Follow Unfollow IsFollowing FollowPlaylist UnfollowPlaylist IsFollowingPlaylist Library SaveTracks SaveTrack GetSavedTracks RemoveSavedTracks CheckSavedTracks Playlists GetUserPlaylists GetPlaylist GetPlaylistTracks CreatePlaylist UpdatePlaylist ReplacePlaylistTracks RemovePlaylistTracks RemovePlaylistTrack AddPlaylistTracks AddPlaylistTrack ReorderPlaylist Profiles GetPublicProfile GetPrivateProfile Search SearchItems Tracks GetSeveralTracks GetTrack Util Utility-Functions",
|
||||||
"title": "API-Reference"
|
"title": "API-Reference"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@ -340,6 +345,16 @@
|
|||||||
"text": "Get Spotify catalog information for a single track identified by its unique Spotify ID. Paramters Name Description Example id The Spotify ID for the track. \"6Y1CLPwYe7zvI8PJiWVz6T\" market An ISO 3166-1 alpha-2 country code. Provide this parameter if you want to apply Track Relinking. \"DE\" Returns a FullTrack Usage FullTrack track = _spotify.GetTrack( 6Y1CLPwYe7zvI8PJiWVz6T );\nConsole.WriteLine(track.Name);",
|
"text": "Get Spotify catalog information for a single track identified by its unique Spotify ID. Paramters Name Description Example id The Spotify ID for the track. \"6Y1CLPwYe7zvI8PJiWVz6T\" market An ISO 3166-1 alpha-2 country code. Provide this parameter if you want to apply Track Relinking. \"DE\" Returns a FullTrack Usage FullTrack track = _spotify.GetTrack( 6Y1CLPwYe7zvI8PJiWVz6T );\nConsole.WriteLine(track.Name);",
|
||||||
"title": "GetTrack"
|
"title": "GetTrack"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"location": "/SpotifyWebAPI/util/",
|
||||||
|
"text": "Paging-Methods\n\n\nThe \nSpotifyWebAPI\n features two paging-helper Methods, \nGetNextPage()\n and \nGetPreviousPage()\n.\nBoth are an easy way to receive the next/previous page of a Paging-Object.\n\n\nSample:\n\n\nvar playlistTracks = _spotify.GetPlaylistTracks(\n1122095781\n, \n4EcNf2l8rXInbJOf3tQdgU\n, \n, 50);\nwhile (true)\n{\n Console.WriteLine(playlistTracks.Items.Count);\n if (!playlistTracks.HasNextPage())\n break;\n playlistTracks = _spotify.GetNextPage(playlistTracks);\n}",
|
||||||
|
"title": "- Util"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"location": "/SpotifyWebAPI/util/#paging-methods",
|
||||||
|
"text": "The SpotifyWebAPI features two paging-helper Methods, GetNextPage() and GetPreviousPage() .\nBoth are an easy way to receive the next/previous page of a Paging-Object. Sample: var playlistTracks = _spotify.GetPlaylistTracks( 1122095781 , 4EcNf2l8rXInbJOf3tQdgU , , 50);\nwhile (true)\n{\n Console.WriteLine(playlistTracks.Items.Count);\n if (!playlistTracks.HasNextPage())\n break;\n playlistTracks = _spotify.GetNextPage(playlistTracks);\n}",
|
||||||
|
"title": "Paging-Methods"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"location": "/SpotifyLocalAPI/",
|
"location": "/SpotifyLocalAPI/",
|
||||||
"text": "WIP",
|
"text": "WIP",
|
||||||
|
34
sitemap.xml
34
sitemap.xml
@ -4,7 +4,7 @@
|
|||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>None/</loc>
|
<loc>None/</loc>
|
||||||
<lastmod>2015-07-26</lastmod>
|
<lastmod>2015-11-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
@ -13,73 +13,79 @@
|
|||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>None/SpotifyWebAPI/gettingstarted/</loc>
|
<loc>None/SpotifyWebAPI/gettingstarted/</loc>
|
||||||
<lastmod>2015-07-26</lastmod>
|
<lastmod>2015-11-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>None/SpotifyWebAPI/examples/</loc>
|
<loc>None/SpotifyWebAPI/examples/</loc>
|
||||||
<lastmod>2015-07-26</lastmod>
|
<lastmod>2015-11-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>None/SpotifyWebAPI/auth/</loc>
|
<loc>None/SpotifyWebAPI/auth/</loc>
|
||||||
<lastmod>2015-07-26</lastmod>
|
<lastmod>2015-11-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>None/SpotifyWebAPI/albums/</loc>
|
<loc>None/SpotifyWebAPI/albums/</loc>
|
||||||
<lastmod>2015-07-26</lastmod>
|
<lastmod>2015-11-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>None/SpotifyWebAPI/artists/</loc>
|
<loc>None/SpotifyWebAPI/artists/</loc>
|
||||||
<lastmod>2015-07-26</lastmod>
|
<lastmod>2015-11-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>None/SpotifyWebAPI/browse/</loc>
|
<loc>None/SpotifyWebAPI/browse/</loc>
|
||||||
<lastmod>2015-07-26</lastmod>
|
<lastmod>2015-11-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>None/SpotifyWebAPI/follow/</loc>
|
<loc>None/SpotifyWebAPI/follow/</loc>
|
||||||
<lastmod>2015-07-26</lastmod>
|
<lastmod>2015-11-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>None/SpotifyWebAPI/library/</loc>
|
<loc>None/SpotifyWebAPI/library/</loc>
|
||||||
<lastmod>2015-07-26</lastmod>
|
<lastmod>2015-11-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>None/SpotifyWebAPI/playlists/</loc>
|
<loc>None/SpotifyWebAPI/playlists/</loc>
|
||||||
<lastmod>2015-07-26</lastmod>
|
<lastmod>2015-11-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>None/SpotifyWebAPI/profiles/</loc>
|
<loc>None/SpotifyWebAPI/profiles/</loc>
|
||||||
<lastmod>2015-07-26</lastmod>
|
<lastmod>2015-11-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>None/SpotifyWebAPI/search/</loc>
|
<loc>None/SpotifyWebAPI/search/</loc>
|
||||||
<lastmod>2015-07-26</lastmod>
|
<lastmod>2015-11-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>None/SpotifyWebAPI/tracks/</loc>
|
<loc>None/SpotifyWebAPI/tracks/</loc>
|
||||||
<lastmod>2015-07-26</lastmod>
|
<lastmod>2015-11-07</lastmod>
|
||||||
|
<changefreq>daily</changefreq>
|
||||||
|
</url>
|
||||||
|
|
||||||
|
<url>
|
||||||
|
<loc>None/SpotifyWebAPI/util/</loc>
|
||||||
|
<lastmod>2015-11-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
@ -89,7 +95,7 @@
|
|||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>None/SpotifyLocalAPI/</loc>
|
<loc>None/SpotifyLocalAPI/</loc>
|
||||||
<lastmod>2015-07-26</lastmod>
|
<lastmod>2015-11-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user