mirror of
https://github.com/Sarsoo/Spotify.NET.git
synced 2024-12-23 14:46:26 +00:00
Built mkdocs | Travis Build 10
This commit is contained in:
Travis-CI
parent
f6febf87b2
commit
79517c8af3
@ -71,6 +71,10 @@
|
||||
<a href="../SpotifyWebApi/auth/">Authentication</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../SpotifyWebApi/search/">- Search</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../SpotifyWebApi/albums/">- Albums</a>
|
||||
</li>
|
||||
@ -79,6 +83,22 @@
|
||||
<a href="../SpotifyWebApi/artists/">- Artists</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../SpotifyWebApi/browse/">- Browse</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../SpotifyWebApi/follow/">- Follow</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../SpotifyWebApi/library/">- Library</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../SpotifyWebApi/playlists/">- Playlists</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@ -102,7 +122,7 @@
|
||||
<ul class="nav navbar-nav navbar-right">
|
||||
|
||||
<li >
|
||||
<a rel="next" href="../SpotifyWebApi/artists/">
|
||||
<a rel="next" href="../SpotifyWebApi/playlists/">
|
||||
<i class="fa fa-arrow-left"></i> Previous
|
||||
</a>
|
||||
</li>
|
||||
|
||||
@ -71,6 +71,10 @@
|
||||
<a href="../auth/">Authentication</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../search/">- Search</a>
|
||||
</li>
|
||||
|
||||
<li class="active">
|
||||
<a href="./">- Albums</a>
|
||||
</li>
|
||||
@ -79,6 +83,22 @@
|
||||
<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>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@ -102,7 +122,7 @@
|
||||
<ul class="nav navbar-nav navbar-right">
|
||||
|
||||
<li >
|
||||
<a rel="next" href="../auth/">
|
||||
<a rel="next" href="../search/">
|
||||
<i class="fa fa-arrow-left"></i> Previous
|
||||
</a>
|
||||
</li>
|
||||
@ -160,28 +180,31 @@
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>The Spotify ID for the album.</td>
|
||||
<td>EXAMPLE</td>
|
||||
<td><code>"5O7V8l4SeXTymVp3IesT9C"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>limit</td>
|
||||
<td>[limit]</td>
|
||||
<td>The maximum number of items 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 track to return. Default: 0 (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/#track-object-simplified">SimpleTrack</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="csharp"></code></pre>
|
||||
<pre><code class="cs">Paging<SimpleTrack> tracks = _spotify.GetAlbumTracks("5O7V8l4SeXTymVp3IesT9C");
|
||||
tracks.Items.ForEach(item => Console.WriteLine(item.Name)); //Display all fetched Track-Names (max 20)
|
||||
Console.WriteLine(tracks.Total.ToString()) //Display total album track count
|
||||
</code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="getalbum">GetAlbum</h2>
|
||||
@ -201,18 +224,20 @@
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>The Spotify ID for the album.</td>
|
||||
<td>EXAMPLE</td>
|
||||
<td><code>5O7V8l4SeXTymVp3IesT9C</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/#album-object-full">FullAlbum</a></p>
|
||||
<p><strong>Usage</strong> </p>
|
||||
<pre><code class="csharp"></code></pre>
|
||||
<pre><code class="cs">FullAlbum album = _spotify.GetAlbum("5O7V8l4SeXTymVp3IesT9C");
|
||||
Console.WriteLine(album.Name + "| Popularity: " + album.Popularity); //Display name and Popularity
|
||||
</code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="getseveralalbums">GetSeveralAlbums</h2>
|
||||
@ -232,18 +257,20 @@
|
||||
<tr>
|
||||
<td>ids</td>
|
||||
<td>A list of the Spotify IDs for the albums. Maximum: 20 IDs.</td>
|
||||
<td>EXAMPLE</td>
|
||||
<td><code>new List<String>() { "5O7V8l4SeXTymVp3IesT9C" }</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 <strong>SeveralAlbums</strong> which Property "Albums" contains a list of <a href="https://developer.spotify.com/web-api/object-model/#album-object-full">FullAlbum</a></p>
|
||||
<p><strong>Usage</strong> </p>
|
||||
<pre><code class="csharp"></code></pre>
|
||||
<pre><code class="cs">SeveralAlbums albums = _spotify.GetSeveralAlbums(new List<String>() { "5O7V8l4SeXTymVp3IesT9C" });
|
||||
Console.WriteLine(albums.Albums[0].Name);
|
||||
</code></pre>
|
||||
|
||||
<hr /></div>
|
||||
</div>
|
||||
|
||||
@ -71,6 +71,10 @@
|
||||
<a href="../auth/">Authentication</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../search/">- Search</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../albums/">- Albums</a>
|
||||
</li>
|
||||
@ -79,6 +83,22 @@
|
||||
<a href="./">- 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>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@ -107,7 +127,7 @@
|
||||
</a>
|
||||
</li>
|
||||
<li >
|
||||
<a rel="prev" href="../../SpotifyLocalApi/">
|
||||
<a rel="prev" href="../browse/">
|
||||
Next <i class="fa fa-arrow-right"></i>
|
||||
</a>
|
||||
</li>
|
||||
@ -166,13 +186,15 @@
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>The Spotify ID for the artist.</td>
|
||||
<td>EXAMPLE</td>
|
||||
<td><code>"1KpCi9BOfviCVhmpI4G2sY"</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/#artist-object-full">FullArtist</a></p>
|
||||
<p><strong>Usage</strong> </p>
|
||||
<pre><code class="csharp"></code></pre>
|
||||
<pre><code class="cs">FullArtist artist = _spotify.GetArtist("1KpCi9BOfviCVhmpI4G2sY");
|
||||
Console.WriteLine()
|
||||
</code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="getrelatedartists">GetRelatedArtists</h2>
|
||||
@ -192,13 +214,15 @@
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>The Spotify ID for the artist.</td>
|
||||
<td>EXAMPLE</td>
|
||||
<td><code>"1KpCi9BOfviCVhmpI4G2sY"</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>SeveralArtists</strong> object which contains the property <code>List<FullArtist> Artists</code> (<a href="https://developer.spotify.com/web-api/object-model/#artist-object-full">FullArtist</a>)</p>
|
||||
<p><strong>Usage</strong> </p>
|
||||
<pre><code class="csharp"></code></pre>
|
||||
<pre><code class="cs">SeveralArtists artists = _spotify.GetRelatedArtists("1KpCi9BOfviCVhmpI4G2sY");
|
||||
Console.WriteLine(artists.Artists[0].Name);
|
||||
</code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="getartiststoptracks">GetArtistsTopTracks</h2>
|
||||
@ -218,18 +242,20 @@
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>The Spotify ID for the artist.</td>
|
||||
<td>EXAMPLE</td>
|
||||
<td><code>"1KpCi9BOfviCVhmpI4G2sY"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>country</td>
|
||||
<td>The country: an ISO 3166-1 alpha-2 country code.</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 <strong>SeveralTracks</strong> object which contains the property <code>List<FullTrack> Tracks</code> (<a href="https://developer.spotify.com/web-api/object-model/#track-object-full">FullTrack</a>)</p>
|
||||
<p><strong>Usage</strong> </p>
|
||||
<pre><code class="csharp"></code></pre>
|
||||
<pre><code class="cs">SeveralTracks tracks = _spotify.GetArtistsTopTracks("1KpCi9BOfviCVhmpI4G2sY", "DE");
|
||||
Console.WriteLine(tracks.Tracks.Count); //How many tracks did we get?
|
||||
</code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="getartistsalbums">GetArtistsAlbums</h2>
|
||||
@ -249,33 +275,35 @@
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td>The Spotify ID for the artist.</td>
|
||||
<td>EXAMPLE</td>
|
||||
<td><code>"1KpCi9BOfviCVhmpI4G2sY"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>type</td>
|
||||
<td>[type]</td>
|
||||
<td>A list of keywords that will be used to filter the response. If not supplied, all album types will be returned</td>
|
||||
<td>EXAMPLE</td>
|
||||
<td><code>AlbumType.All</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>limit</td>
|
||||
<td>[limit]</td>
|
||||
<td>The maximum number of items 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 album to return. Default: 0</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. Supply this parameter to limit the response to one particular geographical market</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/#album-object-simplified">SimpleAlbum</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="csharp"></code></pre>
|
||||
<pre><code class="cs">Paging<SimpleAlbum> albums = _spotify.GetArtistsAlbums("1KpCi9BOfviCVhmpI4G2sY", AlbumType.All);
|
||||
albums.Items.ForEach(album => Console.WriteLine(album.Name));
|
||||
</code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="getseveralartists">GetSeveralArtists</h2>
|
||||
@ -295,13 +323,15 @@
|
||||
<tr>
|
||||
<td>ids</td>
|
||||
<td>A list of the Spotify IDs for the artists. Maximum: 50 IDs.</td>
|
||||
<td>EXAMPLE</td>
|
||||
<td><code>new List<String>() { "1KpCi9BOfviCVhmpI4G2sY" }</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>SeveralArtists</strong> object which contains the property <code>List<FullArtist> Artists</code> (<a href="https://developer.spotify.com/web-api/object-model/#artist-object-full">FullArtist</a>)</p>
|
||||
<p><strong>Usage</strong> </p>
|
||||
<pre><code class="csharp"></code></pre>
|
||||
<pre><code class="cs">SeveralArtists artists = _spotify.GetSeveralArtists(new List<String>() {"1KpCi9BOfviCVhmpI4G2sY"});
|
||||
artists.Artists.ForEach(artist => Console.WriteLine(artist.Name));
|
||||
</code></pre>
|
||||
|
||||
<hr /></div>
|
||||
</div>
|
||||
|
||||
@ -71,6 +71,10 @@
|
||||
<a href="./">Authentication</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../search/">- Search</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../albums/">- Albums</a>
|
||||
</li>
|
||||
@ -79,6 +83,22 @@
|
||||
<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>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@ -107,7 +127,7 @@
|
||||
</a>
|
||||
</li>
|
||||
<li >
|
||||
<a rel="prev" href="../albums/">
|
||||
<a rel="prev" href="../search/">
|
||||
Next <i class="fa fa-arrow-right"></i>
|
||||
</a>
|
||||
</li>
|
||||
@ -166,7 +186,7 @@ If you want to know more, you can read to the whole auth-process <a href="https:
|
||||
<p><a href="../../SpotifyWebApi/#implicitgrantauth">ClientCredentialsAuth</a> (Not Recommended, Server-side code needed, else it's unsecure) </p>
|
||||
</li>
|
||||
</ul>
|
||||
<p><strong>Note:</strong> I would recommend a little PHP Script, which will exchange the Keys using AutorizationCodeAuth.
|
||||
<p><strong>Note:</strong> I would recommend a little PHP Script, which will exchange the Keys using AutorizationCodeAuth.
|
||||
When using ImplicitGrantAuth, another user could abuse the "localhost" RedirectUri by creating a "fake"-app which uses your ClientId.</p>
|
||||
<p>Overview:
|
||||
<img alt="Overview" src="http://i.imgur.com/uf3ahTl.png" /></p>
|
||||
@ -175,7 +195,7 @@ When using ImplicitGrantAuth, another user could abuse the "localhost" RedirectU
|
||||
<p>This way is <strong>recommended</strong> and the only auth-process, which does not need a server-side exchange of keys. With this approach, you directly get a Token object after the user authed your application.
|
||||
You won't be able to refresh the token. If you want to use the internal Http server, please add "http://localhost" to your application redirects.</p>
|
||||
<p>More info: <a href="https://developer.spotify.com/web-api/authorization-guide/#implicit_grant_flow">here</a></p>
|
||||
<pre><code class="csharp">static ImplicitGrantAuth auth;
|
||||
<pre><code>static ImplicitGrantAuth auth;
|
||||
static void Main(string[] args)
|
||||
{
|
||||
//Create the auth object
|
||||
@ -217,7 +237,7 @@ In this exchange you need to provide your Client-Secret and because of that it's
|
||||
(But you can e.g exchange to codes via a PHP Script)<br />
|
||||
A good thing about this method: You can always refresh your token, without having the user to auth it again</p>
|
||||
<p>More info: <a href="https://developer.spotify.com/web-api/authorization-guide/#authorization_code_flow">here</a></p>
|
||||
<pre><code class="csharp">static AutorizationCodeAuth auth;
|
||||
<pre><code>static AutorizationCodeAuth auth;
|
||||
static void Main(string[] args)
|
||||
{
|
||||
//Create the auth object
|
||||
@ -267,7 +287,7 @@ With this approach, you make a POST Request with a base64 encoded string (consis
|
||||
If you want to use it securely, you would need to do it all server-side.<br />
|
||||
<strong>NOTE:</strong> You will only be able to query non-user-related information e.g search for a Track.</p>
|
||||
<p>More info: <a href="https://developer.spotify.com/web-api/authorization-guide/#client_credentials_flow">here</a></p>
|
||||
<pre><code class="csharp">static ClientCredentialsAuth auth;
|
||||
<pre><code>static ClientCredentialsAuth auth;
|
||||
static void Main(string[] args)
|
||||
{
|
||||
//Create the auth object
|
||||
@ -280,7 +300,7 @@ static void Main(string[] args)
|
||||
//How many permissions we need?
|
||||
Scope = Scope.USER_READ_PRIVATE,
|
||||
};
|
||||
//With this token object, we now can make calls
|
||||
//With this token object, we now can make calls
|
||||
Token token = auth.DoAuth();
|
||||
var spotify = new SpotifyWebApiClass()
|
||||
{
|
||||
|
||||
398
SpotifyWebApi/browse/index.html
Normal file
398
SpotifyWebApi/browse/index.html
Normal file
@ -0,0 +1,398 @@
|
||||
<!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>- Browse - 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="../search/">- Search</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../albums/">- Albums</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../artists/">- Artists</a>
|
||||
</li>
|
||||
|
||||
<li class="active">
|
||||
<a href="./">- Browse</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../follow/">- Follow</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../library/">- Library</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../playlists/">- Playlists</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="../artists/">
|
||||
<i class="fa fa-arrow-left"></i> Previous
|
||||
</a>
|
||||
</li>
|
||||
<li >
|
||||
<a rel="prev" href="../follow/">
|
||||
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="#getfeaturedplaylists">GetFeaturedPlaylists</a></li>
|
||||
|
||||
|
||||
<li class="main "><a href="#getnewalbumreleases">GetNewAlbumReleases</a></li>
|
||||
|
||||
|
||||
<li class="main "><a href="#getcategories">GetCategories</a></li>
|
||||
|
||||
|
||||
<li class="main "><a href="#getcategory">GetCategory</a></li>
|
||||
|
||||
|
||||
<li class="main "><a href="#getcategoryplaylists">GetCategoryPlaylists</a></li>
|
||||
|
||||
|
||||
</ul>
|
||||
</div></div>
|
||||
<div class="col-md-9" role="main">
|
||||
|
||||
<h2 id="getfeaturedplaylists">GetFeaturedPlaylists</h2>
|
||||
<p><span class="label label-warning">AUTH REQUIRED</span></p>
|
||||
<blockquote>
|
||||
<p>Get a list of Spotify featured playlists (shown, for example, on a Spotify player’s “Browse” tab).</p>
|
||||
</blockquote>
|
||||
<p><strong>Paramters</strong> </p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
<th>Example</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>[locale]</td>
|
||||
<td>The desired language, consisting of a lowercase ISO 639 language code and an uppercase ISO 3166-1 alpha-2 country code, joined by an underscore.</td>
|
||||
<td><code>"de_DE" //Germany</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[country]</td>
|
||||
<td>A country: an ISO 3166-1 alpha-2 country code.</td>
|
||||
<td><code>"DE"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[timestamp]</td>
|
||||
<td>A timestamp in ISO 8601 format</td>
|
||||
<td><code>DateTime.Now</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[limit]</td>
|
||||
<td>The maximum number of items 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 item to return. Default: 0</td>
|
||||
<td><code>0</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Returns a <strong>FeaturedPlaylists</strong> object, which has 2 properties. <code>String Message</code> and <code>Paging<SimplePlaylist> Playlists</code></p>
|
||||
<p><strong>Usage</strong> </p>
|
||||
<pre><code class="cs">FeaturedPlaylists playlists = _spotify.GetFeaturedPlaylists();
|
||||
Console.WriteLine(playlists.Message);
|
||||
playlists.Playlists.Items.ForEach(playlist => Console.WriteLine(playlist.Name));
|
||||
</code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="getnewalbumreleases">GetNewAlbumReleases</h2>
|
||||
<p><span class="label label-warning">AUTH REQUIRED</span></p>
|
||||
<blockquote>
|
||||
<p>Get a list of new album releases featured in Spotify (shown, for example, on a Spotify player’s “Browse” tab).</p>
|
||||
</blockquote>
|
||||
<p><strong>Paramters</strong> </p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
<th>Example</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>[country]</td>
|
||||
<td>A country: an ISO 3166-1 alpha-2 country code.</td>
|
||||
<td><code>"DE"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[limit]</td>
|
||||
<td>The maximum number of items 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 item to return. Default: 0</td>
|
||||
<td><code>0</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Returns a <strong>NewAlbumReleases</strong> object, which has the property <code>Paging<SimpleAlbum> Albums</code>.</p>
|
||||
<p><strong>Usage</strong> </p>
|
||||
<pre><code class="cs">NewAlbumReleases newAlbums = _spotify.GetNewAlbumReleases();
|
||||
newAlbums.Albums.Items.ForEach(album => Console.WriteLine(album.Name));
|
||||
</code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="getcategories">GetCategories</h2>
|
||||
<p><span class="label label-warning">AUTH REQUIRED</span></p>
|
||||
<blockquote>
|
||||
<p>Get a list of categories used to tag items in Spotify (on, for example, the Spotify player’s “Browse” tab).</p>
|
||||
</blockquote>
|
||||
<p><strong>Paramters</strong> </p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
<th>Example</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>[country]</td>
|
||||
<td>A country: an ISO 3166-1 alpha-2 country code. Provide this parameter if you want to narrow the list of returned categories to those relevant to a particular country</td>
|
||||
<td><code>"DE"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[locale]</td>
|
||||
<td>The desired language, consisting of an ISO 639 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore</td>
|
||||
<td><code>"de_DE"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[limit]</td>
|
||||
<td>The maximum number of categories 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 item to return. Default: 0 (the first object).</td>
|
||||
<td><code>0</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Returns a <strong>CategoryList</strong> object, which has the property <code>Paging<Category> Categories</code>.</p>
|
||||
<p><strong>Usage</strong> </p>
|
||||
<pre><code class="cs">CategoryList categoryList = _spotify.GetCategories();
|
||||
categoryList.Categories.Items.ForEach(category => Console.WriteLine(category.Name));
|
||||
</code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="getcategory">GetCategory</h2>
|
||||
<p><span class="label label-warning">AUTH REQUIRED</span></p>
|
||||
<blockquote>
|
||||
<p>Get a single category used to tag items in Spotify (on, for example, the Spotify player’s “Browse” tab).</p>
|
||||
</blockquote>
|
||||
<p><strong>Paramters</strong> </p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
<th>Example</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>categoryId</td>
|
||||
<td>The Spotify category ID for the category.</td>
|
||||
<td><code>"party"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[country]</td>
|
||||
<td>A country: an ISO 3166-1 alpha-2 country code. Provide this parameter to ensure that the category exists for a particular country.</td>
|
||||
<td><code>"DE"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[locale]</td>
|
||||
<td>The desired language, consisting of an ISO 639 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore</td>
|
||||
<td><code>"de_DE"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#category-object">Category</a></p>
|
||||
<p><strong>Usage</strong> </p>
|
||||
<pre><code class="cs">Category cat = _spotify.GetCategory("party");
|
||||
Console.WriteLine(cat.Name);
|
||||
</code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="getcategoryplaylists">GetCategoryPlaylists</h2>
|
||||
<p><span class="label label-warning">AUTH REQUIRED</span></p>
|
||||
<blockquote>
|
||||
<p>Get a list of Spotify playlists tagged with a particular category.</p>
|
||||
</blockquote>
|
||||
<p><strong>Paramters</strong> </p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
<th>Example</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>categoryId</td>
|
||||
<td>The Spotify category ID for the category.</td>
|
||||
<td><code>"party"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[country]</td>
|
||||
<td>A country: an ISO 3166-1 alpha-2 country code.</td>
|
||||
<td><code>"DE"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[limit]</td>
|
||||
<td>The maximum number of items 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 item to return. Default: 0</td>
|
||||
<td><code>0</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Returns a <strong>CategoryPlaylist</strong> object, which has the property <code>Paging<SimplePlaylist> Playlists</code></p>
|
||||
<p><strong>Usage</strong> </p>
|
||||
<pre><code class="cs">CategoryPlaylist playlists = _spotify.GetCategoryPlaylists("party");
|
||||
playlists.Playlists.Items.ForEach(playlist => Console.WriteLine(playlist.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>
|
||||
@ -71,6 +71,10 @@
|
||||
<a href="../auth/">Authentication</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../search/">- Search</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../albums/">- Albums</a>
|
||||
</li>
|
||||
@ -79,6 +83,22 @@
|
||||
<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>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
|
||||
405
SpotifyWebApi/follow/index.html
Normal file
405
SpotifyWebApi/follow/index.html
Normal file
@ -0,0 +1,405 @@
|
||||
<!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>- Follow - 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="../search/">- Search</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../albums/">- Albums</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../artists/">- Artists</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../browse/">- Browse</a>
|
||||
</li>
|
||||
|
||||
<li class="active">
|
||||
<a href="./">- Follow</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../library/">- Library</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../playlists/">- Playlists</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="../browse/">
|
||||
<i class="fa fa-arrow-left"></i> Previous
|
||||
</a>
|
||||
</li>
|
||||
<li >
|
||||
<a rel="prev" href="../library/">
|
||||
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="#follow">Follow</a></li>
|
||||
|
||||
|
||||
<li class="main "><a href="#unfollow">Unfollow</a></li>
|
||||
|
||||
|
||||
<li class="main "><a href="#isfollowing">IsFollowing</a></li>
|
||||
|
||||
|
||||
<li class="main "><a href="#followplaylist">FollowPlaylist</a></li>
|
||||
|
||||
|
||||
<li class="main "><a href="#unfollowplaylist">UnfollowPlaylist</a></li>
|
||||
|
||||
|
||||
<li class="main "><a href="#isfollowingplaylist">IsFollowingPlaylist</a></li>
|
||||
|
||||
|
||||
</ul>
|
||||
</div></div>
|
||||
<div class="col-md-9" role="main">
|
||||
|
||||
<h2 id="follow">Follow</h2>
|
||||
<p><span class="label label-warning">AUTH REQUIRED</span></p>
|
||||
<blockquote>
|
||||
<p>Add the current user as a follower of one or more artists or other Spotify users.</p>
|
||||
</blockquote>
|
||||
<p><strong>Paramters</strong> </p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
<th>Example</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>followType</td>
|
||||
<td>The ID type: either artist or user.</td>
|
||||
<td><code>FollowType.Artist</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ids or id</td>
|
||||
<td>A list of the artist or the user Spotify IDs or just a Spotify ID</td>
|
||||
<td><code>new List<String> { "1KpCi9BOfviCVhmpI4G2sY" }</code> or <code>"1KpCi9BOfviCVhmpI4G2sY"</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.Follow(FollowType.Artist, "1KpCi9BOfviCVhmpI4G2sY");
|
||||
//or if it's a User
|
||||
ErrorResponse response = _spotify.Follow(FollowType.User, "1122095781");
|
||||
</code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="unfollow">Unfollow</h2>
|
||||
<p><span class="label label-warning">AUTH REQUIRED</span></p>
|
||||
<blockquote>
|
||||
<p>Remove the current user as a follower of one or more artists or other Spotify users.</p>
|
||||
</blockquote>
|
||||
<p><strong>Paramters</strong> </p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
<th>Example</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>followType</td>
|
||||
<td>The ID type: either artist or user.</td>
|
||||
<td><code>FollowType.Artist</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ids or id</td>
|
||||
<td>A list of the artist or the user Spotify IDs or just a Spotify ID</td>
|
||||
<td><code>new List<String> { "1KpCi9BOfviCVhmpI4G2sY" }</code> or <code>"1KpCi9BOfviCVhmpI4G2sY"</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.Unfollow(FollowType.Artist, "1KpCi9BOfviCVhmpI4G2sY");
|
||||
//or if it's a User
|
||||
ErrorResponse response = _spotify.Unfollow(FollowType.User, "1122095781");
|
||||
</code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="isfollowing">IsFollowing</h2>
|
||||
<p><span class="label label-warning">AUTH REQUIRED</span></p>
|
||||
<blockquote>
|
||||
<p>Check to see if the current user is following one or more artists or other Spotify users.</p>
|
||||
</blockquote>
|
||||
<p><strong>Paramters</strong> </p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
<th>Example</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>followType</td>
|
||||
<td>The ID type: either artist or user.</td>
|
||||
<td><code>FollowType.Artist</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ids or id</td>
|
||||
<td>A list of the artist or the user Spotify IDs or just a Spotify ID</td>
|
||||
<td><code>new List<String> { "1KpCi9BOfviCVhmpI4G2sY" }</code> or <code>"1KpCi9BOfviCVhmpI4G2sY"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Returns a <strong>ListResponse<Boolean></strong> which contains the property <code>List<Boolean> List</code></p>
|
||||
<p><strong>Usage</strong> </p>
|
||||
<pre><code class="cs">//Are you one of my Followers? :P
|
||||
ListResponse<Boolean> response = _spotify.IsFollowing(FollowType.User, "1122095781");
|
||||
Console.WriteLine(response.List[0] ? "Yis!" : "No :(");
|
||||
</code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="followplaylist">FollowPlaylist</h2>
|
||||
<p><span class="label label-warning">AUTH REQUIRED</span></p>
|
||||
<blockquote>
|
||||
<p>Add the current user as a follower of a playlist.</p>
|
||||
</blockquote>
|
||||
<p><strong>Paramters</strong> </p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
<th>Example</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>ownerId</td>
|
||||
<td>The Spotify user ID of the person who owns the playlist.</td>
|
||||
<td><code>"maxloermans"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>playlistId</td>
|
||||
<td>The Spotify ID of the playlist. Any playlist can be followed, regardless of its public/private status, as long as you know its playlist ID.</td>
|
||||
<td><code>"3SIp2VAsKI03mReF0dFBmI"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[showPublic]</td>
|
||||
<td>If true the playlist will be included in user's public playlists, if false it will remain private.</td>
|
||||
<td><code>true</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.FollowPlaylist("maxloermans", "3SIp2VAsKI03mReF0dFBmI");
|
||||
if(!response.HasError())
|
||||
Console.WriteLine("success");
|
||||
</code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="unfollowplaylist">UnfollowPlaylist</h2>
|
||||
<p><span class="label label-warning">AUTH REQUIRED</span></p>
|
||||
<blockquote>
|
||||
<p>Remove the current user as a follower of a playlist.</p>
|
||||
</blockquote>
|
||||
<p><strong>Paramters</strong> </p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
<th>Example</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>ownerId</td>
|
||||
<td>The Spotify user ID of the person who owns the playlist.</td>
|
||||
<td><code>"maxloermans"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>playlistId</td>
|
||||
<td>The Spotify ID of the playlist that is to be no longer followed.</td>
|
||||
<td><code>"3SIp2VAsKI03mReF0dFBmI"</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.UnfollowPlaylist("maxloermans", "3SIp2VAsKI03mReF0dFBmI");
|
||||
if(!response.HasError())
|
||||
Console.WriteLine("success");
|
||||
</code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="isfollowingplaylist">IsFollowingPlaylist</h2>
|
||||
<p><span class="label label-warning">AUTH REQUIRED</span></p>
|
||||
<blockquote>
|
||||
<p>Check to see if one or more Spotify users are following a specified playlist.</p>
|
||||
</blockquote>
|
||||
<p><strong>Paramters</strong> </p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
<th>Example</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>ownerId</td>
|
||||
<td>The Spotify user ID of the person who owns the playlist.</td>
|
||||
<td><code>"maxloermans"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>playlistId</td>
|
||||
<td>The Spotify ID of the playlist.</td>
|
||||
<td><code>"3SIp2VAsKI03mReF0dFBmI"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ids or id</td>
|
||||
<td>A list of the artist or the user Spotify IDs or just a Spotify ID</td>
|
||||
<td><code>new List<String> { "1KpCi9BOfviCVhmpI4G2sY" }</code> or <code>"1KpCi9BOfviCVhmpI4G2sY"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Returns a <strong>ListResponse<Boolean></strong> which contains the property <code>List<Boolean> List</code></p>
|
||||
<p><strong>Usage</strong> </p>
|
||||
<pre><code class="cs">//Am I following the playlist?
|
||||
ListResponse<Boolean> response = _spotify.IsFollowing("maxloermans", "3SIp2VAsKI03mReF0dFBmI", "1122095781");
|
||||
Console.WriteLine(response.List[0] ? "Yis!" : "No :(");
|
||||
</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>
|
||||
@ -71,6 +71,10 @@
|
||||
<a href="../auth/">Authentication</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../search/">- Search</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../albums/">- Albums</a>
|
||||
</li>
|
||||
@ -79,6 +83,22 @@
|
||||
<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>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@ -166,17 +186,17 @@ Full-Method Reference: </p>
|
||||
<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 class="csharp">_spotify.UseAuth = false;
|
||||
<pre><code>_spotify.UseAuth = false;
|
||||
</code></pre>
|
||||
|
||||
<h2 id="tokentype">TokenType</h2>
|
||||
<p>The token-type. Normally "Bearer" or "Basic". </p>
|
||||
<pre><code class="csharp">_spotify.TokenType = "XXXXXXXXXXXXXXXX";
|
||||
<pre><code>_spotify.TokenType = "XXXXXXXXXXXXXXXX";
|
||||
</code></pre>
|
||||
|
||||
<h2 id="accesstoken">AccessToken</h2>
|
||||
<p>The access-token received by your auth-type. </p>
|
||||
<pre><code class="csharp">_spotify.AccessToken = "XXXXXXXXXXXXXXXX";
|
||||
<pre><code>_spotify.AccessToken = "XXXXXXXXXXXXXXXX";
|
||||
</code></pre></div>
|
||||
</div>
|
||||
|
||||
|
||||
341
SpotifyWebApi/library/index.html
Normal file
341
SpotifyWebApi/library/index.html
Normal file
@ -0,0 +1,341 @@
|
||||
<!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>
|
||||
|
||||
<li >
|
||||
<a href="../search/">- Search</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 class="active">
|
||||
<a href="./">- Library</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="../playlists/">- Playlists</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="../follow/">
|
||||
<i class="fa fa-arrow-left"></i> Previous
|
||||
</a>
|
||||
</li>
|
||||
<li >
|
||||
<a rel="prev" href="../playlists/">
|
||||
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>
|
||||
|
||||
|
||||
</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’s “Your Music” library.</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’s “Your Music” library.</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’s “Your Music” library.</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’s “Your Music” library.</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’s “Your Music” library.</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 /></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>
|
||||
657
SpotifyWebApi/playlists/index.html
Normal file
657
SpotifyWebApi/playlists/index.html
Normal file
@ -0,0 +1,657 @@
|
||||
<!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>- Playlists - 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="../search/">- Search</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 class="active">
|
||||
<a href="./">- Playlists</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="../library/">
|
||||
<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="#getuserplaylists">GetUserPlaylists</a></li>
|
||||
|
||||
|
||||
<li class="main "><a href="#getplaylist">GetPlaylist</a></li>
|
||||
|
||||
|
||||
<li class="main "><a href="#getplaylisttracks">GetPlaylistTracks</a></li>
|
||||
|
||||
|
||||
<li class="main "><a href="#createplaylist">CreatePlaylist</a></li>
|
||||
|
||||
|
||||
<li class="main "><a href="#updateplaylist">UpdatePlaylist</a></li>
|
||||
|
||||
|
||||
<li class="main "><a href="#replaceplaylisttracks">ReplacePlaylistTracks</a></li>
|
||||
|
||||
|
||||
<li class="main "><a href="#removeplaylisttracks">RemovePlaylistTracks</a></li>
|
||||
|
||||
|
||||
<li class="main "><a href="#removeplaylisttrack">RemovePlaylistTrack</a></li>
|
||||
|
||||
|
||||
<li class="main "><a href="#addplaylisttracks">AddPlaylistTracks</a></li>
|
||||
|
||||
|
||||
<li class="main "><a href="#addplaylisttrack">AddPlaylistTrack</a></li>
|
||||
|
||||
|
||||
<li class="main "><a href="#reorderplaylist">ReorderPlaylist</a></li>
|
||||
|
||||
|
||||
</ul>
|
||||
</div></div>
|
||||
<div class="col-md-9" role="main">
|
||||
|
||||
<h2 id="getuserplaylists">GetUserPlaylists</h2>
|
||||
<p><span class="label label-warning">AUTH REQUIRED</span></p>
|
||||
<blockquote>
|
||||
<p>Get a list of the playlists owned or followed by 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>
|
||||
<tr>
|
||||
<td>limit</td>
|
||||
<td>The maximum number of playlists to return. Default: 20. Minimum: 1. Maximum: 50.</td>
|
||||
<td>EXAMPLE</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>offset</td>
|
||||
<td>The index of the first playlist to return. Default: 0 (the first object)</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><strong>Usage</strong> </p>
|
||||
<pre><code class="cs"></code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="getplaylist">GetPlaylist</h2>
|
||||
<p><span class="label label-warning">AUTH REQUIRED</span></p>
|
||||
<blockquote>
|
||||
<p>Get a playlist owned by 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>
|
||||
<tr>
|
||||
<td>playlistId</td>
|
||||
<td>The Spotify ID for the playlist.</td>
|
||||
<td>EXAMPLE</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>
|
||||
</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>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><strong>Usage</strong> </p>
|
||||
<pre><code class="cs"></code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="getplaylisttracks">GetPlaylistTracks</h2>
|
||||
<p><span class="label label-warning">AUTH REQUIRED</span></p>
|
||||
<blockquote>
|
||||
<p>Get full details of the tracks of a playlist owned by 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>
|
||||
<tr>
|
||||
<td>playlistId</td>
|
||||
<td>The Spotify ID for the playlist.</td>
|
||||
<td>EXAMPLE</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>limit</td>
|
||||
<td>The maximum number of tracks to return. Default: 100. Minimum: 1. Maximum: 100.</td>
|
||||
<td>EXAMPLE</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>offset</td>
|
||||
<td>The index of the first object to return. Default: 0 (i.e., the first object)</td>
|
||||
<td>EXAMPLE</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>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><strong>Usage</strong> </p>
|
||||
<pre><code class="cs"></code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="createplaylist">CreatePlaylist</h2>
|
||||
<p><span class="label label-warning">AUTH REQUIRED</span></p>
|
||||
<blockquote>
|
||||
<p>Create a playlist for a Spotify user. (The playlist will be empty until you add tracks.)</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>
|
||||
<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>
|
||||
</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>
|
||||
</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><strong>Usage</strong> </p>
|
||||
<pre><code class="cs"></code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="updateplaylist">UpdatePlaylist</h2>
|
||||
<p><span class="label label-warning">AUTH REQUIRED</span></p>
|
||||
<blockquote>
|
||||
<p>Change a playlist’s name and public/private state. (The user must, of course, own the playlist.)</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>
|
||||
<tr>
|
||||
<td>playlistId</td>
|
||||
<td>The Spotify ID for the playlist.</td>
|
||||
<td>EXAMPLE</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>newName</td>
|
||||
<td>The new name for the playlist, for example "My New Playlist Title".</td>
|
||||
<td>EXAMPLE</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<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><strong>Usage</strong> </p>
|
||||
<pre><code class="cs"></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>
|
||||
</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>
|
||||
<tr>
|
||||
<td>playlistId</td>
|
||||
<td>The Spotify ID for the playlist.</td>
|
||||
<td>EXAMPLE</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>
|
||||
</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><strong>Usage</strong> </p>
|
||||
<pre><code class="cs"></code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="removeplaylisttracks">RemovePlaylistTracks</h2>
|
||||
<p><span class="label label-warning">AUTH REQUIRED</span></p>
|
||||
<blockquote>
|
||||
<p>Remove one or more tracks from a user’s playlist.</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>
|
||||
<tr>
|
||||
<td>playlistId</td>
|
||||
<td>The Spotify ID for the playlist.</td>
|
||||
<td>EXAMPLE</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>
|
||||
</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><strong>Usage</strong> </p>
|
||||
<pre><code class="cs"></code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="removeplaylisttrack">RemovePlaylistTrack</h2>
|
||||
<p><span class="label label-warning">AUTH REQUIRED</span></p>
|
||||
<blockquote>
|
||||
<p>Remove one or more tracks from a user’s playlist.</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>
|
||||
<tr>
|
||||
<td>playlistId</td>
|
||||
<td>The Spotify ID for the playlist.</td>
|
||||
<td>EXAMPLE</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>uri</td>
|
||||
<td>Spotify URI</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><strong>Usage</strong> </p>
|
||||
<pre><code class="cs"></code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="addplaylisttracks">AddPlaylistTracks</h2>
|
||||
<p><span class="label label-warning">AUTH REQUIRED</span></p>
|
||||
<blockquote>
|
||||
<p>Add one or more tracks to a user’s playlist.</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>
|
||||
<tr>
|
||||
<td>playlistId</td>
|
||||
<td>The Spotify ID for the playlist.</td>
|
||||
<td>EXAMPLE</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>uris</td>
|
||||
<td>A list of Spotify track URIs to add</td>
|
||||
<td>EXAMPLE</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>position</td>
|
||||
<td>The position to insert the tracks, a zero-based index</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><strong>Usage</strong> </p>
|
||||
<pre><code class="cs"></code></pre>
|
||||
|
||||
<hr />
|
||||
<h2 id="addplaylisttrack">AddPlaylistTrack</h2>
|
||||
<p><span class="label label-warning">AUTH REQUIRED</span></p>
|
||||
<blockquote>
|
||||
<p>Add one or more tracks to a user’s playlist.</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>
|
||||
<tr>
|
||||
<td>playlistId</td>
|
||||
<td>The Spotify ID for the playlist.</td>
|
||||
<td>EXAMPLE</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>uri</td>
|
||||
<td>A Spotify Track URI</td>
|
||||
<td>EXAMPLE</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>position</td>
|
||||
<td>The position to insert the tracks, a zero-based index</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><strong>Usage</strong> </p>
|
||||
<pre><code class="cs"></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>
|
||||
</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>
|
||||
<tr>
|
||||
<td>playlistId</td>
|
||||
<td>The Spotify ID for the playlist.</td>
|
||||
<td>EXAMPLE</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rangeStart</td>
|
||||
<td>The position of the first track to be reordered.</td>
|
||||
<td>EXAMPLE</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>insertBefore</td>
|
||||
<td>The position where the tracks should be inserted.</td>
|
||||
<td>EXAMPLE</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>rangeLength</td>
|
||||
<td>The amount of tracks to be reordered. Defaults to 1 if not set.</td>
|
||||
<td>EXAMPLE</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>snapshotId</td>
|
||||
<td>The playlist's snapshot ID against which you want to make the changes.</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><strong>Usage</strong> </p>
|
||||
<pre><code class="cs"></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>
|
||||
218
SpotifyWebApi/search/index.html
Normal file
218
SpotifyWebApi/search/index.html
Normal file
@ -0,0 +1,218 @@
|
||||
<!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>- Search - 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 class="active">
|
||||
<a href="./">- Search</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>
|
||||
|
||||
</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="../auth/">
|
||||
<i class="fa fa-arrow-left"></i> Previous
|
||||
</a>
|
||||
</li>
|
||||
<li >
|
||||
<a rel="prev" href="../albums/">
|
||||
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="#searchitems">SearchItems</a></li>
|
||||
|
||||
|
||||
</ul>
|
||||
</div></div>
|
||||
<div class="col-md-9" role="main">
|
||||
|
||||
<h2 id="searchitems">SearchItems</h2>
|
||||
<blockquote>
|
||||
<p>Get Spotify catalog information about artists, albums, tracks or playlists that match a keyword string.</p>
|
||||
</blockquote>
|
||||
<p><strong>Paramters</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
<th>Example</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>q</td>
|
||||
<td>The search query's keywords (and optional field filters and operators), for example q=roadhouse+blues.</td>
|
||||
<td><code>"roadhouse+blues"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>type</td>
|
||||
<td>A list of item types to search across.</td>
|
||||
<td><code>SearchType.Album</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[limit]</td>
|
||||
<td>The maximum number of items 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 result to return. Default: 0</td>
|
||||
<td><code>0</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[market]</td>
|
||||
<td>An ISO 3166-1 alpha-2 country code or the string from_token.</td>
|
||||
<td><code>"de"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Returns a <strong>SearchItem</strong> which contains the properties <code>Paging<SimpleArtist> Artists</code>,<code>Paging<FullTrack> Tracks</code>, <code>Paging<SimpleAlbum> Albums</code>. They are filled based on your search-type.</p>
|
||||
<p><strong>Usage</strong></p>
|
||||
<pre><code class="cs">SearchItem item = _spotify.SearchItems("roadhouse+blues", SearchType.Album);
|
||||
Console.WriteLine(item.Albums.Total); //How many results are there in total? NOTE: item.Tracks = item.Artists = null
|
||||
</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>
|
||||
20
index.html
20
index.html
@ -71,6 +71,10 @@
|
||||
<a href="SpotifyWebApi/auth/">Authentication</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="SpotifyWebApi/search/">- Search</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="SpotifyWebApi/albums/">- Albums</a>
|
||||
</li>
|
||||
@ -79,6 +83,22 @@
|
||||
<a href="SpotifyWebApi/artists/">- Artists</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="SpotifyWebApi/browse/">- Browse</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="SpotifyWebApi/follow/">- Follow</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="SpotifyWebApi/library/">- Library</a>
|
||||
</li>
|
||||
|
||||
<li >
|
||||
<a href="SpotifyWebApi/playlists/">- Playlists</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
|
||||
File diff suppressed because one or more lines are too long
44
sitemap.xml
44
sitemap.xml
@ -4,7 +4,7 @@
|
||||
|
||||
<url>
|
||||
<loc>None/</loc>
|
||||
<lastmod>2015-07-09</lastmod>
|
||||
<lastmod>2015-07-23</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
|
||||
@ -13,31 +13,61 @@
|
||||
|
||||
<url>
|
||||
<loc>None/SpotifyWebApi/gettingstarted/</loc>
|
||||
<lastmod>2015-07-09</lastmod>
|
||||
<lastmod>2015-07-23</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
|
||||
<url>
|
||||
<loc>None/SpotifyWebApi/examples/</loc>
|
||||
<lastmod>2015-07-09</lastmod>
|
||||
<lastmod>2015-07-23</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
|
||||
<url>
|
||||
<loc>None/SpotifyWebApi/auth/</loc>
|
||||
<lastmod>2015-07-09</lastmod>
|
||||
<lastmod>2015-07-23</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
|
||||
<url>
|
||||
<loc>None/SpotifyWebApi/search/</loc>
|
||||
<lastmod>2015-07-23</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
|
||||
<url>
|
||||
<loc>None/SpotifyWebApi/albums/</loc>
|
||||
<lastmod>2015-07-09</lastmod>
|
||||
<lastmod>2015-07-23</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
|
||||
<url>
|
||||
<loc>None/SpotifyWebApi/artists/</loc>
|
||||
<lastmod>2015-07-09</lastmod>
|
||||
<lastmod>2015-07-23</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
|
||||
<url>
|
||||
<loc>None/SpotifyWebApi/browse/</loc>
|
||||
<lastmod>2015-07-23</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
|
||||
<url>
|
||||
<loc>None/SpotifyWebApi/follow/</loc>
|
||||
<lastmod>2015-07-23</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
|
||||
<url>
|
||||
<loc>None/SpotifyWebApi/library/</loc>
|
||||
<lastmod>2015-07-23</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
|
||||
<url>
|
||||
<loc>None/SpotifyWebApi/playlists/</loc>
|
||||
<lastmod>2015-07-23</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
|
||||
@ -47,7 +77,7 @@
|
||||
|
||||
<url>
|
||||
<loc>None/SpotifyLocalApi/</loc>
|
||||
<lastmod>2015-07-09</lastmod>
|
||||
<lastmod>2015-07-23</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user