sarsoo/Spotify.NET
1
0
Fork 0
mirror of https://github.com/Sarsoo/Spotify.NET.git synced 2024-12-23 14:46:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Built mkdocs | Travis Build 14

Browse Source
This commit is contained in:
Travis-CI 2015-07-26 14:22:35 +00:00
parent 79517c8af3
commit 438efef6fe
16 changed files with 1151 additions and 349 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
SpotifyLocalApi/index.html → SpotifyLocalAPI/index.html
View File

@ -9,7 +9,7 @@
<link rel="shortcut icon" href="../img/favicon.ico">
<title>SpotifyLocalApi - SpotifyAPI-NET</title>
<title>SpotifyLocalAPI - SpotifyAPI-NET</title>
<link href="../css/bootstrap-custom.min.css" rel="stylesheet">
<link href="../css/font-awesome-4.0.3.css" rel="stylesheet">
@ -56,47 +56,55 @@
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="../SpotifyWebApi/gettingstarted/">Getting started</a>
<a href="../SpotifyWebAPI/gettingstarted/">Getting started</a>
</li>
<li >
<a href="../SpotifyWebApi/examples/">Examples</a>
<a href="../SpotifyWebAPI/examples/">Examples</a>
</li>
<li >
<a href="../SpotifyWebApi/auth/">Authentication</a>
<a href="../SpotifyWebAPI/auth/">Authentication</a>
</li>
<li >
<a href="../SpotifyWebApi/search/">- Search</a>
<a href="../SpotifyWebAPI/albums/">- Albums</a>
</li>
<li >
<a href="../SpotifyWebApi/albums/">- Albums</a>
<a href="../SpotifyWebAPI/artists/">- Artists</a>
</li>
<li >
<a href="../SpotifyWebApi/artists/">- Artists</a>
<a href="../SpotifyWebAPI/browse/">- Browse</a>
</li>
<li >
<a href="../SpotifyWebApi/browse/">- Browse</a>
<a href="../SpotifyWebAPI/follow/">- Follow</a>
</li>
<li >
<a href="../SpotifyWebApi/follow/">- Follow</a>
<a href="../SpotifyWebAPI/library/">- Library</a>
</li>
<li >
<a href="../SpotifyWebApi/library/">- Library</a>
<a href="../SpotifyWebAPI/playlists/">- Playlists</a>
</li>
<li >
<a href="../SpotifyWebApi/playlists/">- Playlists</a>
<a href="../SpotifyWebAPI/profiles/">- Profiles</a>
</li>
<li >
<a href="../SpotifyWebAPI/search/">- Search</a>
</li>
<li >
<a href="../SpotifyWebAPI/tracks/">- Tracks</a>
</li>
</ul>
@ -105,11 +113,11 @@
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="active">
<a href="./">SpotifyLocalApi</a>
<a href="./">SpotifyLocalAPI</a>
</li>
</ul>
@ -122,7 +130,7 @@
<ul class="nav navbar-nav navbar-right">
<li >
<a rel="next" href="../SpotifyWebApi/playlists/">
<a rel="next" href="../SpotifyWebAPI/tracks/">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>

24
SpotifyWebApi/albums/index.html → SpotifyWebAPI/albums/index.html
View File

@ -56,7 +56,7 @@
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
@ -71,10 +71,6 @@
<a href="../auth/">Authentication</a>
</li>
<li >
<a href="../search/">- Search</a>
</li>
<li class="active">
<a href="./">- Albums</a>
</li>
@ -99,17 +95,29 @@
<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>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="../../SpotifyLocalApi/">SpotifyLocalApi</a>
<a href="../../SpotifyLocalAPI/">SpotifyLocalAPI</a>
</li>
</ul>
@ -122,7 +130,7 @@
<ul class="nav navbar-nav navbar-right">
<li >
<a rel="next" href="../search/">
<a rel="next" href="../auth/">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>

22
SpotifyWebApi/artists/index.html → SpotifyWebAPI/artists/index.html
View File

@ -56,7 +56,7 @@
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
@ -71,10 +71,6 @@
<a href="../auth/">Authentication</a>
</li>
<li >
<a href="../search/">- Search</a>
</li>
<li >
<a href="../albums/">- Albums</a>
</li>
@ -99,17 +95,29 @@
<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>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="../../SpotifyLocalApi/">SpotifyLocalApi</a>
<a href="../../SpotifyLocalAPI/">SpotifyLocalAPI</a>
</li>
</ul>

31
SpotifyWebApi/auth/index.html → SpotifyWebAPI/auth/index.html
View File

@ -56,7 +56,7 @@
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
@ -71,10 +71,6 @@
<a href="./">Authentication</a>
</li>
<li >
<a href="../search/">- Search</a>
</li>
<li >
<a href="../albums/">- Albums</a>
</li>
@ -99,17 +95,29 @@
<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>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="../../SpotifyLocalApi/">SpotifyLocalApi</a>
<a href="../../SpotifyLocalAPI/">SpotifyLocalAPI</a>
</li>
</ul>
@ -127,7 +135,7 @@
</a>
</li>
<li >
<a rel="prev" href="../search/">
<a rel="prev" href="../albums/">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
@ -159,6 +167,9 @@
<li><a href="#clientcredentialsauth">ClientCredentialsAuth</a></li>
<li class="main "><a href="#scopes">Scopes</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
@ -309,7 +320,9 @@ static void Main(string[] args)
UseAuth = false
};
}
</code></pre></div>
</code></pre>
<h1 id="scopes">Scopes</h1></div>
</div>

22
SpotifyWebApi/browse/index.html → SpotifyWebAPI/browse/index.html
View File

@ -56,7 +56,7 @@
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
@ -71,10 +71,6 @@
<a href="../auth/">Authentication</a>
</li>
<li >
<a href="../search/">- Search</a>
</li>
<li >
<a href="../albums/">- Albums</a>
</li>
@ -99,17 +95,29 @@
<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>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="../../SpotifyLocalApi/">SpotifyLocalApi</a>
<a href="../../SpotifyLocalAPI/">SpotifyLocalAPI</a>
</li>
</ul>

22
SpotifyWebApi/examples/index.html → SpotifyWebAPI/examples/index.html
View File

@ -56,7 +56,7 @@
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
@ -71,10 +71,6 @@
<a href="../auth/">Authentication</a>
</li>
<li >
<a href="../search/">- Search</a>
</li>
<li >
<a href="../albums/">- Albums</a>
</li>
@ -99,17 +95,29 @@
<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>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="../../SpotifyLocalApi/">SpotifyLocalApi</a>
<a href="../../SpotifyLocalAPI/">SpotifyLocalAPI</a>
</li>
</ul>

22
SpotifyWebApi/follow/index.html → SpotifyWebAPI/follow/index.html
View File

@ -56,7 +56,7 @@
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
@ -71,10 +71,6 @@
<a href="../auth/">Authentication</a>
</li>
<li >
<a href="../search/">- Search</a>
</li>
<li >
<a href="../albums/">- Albums</a>
</li>
@ -99,17 +95,29 @@
<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>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="../../SpotifyLocalApi/">SpotifyLocalApi</a>
<a href="../../SpotifyLocalAPI/">SpotifyLocalAPI</a>
</li>
</ul>

305
SpotifyWebAPI/gettingstarted/index.html Normal file
View File

@ -0,0 +1,305 @@
<!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>Getting started - 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 class="active">
<a href="./">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>
</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="../..">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li >
<a rel="prev" href="../examples/">
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="#getting-started">Getting started</a></li>
<li><a href="#first-steps">First steps</a></li>
<li><a href="#authentication">Authentication</a></li>
<li><a href="#examples">Examples</a></li>
<li><a href="#error-handling">Error-Handling</a></li>
<li><a href="#api-reference">API-Reference</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h1 id="getting-started">Getting started</h1>
<p>This API provides full access to the new SpotifyWebAPI introduced <a href="https://developer.spotify.com/web-api/">here</a>.<br />
With it, you can search for Tracks/Albums/Artists and also get User-based information.<br />
It's also possible to create new playlists and add tracks to it.</p>
<hr />
<h2 id="first-steps">First steps</h2>
<p><strong>Imports</strong><br />
So after you added the API to your project, you may want to add following imports to your files:</p>
<pre><code class="cs">using SpotifyAPI.Web; //Base Namespace
using SpotifyAPI.Web.Auth; //All Authentication-related classes
using SpotifyAPI.Web.Enums; //Enums
using SpotifyAPI.Web.Models; //Models for the JSON-responses
</code></pre>
<p><strong>Basic-Usage</strong><br />
Now you can actually start doing calls to the SpotifyAPI, just create a new Instance of SpotifyWebAPI:</p>
<pre><code class="cs">private static SpotifyWebAPI _spotify;
public static void Main(String[] args)
{
_spotify = new SpotifyWebAPI()
{
UseAuth = false, //This will disable Authentication.
}
FullTrack track = _spotify.GetTrack(&quot;3Hvu1pq89D4R0lyPBoujSv&quot;);
Console.WriteLine(track.Name); //Yeay! We just printed a tracks name.
//...
}
</code></pre>
<hr />
<h2 id="authentication">Authentication</h2>
<p>If you look through the available API-Methods, you will soon notice nearly all of them require Authentication.
Further infos on how to implement Authentication can be found <a href="../../SpotifyWebApi/auth">here</a></p>
<hr />
<h2 id="examples">Examples</h2>
<p>A list of small examples can be found <a href="../../SpotifyWebApi/examples">here</a>. Do you think a specific example is missing? Feel free to open a PR/Issue!</p>
<hr />
<h2 id="error-handling">Error-Handling</h2>
<p>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:</p>
<pre><code class="cs">PrivateProfile profile = _spotify.GetPrivateProfile();
if (profile.HasError())
{
Console.WriteLine(&quot;Error Status: &quot; + profile.Error.Status);
Console.WriteLine(&quot;Error Msg: &quot; + profile.Error.Message);
}
</code></pre>
<hr />
<h2 id="api-reference">API-Reference</h2>
<h3 id="albums">Albums</h3>
<ul>
<li><a href="../../SpotifyWebApi/albums#getalbumtracks">GetAlbumTracks</a></li>
<li><a href="../../SpotifyWebApi/albums#getalbum">GetAlbum</a></li>
<li><a href="../../SpotifyWebApi/albums#getseveralalbums">GetSeveralAlbums</a></li>
</ul>
<h3 id="artists">Artists</h3>
<ul>
<li><a href="../../SpotifyWebApi/artists#getartist">GetArtist</a></li>
<li><a href="../../SpotifyWebApi/artists#getrelatedartists">GetRelatedArtists</a></li>
<li><a href="../../SpotifyWebApi/artists#getartiststoptracks">GetArtistsTopTracks</a></li>
<li><a href="../../SpotifyWebApi/artists#getartistsalbums">GetArtistsAlbums</a></li>
<li><a href="../../SpotifyWebApi/artists#getseveralartists">GetSeveralArtists</a></li>
</ul>
<h3 id="browse">Browse</h3>
<ul>
<li><a href="../../SpotifyWebApi/browse#getfeaturedplaylists">GetFeaturedPlaylists</a></li>
<li><a href="../../SpotifyWebApi/browse#getnewalbumreleases">GetNewAlbumReleases</a></li>
<li><a href="../../SpotifyWebApi/browse#getcategories">GetCategories</a></li>
<li><a href="../../SpotifyWebApi/browse#getcategory">GetCategory</a></li>
<li><a href="../../SpotifyWebApi/browse#getcategoryplaylists">GetCategoryPlaylists</a></li>
</ul>
<h3 id="follow">Follow</h3>
<ul>
<li><a href="../../SpotifyWebApi/follow#follow">Follow</a></li>
<li><a href="../../SpotifyWebApi/follow#unfollow">Unfollow</a></li>
<li><a href="../../SpotifyWebApi/follow#isfollowing">IsFollowing</a></li>
<li><a href="../../SpotifyWebApi/follow#followplaylist">FollowPlaylist</a></li>
<li><a href="../../SpotifyWebApi/follow#unfollowplaylist">UnfollowPlaylist</a></li>
<li><a href="../../SpotifyWebApi/follow#isfollowingplaylist">IsFollowingPlaylist</a></li>
</ul>
<h3 id="library">Library</h3>
<ul>
<li><a href="../../SpotifyWebApi/library#savetracks">SaveTracks</a></li>
<li><a href="../../SpotifyWebApi/library#savetrack">SaveTrack</a></li>
<li><a href="../../SpotifyWebApi/library#getsavedtracks">GetSavedTracks</a></li>
<li><a href="../../SpotifyWebApi/library#removesavedtracks">RemoveSavedTracks</a></li>
<li><a href="../../SpotifyWebApi/library#checksavedtracks">CheckSavedTracks</a></li>
</ul>
<h3 id="playlists">Playlists</h3>
<ul>
<li><a href="../../SpotifyWebApi/playlists#getuserplaylists">GetUserPlaylists</a></li>
<li><a href="../../SpotifyWebApi/playlists#getplaylist">GetPlaylist</a></li>
<li><a href="../../SpotifyWebApi/playlists#getplaylisttracks">GetPlaylistTracks</a></li>
<li><a href="../../SpotifyWebApi/playlists#createplaylist">CreatePlaylist</a></li>
<li><a href="../../SpotifyWebApi/playlists#updateplaylist">UpdatePlaylist</a></li>
<li><a href="../../SpotifyWebApi/playlists#replaceplaylisttracks">ReplacePlaylistTracks</a></li>
<li><a href="../../SpotifyWebApi/playlists#removeplaylisttracks">RemovePlaylistTracks</a></li>
<li><a href="../../SpotifyWebApi/playlists#removeplaylisttrack">RemovePlaylistTrack</a></li>
<li><a href="../../SpotifyWebApi/playlists#addplaylisttracks">AddPlaylistTracks</a></li>
<li><a href="../../SpotifyWebApi/playlists#addplaylisttrack">AddPlaylistTrack</a></li>
<li><a href="../../SpotifyWebApi/playlists#reorderplaylist">ReorderPlaylist</a></li>
</ul>
<h3 id="profiles">Profiles</h3>
<ul>
<li><a href="../../SpotifyWebApi/profiles#getpublicprofile">GetPublicProfile</a></li>
<li><a href="../../SpotifyWebApi/profiles#getprivateprofile">GetPrivateProfile</a></li>
</ul>
<h3 id="search">Search</h3>
<ul>
<li><a href="../../SpotifyWebApi/search#searchitems">SearchItems</a></li>
</ul>
<h3 id="tracks">Tracks</h3>
<ul>
<li><a href="../../SpotifyWebApi/tracks#getseveraltracks">GetSeveralTracks</a></li>
<li><a href="../../SpotifyWebApi/tracks#gettrack">GetTrack</a></li>
</ul></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>

22
SpotifyWebApi/library/index.html → SpotifyWebAPI/library/index.html
View File

@ -56,7 +56,7 @@
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
@ -71,10 +71,6 @@
<a href="../auth/">Authentication</a>
</li>
<li >
<a href="../search/">- Search</a>
</li>
<li >
<a href="../albums/">- Albums</a>
</li>
@ -99,17 +95,29 @@
<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>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="../../SpotifyLocalApi/">SpotifyLocalApi</a>
<a href="../../SpotifyLocalAPI/">SpotifyLocalAPI</a>
</li>
</ul>

234
SpotifyWebApi/playlists/index.html → SpotifyWebAPI/playlists/index.html
View File

@ -56,7 +56,7 @@
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
@ -71,10 +71,6 @@
<a href="../auth/">Authentication</a>
</li>
<li >
<a href="../search/">- Search</a>
</li>
<li >
<a href="../albums/">- Albums</a>
</li>
@ -99,17 +95,29 @@
<a href="./">- Playlists</a>
</li>
<li >
<a href="../profiles/">- Profiles</a>
</li>
<li >
<a href="../search/">- Search</a>
</li>
<li >
<a href="../tracks/">- Tracks</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="../../SpotifyLocalApi/">SpotifyLocalApi</a>
<a href="../../SpotifyLocalAPI/">SpotifyLocalAPI</a>
</li>
</ul>
@ -127,7 +135,7 @@
</a>
</li>
<li >
<a rel="prev" href="../../SpotifyLocalApi/">
<a rel="prev" href="../profiles/">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
@ -205,23 +213,25 @@
<tr>
<td>userId</td>
<td>The user's Spotify user ID.</td>
<td>EXAMPLE</td>
<td><code>"1122095781"</code></td>
</tr>
<tr>
<td>limit</td>
<td>[limit]</td>
<td>The maximum number of playlists to return. Default: 20. Minimum: 1. Maximum: 50.</td>
<td>EXAMPLE</td>
<td><code>20</code></td>
</tr>
<tr>
<td>offset</td>
<td>[offset]</td>
<td>The index of the first playlist to return. Default: 0 (the first object)</td>
<td>EXAMPLE</td>
<td><code>0</code></td>
</tr>
</tbody>
</table>
<p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#user-object-public">Public User Model</a></p>
<p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#playlist-object-simplified">SimplePlaylist</a> wrapped inside a <a href="https://developer.spotify.com/web-api/object-model/#paging-object">Paging Object</a></p>
<p><strong>Usage</strong> </p>
<pre><code class="cs"></code></pre>
<pre><code class="cs">Paging&lt;SimplePlaylist&gt; userPlaylists = _spotify.GetUserPlaylists(&quot;1122095781&quot;);
userPlaylists.Items.ForEach(playlist =&gt; playlist.Owner.DisplayName) //Who is the owner of the playlist?
</code></pre>
<hr />
<h2 id="getplaylist">GetPlaylist</h2>
@ -242,28 +252,30 @@
<tr>
<td>userId</td>
<td>The user's Spotify user ID.</td>
<td>EXAMPLE</td>
<td><code>"1122095781"</code></td>
</tr>
<tr>
<td>playlistId</td>
<td>The Spotify ID for the playlist.</td>
<td>EXAMPLE</td>
<td><code>"1TtEejT1y4D1WmcOnLfha2"</code></td>
</tr>
<tr>
<td>fields</td>
<td>Filters for the query: a comma-separated list of the fields to return. If omitted, all fields are returned.</td>
<td>EXAMPLE</td>
<td>[fields]</td>
<td>Filters for the query: a comma-separated list of the fields to return. If omitted, all fields are returned.</td>
<td><code>"description,uri"</code></td>
</tr>
<tr>
<td>market</td>
<td>[market]</td>
<td>An ISO 3166-1 alpha-2 country code. Provide this parameter if you want to apply Track Relinking.</td>
<td>EXAMPLE</td>
<td>"DE"</td>
</tr>
</tbody>
</table>
<p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#user-object-public">Public User Model</a></p>
<p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#track-object-full">FullTrack</a></p>
<p><strong>Usage</strong> </p>
<pre><code class="cs"></code></pre>
<pre><code class="cs">FullPlaylist playlist = _spotify.GetPlaylist(&quot;1122095781&quot;, &quot;1TtEejT1y4D1WmcOnLfha2&quot;);
playlist.Tracks.Items.ForEach(track =&gt; Console.WriteLine(track.Track.Name));
</code></pre>
<hr />
<h2 id="getplaylisttracks">GetPlaylistTracks</h2>
@ -284,38 +296,40 @@
<tr>
<td>userId</td>
<td>The user's Spotify user ID.</td>
<td>EXAMPLE</td>
<td><code>"1122095781"</code></td>
</tr>
<tr>
<td>playlistId</td>
<td>The Spotify ID for the playlist.</td>
<td>EXAMPLE</td>
<td><code>"1TtEejT1y4D1WmcOnLfha2"</code></td>
</tr>
<tr>
<td>fields</td>
<td>Filters for the query: a comma-separated list of the fields to return. If omitted, all fields are returned.</td>
<td>EXAMPLE</td>
<td>[fields]</td>
<td>Filters for the query: a comma-separated list of the fields to return. If omitted, all fields are returned.</td>
<td><code>"description,uri"</code></td>
</tr>
<tr>
<td>limit</td>
<td>[limit]</td>
<td>The maximum number of tracks to return. Default: 100. Minimum: 1. Maximum: 100.</td>
<td>EXAMPLE</td>
<td><code>100</code></td>
</tr>
<tr>
<td>offset</td>
<td>[offset]</td>
<td>The index of the first object to return. Default: 0 (i.e., the first object)</td>
<td>EXAMPLE</td>
<td><code>0</code></td>
</tr>
<tr>
<td>market</td>
<td>[market]</td>
<td>An ISO 3166-1 alpha-2 country code. Provide this parameter if you want to apply Track Relinking.</td>
<td>EXAMPLE</td>
<td><code>DE</code></td>
</tr>
</tbody>
</table>
<p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#user-object-public">Public User Model</a></p>
<p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#playlist-object-simplified">PlaylistTrack</a> wrapped inside a <a href="https://developer.spotify.com/web-api/object-model/#paging-object">Paging Object</a></p>
<p><strong>Usage</strong> </p>
<pre><code class="cs"></code></pre>
<pre><code class="cs">Paging&lt;PlaylistTrack&gt; playlist = _spotify.GetPlaylistTracks(&quot;1122095781&quot;, &quot;1TtEejT1y4D1WmcOnLfha2&quot;);
playlist.Items.ForEach(track =&gt; Console.WriteLine(track.Track.Name));
</code></pre>
<hr />
<h2 id="createplaylist">CreatePlaylist</h2>
@ -336,23 +350,26 @@
<tr>
<td>userId</td>
<td>The user's Spotify user ID.</td>
<td>EXAMPLE</td>
<td><code>"1122095781"</code></td>
</tr>
<tr>
<td>playlistName</td>
<td>The name for the new playlist, for example "Your Coolest Playlist". This name does not need to be unique.</td>
<td>EXAMPLE</td>
<td>The name for the new playlist, for example "Your Coolest Playlist". This name does not need to be unique.</td>
<td><code>"This is my new Playlist"</code></td>
</tr>
<tr>
<td>isPublic</td>
<td>default true. If true the playlist will be public, if false it will be private. To be able to create private playlists, the user must have granted the playlist-modify-private scope.</td>
<td>EXAMPLE</td>
<td>[isPublic]</td>
<td>default true. If true the playlist will be public, if false it will be private. To be able to create private playlists, the user must have granted the playlist-modify-private scope.</td>
<td><code>true</code></td>
</tr>
</tbody>
</table>
<p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#user-object-public">Public User Model</a></p>
<p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#playlist-object-full">FullPlaylist</a></p>
<p><strong>Usage</strong> </p>
<pre><code class="cs"></code></pre>
<pre><code class="cs">FullPlaylist playlist = _spotify.CreatePlaylist(&quot;1122095781&quot;, &quot;This is my new Playlist&quot;);
if(!playlist.HasError())
Console.WriteLine(&quot;Playlist-URI: &quot; + playlist.Uri);
</code></pre>
<hr />
<h2 id="updateplaylist">UpdatePlaylist</h2>
@ -373,34 +390,37 @@
<tr>
<td>userId</td>
<td>The user's Spotify user ID.</td>
<td>EXAMPLE</td>
<td><code>"1122095781"</code></td>
</tr>
<tr>
<td>playlistId</td>
<td>The Spotify ID for the playlist.</td>
<td>EXAMPLE</td>
<td><code>"1TtEejT1y4D1WmcOnLfha2"</code></td>
</tr>
<tr>
<td>newName</td>
<td>[newName]</td>
<td>The new name for the playlist, for example "My New Playlist Title".</td>
<td>EXAMPLE</td>
<td><code>"New Playlistname"</code></td>
</tr>
<tr>
<td>newPublic</td>
<td>[newPublic]</td>
<td>If true the playlist will be public, if false it will be private.</td>
<td>EXAMPLE</td>
</tr>
</tbody>
</table>
<p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#user-object-public">Public User Model</a></p>
<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"></code></pre>
<pre><code class="cs">ErrorResponse response = _spotify.UpdatePlaylist(&quot;1122095781&quot;, &quot;1TtEejT1y4D1WmcOnLfha2&quot;, &quot;New Name&quot;, true);
if(!response.HasError())
Console.WriteLine(&quot;success&quot;);
</code></pre>
<hr />
<h2 id="replaceplaylisttracks">ReplacePlaylistTracks</h2>
<p><span class="label label-warning">AUTH REQUIRED</span></p>
<blockquote>
<p>Replace all the tracks in a playlist, overwriting its existing tracks. This powerful request can be useful for replacing tracks, re-ordering existing tracks, or clearing the playlist.</p>
<p>Replace all the tracks in a playlist, overwriting its existing tracks. This powerful request can be useful for replacing tracks, re-ordering existing tracks, or clearing the playlist.</p>
</blockquote>
<p><strong>Paramters</strong> </p>
<table>
@ -415,23 +435,26 @@
<tr>
<td>userId</td>
<td>The user's Spotify user ID.</td>
<td>EXAMPLE</td>
<td><code>"1122095781"</code></td>
</tr>
<tr>
<td>playlistId</td>
<td>The Spotify ID for the playlist.</td>
<td>EXAMPLE</td>
<td><code>"1TtEejT1y4D1WmcOnLfha2"</code></td>
</tr>
<tr>
<td>uris</td>
<td>A list of Spotify track URIs to set. A maximum of 100 tracks can be set in one request.</td>
<td>EXAMPLE</td>
<td><code>new List&lt;string&gt; { "1ri6UZpjPLmTCswIXZ6Uq1" }</code></td>
</tr>
</tbody>
</table>
<p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#user-object-public">Public User Model</a></p>
<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"></code></pre>
<pre><code class="cs">ErrorResponse response = _spotify.ReplacePlaylistTracks(&quot;1122095781&quot;, &quot;1TtEejT1y4D1WmcOnLfha2&quot;, new List&lt;string&gt; { &quot;1ri6UZpjPLmTCswIXZ6Uq1&quot; });
if(!response.HasError())
Console.WriteLine(&quot;success&quot;);
</code></pre>
<hr />
<h2 id="removeplaylisttracks">RemovePlaylistTracks</h2>
@ -452,23 +475,35 @@
<tr>
<td>userId</td>
<td>The user's Spotify user ID.</td>
<td>EXAMPLE</td>
<td><code>"1122095781"</code></td>
</tr>
<tr>
<td>playlistId</td>
<td>The Spotify ID for the playlist.</td>
<td>EXAMPLE</td>
<td><code>"1TtEejT1y4D1WmcOnLfha2"</code></td>
</tr>
<tr>
<td>uris</td>
<td>array of objects containing Spotify URI strings (and their position in the playlist). A maximum of 100 objects can be sent at once.</td>
<td>EXAMPLE</td>
<td>array of objects containing Spotify URI strings (and their position in the playlist). A maximum of 100 objects can be sent at once.</td>
<td><code>(example below)</code></td>
</tr>
</tbody>
</table>
<p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#user-object-public">Public User Model</a></p>
<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"></code></pre>
<pre><code class="cs">//Remove multiple tracks
ErrorResponse playlist = _spotify.RemovePlaylistTracks(&quot;1122095781&quot;, &quot;1TtEejT1y4D1WmcOnLfha2&quot;, new List&lt;DeleteTrackUri&gt;()
{
new DeleteTrackUri(&quot;1ri6UZpjPLmTCswIXZ6Uq1&quot;),
new DeleteTrackUri(&quot;47xtGU3vht7mXLHqnbaau5&quot;)
});
//Remove multiple tracks at their specified positions
ErrorResponse playlist = _spotify.RemovePlaylistTracks(&quot;1122095781&quot;, &quot;1TtEejT1y4D1WmcOnLfha2&quot;, new List&lt;DeleteTrackUri&gt;()
{
new DeleteTrackUri(&quot;1ri6UZpjPLmTCswIXZ6Uq1&quot;, 2),
new DeleteTrackUri(&quot;47xtGU3vht7mXLHqnbaau5&quot;, 0, 50)
});
</code></pre>
<hr />
<h2 id="removeplaylisttrack">RemovePlaylistTrack</h2>
@ -489,23 +524,27 @@
<tr>
<td>userId</td>
<td>The user's Spotify user ID.</td>
<td>EXAMPLE</td>
<td><code>"1122095781"</code></td>
</tr>
<tr>
<td>playlistId</td>
<td>The Spotify ID for the playlist.</td>
<td>EXAMPLE</td>
<td><code>"1TtEejT1y4D1WmcOnLfha2"</code></td>
</tr>
<tr>
<td>uri</td>
<td>Spotify URI</td>
<td>EXAMPLE</td>
<td><code>new DeleteTrackUri("1ri6UZpjPLmTCswIXZ6Uq1")</code></td>
</tr>
</tbody>
</table>
<p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#user-object-public">Public User Model</a></p>
<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"></code></pre>
<pre><code class="cs">//Remove all tracks with the specified URI
ErrorResponse response = _spotify.RemovePlaylistTrack(&quot;1122095781&quot;, &quot;1TtEejT1y4D1WmcOnLfha2&quot;, new DeleteTrackUri(&quot;1ri6UZpjPLmTCswIXZ6Uq1&quot;));
//Remove all tracks with the specified URI and the specified positions
ErrorResponse response = _spotify.RemovePlaylistTrack(&quot;1122095781&quot;, &quot;1TtEejT1y4D1WmcOnLfha2&quot;, new DeleteTrackUri(&quot;1ri6UZpjPLmTCswIXZ6Uq1&quot;, 0, 10, 20));
</code></pre>
<hr />
<h2 id="addplaylisttracks">AddPlaylistTracks</h2>
@ -526,28 +565,31 @@
<tr>
<td>userId</td>
<td>The user's Spotify user ID.</td>
<td>EXAMPLE</td>
<td><code>"1122095781"</code></td>
</tr>
<tr>
<td>playlistId</td>
<td>The Spotify ID for the playlist.</td>
<td>EXAMPLE</td>
<td><code>"1TtEejT1y4D1WmcOnLfha2"</code></td>
</tr>
<tr>
<td>uris</td>
<td>A list of Spotify track URIs to add</td>
<td>EXAMPLE</td>
<td><code>new List&lt;string&gt; { "1ri6UZpjPLmTCswIXZ6Uq1" }</code></td>
</tr>
<tr>
<td>position</td>
<td>[position]</td>
<td>The position to insert the tracks, a zero-based index</td>
<td>EXAMPLE</td>
<td><code>10</code></td>
</tr>
</tbody>
</table>
<p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#user-object-public">Public User Model</a></p>
<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"></code></pre>
<pre><code class="cs">ErrorResponse response = _spotify.AddPlaylistTracks(&quot;1122095781&quot;, &quot;1TtEejT1y4D1WmcOnLfha2&quot;, new List&lt;string&gt; { &quot;1ri6UZpjPLmTCswIXZ6Uq1&quot; });
if(!response.HasError())
Console.WriteLine(&quot;Success&quot;);
</code></pre>
<hr />
<h2 id="addplaylisttrack">AddPlaylistTrack</h2>
@ -568,34 +610,38 @@
<tr>
<td>userId</td>
<td>The user's Spotify user ID.</td>
<td>EXAMPLE</td>
<td><code>"1122095781"</code></td>
</tr>
<tr>
<td>playlistId</td>
<td>The Spotify ID for the playlist.</td>
<td>EXAMPLE</td>
<td><code>"1TtEejT1y4D1WmcOnLfha2"</code></td>
</tr>
<tr>
<td>uri</td>
<td>A Spotify Track URI</td>
<td>EXAMPLE</td>
<td><code>"1ri6UZpjPLmTCswIXZ6Uq1"</code></td>
</tr>
<tr>
<td>position</td>
<td>The position to insert the tracks, a zero-based index</td>
<td>EXAMPLE</td>
<td><code>10</code></td>
</tr>
</tbody>
</table>
<p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#user-object-public">Public User Model</a></p>
<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"></code></pre>
<pre><code class="cs">ErrorResponse response = _spotify.AddPlaylistTrack(&quot;1122095781&quot;, &quot;1TtEejT1y4D1WmcOnLfha2&quot;, &quot;1ri6UZpjPLmTCswIXZ6Uq1&quot;);
if(!response.HasError())
Console.WriteLine(&quot;Success&quot;);
</code></pre>
<hr />
<h2 id="reorderplaylist">ReorderPlaylist</h2>
<p><span class="label label-warning">AUTH REQUIRED</span></p>
<blockquote>
<p>Reorder a track or a group of tracks in a playlist.</p>
<p>Reorder a track or a group of tracks in a playlist.
More Info: <a href="https://developer.spotify.com/web-api/reorder-playlists-tracks/">Reorder-Playlist</a></p>
</blockquote>
<p><strong>Paramters</strong> </p>
<table>
@ -610,38 +656,40 @@
<tr>
<td>userId</td>
<td>The user's Spotify user ID.</td>
<td>EXAMPLE</td>
<td><code>"1122095781"</code></td>
</tr>
<tr>
<td>playlistId</td>
<td>The Spotify ID for the playlist.</td>
<td>EXAMPLE</td>
<td><code>"1TtEejT1y4D1WmcOnLfha2"</code></td>
</tr>
<tr>
<td>rangeStart</td>
<td>The position of the first track to be reordered.</td>
<td>EXAMPLE</td>
<td><code>2</code></td>
</tr>
<tr>
<td>insertBefore</td>
<td>The position where the tracks should be inserted.</td>
<td>EXAMPLE</td>
<td><code>0</code></td>
</tr>
<tr>
<td>rangeLength</td>
<td>[rangeLength]</td>
<td>The amount of tracks to be reordered. Defaults to 1 if not set.</td>
<td>EXAMPLE</td>
<td><code>2</code></td>
</tr>
<tr>
<td>snapshotId</td>
<td>[snapshotId]</td>
<td>The playlist's snapshot ID against which you want to make the changes.</td>
<td>EXAMPLE</td>
<td>``</td>
</tr>
</tbody>
</table>
<p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#user-object-public">Public User Model</a></p>
<p>Returns a <strong>Snapshot</strong>-Object which contains the property <code>String SnapshotId</code></p>
<p><strong>Usage</strong> </p>
<pre><code class="cs"></code></pre>
<pre><code class="cs">Snapshot snapshot = _spotify.ReorderPlaylist(&quot;1122095781&quot;, &quot;1TtEejT1y4D1WmcOnLfha2&quot;, 2, 0, 2);
Console.WriteLine(&quot;New SnapshotId: &quot; + snapshot.SnapshotId);
</code></pre>
<hr /></div>
</div>

117
SpotifyWebApi/gettingstarted/index.html → SpotifyWebAPI/profiles/index.html
View File

@ -9,7 +9,7 @@
<link rel="shortcut icon" href="../../img/favicon.ico">
<title>Getting started - SpotifyAPI-NET</title>
<title>- Profiles - SpotifyAPI-NET</title>
<link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
<link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
@ -56,11 +56,11 @@
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="active">
<a href="./">Getting started</a>
<li >
<a href="../gettingstarted/">Getting started</a>
</li>
<li >
@ -71,10 +71,6 @@
<a href="../auth/">Authentication</a>
</li>
<li >
<a href="../search/">- Search</a>
</li>
<li >
<a href="../albums/">- Albums</a>
</li>
@ -99,17 +95,29 @@
<a href="../playlists/">- Playlists</a>
</li>
<li class="active">
<a href="./">- Profiles</a>
</li>
<li >
<a href="../search/">- Search</a>
</li>
<li >
<a href="../tracks/">- Tracks</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="../../SpotifyLocalApi/">SpotifyLocalApi</a>
<a href="../../SpotifyLocalAPI/">SpotifyLocalAPI</a>
</li>
</ul>
@ -122,12 +130,12 @@
<ul class="nav navbar-nav navbar-right">
<li >
<a rel="next" href="../..">
<a rel="next" href="../playlists/">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li >
<a rel="prev" href="../examples/">
<a rel="prev" href="../search/">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
@ -150,54 +158,65 @@
<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="#spotifywebapi">SpotifyWebAPI</a></li>
<li class="main active"><a href="#getprivateprofile">GetPrivateProfile</a></li>
<li class="main "><a href="#getting-started">Getting started</a></li>
<li class="main "><a href="#properties">Properties</a></li>
<li><a href="#useauth">UseAuth</a></li>
<li><a href="#tokentype">TokenType</a></li>
<li><a href="#accesstoken">AccessToken</a></li>
<li class="main "><a href="#getpublicprofile">GetPublicProfile</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h1 id="spotifywebapi">SpotifyWebAPI</h1>
<p>This API provides full access to the new SpotifyWebAPI introduced <a href="https://developer.spotify.com/web-api/">here</a>.<br />
With it, you can search for Tracks/Albums/Artists and also get User-based information.<br />
It's also possible to create new playlists and add tracks to it.</p>
<hr />
<h1 id="getting-started">Getting started</h1>
<p>The API features all currently available features and also provides some examples to get things rolling!<br />
Full-Method Reference: </p>
<ul>
<li><a href="../test">Albums</a></li>
</ul>
<p><a href="../../SpotifyWebApi/examples">Examples</a></p>
<hr />
<h1 id="properties">Properties</h1>
<h2 id="useauth">UseAuth</h2>
<p>Wether auth should be used or not. User-stuff can only be fetched with auth.<br />
<strong>NOTE:</strong> If you use auth, you need to provide both, <code>TokenType</code> and <code>AccessToken</code> </p>
<pre><code>_spotify.UseAuth = false;
<h2 id="getprivateprofile">GetPrivateProfile</h2>
<p><span class="label label-warning">AUTH REQUIRED</span></p>
<blockquote>
<p>Get detailed profile information about the current user (including the current user’s username).</p>
</blockquote>
<p><strong>Paramters</strong> </p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Example</th>
</tr>
</thead>
<tbody></tbody>
</table>
<p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#user-object-private">PrivateProfile</a></p>
<p><strong>Usage</strong> </p>
<pre><code class="cs">PrivateUser user = _spotify.GetPrivateProfile();
Console.WriteLine(user.DisplayName);
</code></pre>
<h2 id="tokentype">TokenType</h2>
<p>The token-type. Normally "Bearer" or "Basic". </p>
<pre><code>_spotify.TokenType = &quot;XXXXXXXXXXXXXXXX&quot;;
</code></pre>
<hr />
<h2 id="getpublicprofile">GetPublicProfile</h2>
<blockquote>
<p>Get public profile information about a 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>userId</td>
<td>The user's Spotify user ID.</td>
<td>EXAMPLE</td>
</tr>
</tbody>
</table>
<p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#user-object-public">PublicProfile</a></p>
<p><strong>Usage</strong> </p>
<pre><code class="cs"></code></pre>
<h2 id="accesstoken">AccessToken</h2>
<p>The access-token received by your auth-type. </p>
<pre><code>_spotify.AccessToken = &quot;XXXXXXXXXXXXXXXX&quot;;
</code></pre></div>
<hr /></div>
</div>

26
SpotifyWebApi/search/index.html → SpotifyWebAPI/search/index.html
View File

@ -56,7 +56,7 @@
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
@ -71,10 +71,6 @@
<a href="../auth/">Authentication</a>
</li>
<li class="active">
<a href="./">- Search</a>
</li>
<li >
<a href="../albums/">- Albums</a>
</li>
@ -99,17 +95,29 @@
<a href="../playlists/">- Playlists</a>
</li>
<li >
<a href="../profiles/">- Profiles</a>
</li>
<li class="active">
<a href="./">- Search</a>
</li>
<li >
<a href="../tracks/">- Tracks</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="../../SpotifyLocalApi/">SpotifyLocalApi</a>
<a href="../../SpotifyLocalAPI/">SpotifyLocalAPI</a>
</li>
</ul>
@ -122,12 +130,12 @@
<ul class="nav navbar-nav navbar-right">
<li >
<a rel="next" href="../auth/">
<a rel="next" href="../profiles/">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li >
<a rel="prev" href="../albums/">
<a rel="prev" href="../tracks/">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>

247
SpotifyWebAPI/tracks/index.html Normal file
View File

@ -0,0 +1,247 @@
<!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>- Tracks - 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 class="active">
<a href="./">- Tracks</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="../search/">
<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="#getseveraltracks">GetSeveralTracks</a></li>
<li class="main "><a href="#gettrack">GetTrack</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h2 id="getseveraltracks">GetSeveralTracks</h2>
<blockquote>
<p>Get Spotify catalog information for multiple tracks based on their Spotify IDs.</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 for the tracks. Maximum: 50 IDs.</td>
<td><code>new List&lt;String&gt; {"6Y1CLPwYe7zvI8PJiWVz6T"}</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>SeveralTracks</strong> object which has one property, <code>List&lt;FullTrack&gt; Tracks</code></p>
<p><strong>Usage</strong> </p>
<pre><code class="cs">SeveralTracks severalTracks = _spotify.GetSeveralTracks(new List&lt;String&gt; {&quot;6Y1CLPwYe7zvI8PJiWVz6T&quot;});
severalTracks.Tracks.ForEach(track =&gt; Console.WriteLine(track.Name));
</code></pre>
<hr />
<h2 id="gettrack">GetTrack</h2>
<blockquote>
<p>Get Spotify catalog information for a single track identified by its unique Spotify ID.</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>The Spotify ID for the track.</td>
<td><code>"6Y1CLPwYe7zvI8PJiWVz6T"</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 <a href="https://developer.spotify.com/web-api/object-model/#track-object-full">FullTrack</a></p>
<p><strong>Usage</strong> </p>
<pre><code class="cs">FullTrack track = _spotify.GetTrack(&quot;6Y1CLPwYe7zvI8PJiWVz6T&quot;);
Console.WriteLine(track.Name);
</code></pre>
<hr /></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>

74
index.html
View File

@ -56,47 +56,55 @@
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="SpotifyWebApi/gettingstarted/">Getting started</a>
<a href="SpotifyWebAPI/gettingstarted/">Getting started</a>
</li>
<li >
<a href="SpotifyWebApi/examples/">Examples</a>
<a href="SpotifyWebAPI/examples/">Examples</a>
</li>
<li >
<a href="SpotifyWebApi/auth/">Authentication</a>
<a href="SpotifyWebAPI/auth/">Authentication</a>
</li>
<li >
<a href="SpotifyWebApi/search/">- Search</a>
<a href="SpotifyWebAPI/albums/">- Albums</a>
</li>
<li >
<a href="SpotifyWebApi/albums/">- Albums</a>
<a href="SpotifyWebAPI/artists/">- Artists</a>
</li>
<li >
<a href="SpotifyWebApi/artists/">- Artists</a>
<a href="SpotifyWebAPI/browse/">- Browse</a>
</li>
<li >
<a href="SpotifyWebApi/browse/">- Browse</a>
<a href="SpotifyWebAPI/follow/">- Follow</a>
</li>
<li >
<a href="SpotifyWebApi/follow/">- Follow</a>
<a href="SpotifyWebAPI/library/">- Library</a>
</li>
<li >
<a href="SpotifyWebApi/library/">- Library</a>
<a href="SpotifyWebAPI/playlists/">- Playlists</a>
</li>
<li >
<a href="SpotifyWebApi/playlists/">- Playlists</a>
<a href="SpotifyWebAPI/profiles/">- Profiles</a>
</li>
<li >
<a href="SpotifyWebAPI/search/">- Search</a>
</li>
<li >
<a href="SpotifyWebAPI/tracks/">- Tracks</a>
</li>
</ul>
@ -105,11 +113,11 @@
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalApi <b class="caret"></b></a>
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="SpotifyLocalApi/">SpotifyLocalApi</a>
<a href="SpotifyLocalAPI/">SpotifyLocalAPI</a>
</li>
</ul>
@ -127,7 +135,7 @@
</a>
</li>
<li >
<a rel="prev" href="SpotifyWebApi/gettingstarted/">
<a rel="prev" href="SpotifyWebAPI/gettingstarted/">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
@ -152,12 +160,48 @@
<li class="main active"><a href="#spotifyapi-net-documentation">SpotifyAPI-NET Documentation</a></li>
<li><a href="#about">About</a></li>
<li><a href="#installing">Installing</a></li>
<li><a href="#projects">Projects</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h1 id="spotifyapi-net-documentation">SpotifyAPI-NET Documentation</h1></div>
<h1 id="spotifyapi-net-documentation">SpotifyAPI-NET Documentation</h1>
<h2 id="about">About</h2>
<p>This Library, written in C#/.NET, combines two independent SpotifyAPIs into one.</p>
<p><strong>Spotify's Web API</strong> (<a href="https://developer.spotify.com/web-api/">link</a>)</p>
<blockquote>
<p>Based on simple REST principles, our Web API endpoints return metadata in JSON format about artists, albums, and tracks directly from the Spotify catalogue.
The API also provides access to user-related data such as playlists and music saved in a “Your Music” library, subject to user’s authorization.</p>
</blockquote>
<p><strong>Spotify's <em>unofficial</em> Local API</strong></p>
<blockquote>
<p>Do you ever wanted to control your local Spotify Client with some sort of API? Now you can! This API gives you full control over your spotify client.
You can get infos about the currently playing song, get its Album-Art, skip/pause and much more. It also features multiple Event-Interfaces.</p>
</blockquote>
<p>Both combined can be used for any kind of application.</p>
<hr />
<h2 id="installing">Installing</h2>
<ul>
<li>Via NuGet Package:</li>
</ul>
<pre><code class="cs">Install-Package SpotifyAPI-NET
//or
Install-Package SpotifyAPI-NET -pre
</code></pre>
<ul>
<li>Download the latest binaries on the <a href="https://github.com/JohnnyCrazy/SpotifyAPI-NET/releases">GitHub Release Page</a> and add it to your Project</li>
<li>Clone the Repo and build the project on your local machine.</li>
</ul>
<hr />
<h2 id="projects">Projects</h2>
<p>--</p></div>
</div>

236
mkdocs/search_index.json
View File

File diff suppressed because one or more lines are too long

58
sitemap.xml
View File

@ -4,7 +4,7 @@
<url>
<loc>None/</loc>
<lastmod>2015-07-23</lastmod>
<lastmod>2015-07-26</lastmod>
<changefreq>daily</changefreq>
</url>
@ -12,62 +12,74 @@
<url>
<loc>None/SpotifyWebApi/gettingstarted/</loc>
<lastmod>2015-07-23</lastmod>
<loc>None/SpotifyWebAPI/gettingstarted/</loc>
<lastmod>2015-07-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None/SpotifyWebApi/examples/</loc>
<lastmod>2015-07-23</lastmod>
<loc>None/SpotifyWebAPI/examples/</loc>
<lastmod>2015-07-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None/SpotifyWebApi/auth/</loc>
<lastmod>2015-07-23</lastmod>
<loc>None/SpotifyWebAPI/auth/</loc>
<lastmod>2015-07-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None/SpotifyWebApi/search/</loc>
<lastmod>2015-07-23</lastmod>
<loc>None/SpotifyWebAPI/albums/</loc>
<lastmod>2015-07-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None/SpotifyWebApi/albums/</loc>
<lastmod>2015-07-23</lastmod>
<loc>None/SpotifyWebAPI/artists/</loc>
<lastmod>2015-07-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None/SpotifyWebApi/artists/</loc>
<lastmod>2015-07-23</lastmod>
<loc>None/SpotifyWebAPI/browse/</loc>
<lastmod>2015-07-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None/SpotifyWebApi/browse/</loc>
<lastmod>2015-07-23</lastmod>
<loc>None/SpotifyWebAPI/follow/</loc>
<lastmod>2015-07-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None/SpotifyWebApi/follow/</loc>
<lastmod>2015-07-23</lastmod>
<loc>None/SpotifyWebAPI/library/</loc>
<lastmod>2015-07-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None/SpotifyWebApi/library/</loc>
<lastmod>2015-07-23</lastmod>
<loc>None/SpotifyWebAPI/playlists/</loc>
<lastmod>2015-07-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None/SpotifyWebApi/playlists/</loc>
<lastmod>2015-07-23</lastmod>
<loc>None/SpotifyWebAPI/profiles/</loc>
<lastmod>2015-07-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None/SpotifyWebAPI/search/</loc>
<lastmod>2015-07-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None/SpotifyWebAPI/tracks/</loc>
<lastmod>2015-07-26</lastmod>
<changefreq>daily</changefreq>
</url>
@ -76,8 +88,8 @@
<url>
<loc>None/SpotifyLocalApi/</loc>
<lastmod>2015-07-23</lastmod>
<loc>None/SpotifyLocalAPI/</loc>
<lastmod>2015-07-26</lastmod>
<changefreq>daily</changefreq>
</url>