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

Built mkdocs | Travis Build 19

Browse Source
This commit is contained in:
Travis-CI 2015-12-07 13:20:34 +00:00
parent 1d0190eed4
commit ddc05e80c3
5 changed files with 231 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
SpotifyWebAPI/gettingstarted/index.html
View File

@ -279,6 +279,11 @@ Example:</p>
<li><a href="../../SpotifyWebAPI/library#getsavedtracks">GetSavedTracks</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#removesavedtracks">RemoveSavedTracks</a></li>
<li><a href="../../SpotifyWebAPI/library#checksavedtracks">CheckSavedTracks</a></li> <li><a href="../../SpotifyWebAPI/library#checksavedtracks">CheckSavedTracks</a></li>
<li><a href="../../SpotifyWebAPI/library#savealbums">SaveAlbums</a></li>
<li><a href="../../SpotifyWebAPI/library#savealbum">SaveAlbum</a></li>
<li><a href="../../SpotifyWebAPI/library#getsavedalbums">GetSavedAlbums</a></li>
<li><a href="../../SpotifyWebAPI/library#removesavedalbums">RemoveSavedAlbums</a></li>
<li><a href="../../SpotifyWebAPI/library#checksavedalbums">CheckSavedAlbums</a></li>
</ul> </ul>
<h3 id="playlists">Playlists</h3> <h3 id="playlists">Playlists</h3>
<ul> <ul>

174
SpotifyWebAPI/library/index.html
View File

@ -177,6 +177,21 @@
<li class="main "><a href="#checksavedtracks">CheckSavedTracks</a></li> <li class="main "><a href="#checksavedtracks">CheckSavedTracks</a></li>
<li class="main "><a href="#savealbums">SaveAlbums</a></li>
<li class="main "><a href="#savealbum">SaveAlbum</a></li>
<li class="main "><a href="#getsavedalbums">GetSavedAlbums</a></li>
<li class="main "><a href="#removesavedalbums">RemoveSavedAlbums</a></li>
<li class="main "><a href="#checksavedalbums">CheckSavedAlbums</a></li>
</ul> </ul>
</div></div> </div></div>
<div class="col-md-9" role="main"> <div class="col-md-9" role="main">
@ -339,6 +354,165 @@ if(tracksSaved.List[0])
Console.WriteLine(&quot;The track is in your library!&quot;); Console.WriteLine(&quot;The track is in your library!&quot;);
</code></pre> </code></pre>
<hr />
<h2 id="savealbums">SaveAlbums</h2>
<p><span class="label label-warning">AUTH REQUIRED</span></p>
<blockquote>
<p>Save one or more albums to the current user’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&lt;String&gt; { "1cq06d0kTUnFmJHixz1RaF" }</code></td>
</tr>
</tbody>
</table>
<p>Returns a <strong>ErrorResponse</strong> which just contains a possible error. (<code>response.HasError()</code> and <code>response.Error</code>)</p>
<p><strong>Usage</strong> </p>
<pre><code class="cs">ErrorResponse response = _spotify.SaveAlbums(new List&lt;string&gt; { &quot;1cq06d0kTUnFmJHixz1RaF&quot; });
if(!response.HasError())
Console.WriteLine(&quot;success&quot;);
</code></pre>
<hr />
<h2 id="savealbum">SaveAlbum</h2>
<p><span class="label label-warning">AUTH REQUIRED</span></p>
<blockquote>
<p>Save one album to the current user’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>"1cq06d0kTUnFmJHixz1RaF"</code></td>
</tr>
</tbody>
</table>
<p>Returns a <strong>ErrorResponse</strong> which just contains a possible error. (<code>response.HasError()</code> and <code>response.Error</code>)</p>
<p><strong>Usage</strong> </p>
<pre><code class="cs">ErrorResponse response = _spotify.SaveAlbum(&quot;1cq06d0kTUnFmJHixz1RaF&quot;);
if(!response.HasError())
Console.WriteLine(&quot;success&quot;);
</code></pre>
<hr />
<h2 id="getsavedalbums">GetSavedAlbums</h2>
<p><span class="label label-warning">AUTH REQUIRED</span></p>
<blockquote>
<p>Get a list of the albums saved in the current Spotify user’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 <code>Paging&lt;SavedAlbum&gt;</code>, <strong>SavedAlbum</strong> contains 2 properties, <code>DateTime AddedAt</code> and <code>FullAlbum Album</code></p>
<p><strong>Usage</strong> </p>
<pre><code class="cs">Paging&lt;SavedAlbum&gt; savedAlbums = _spotify.GetSavedAlbums();
savedAlbums.Items.ForEach(album =&gt; Console.WriteLine(album.Album.Name));
</code></pre>
<hr />
<h2 id="removesavedalbums">RemoveSavedAlbums</h2>
<p><span class="label label-warning">AUTH REQUIRED</span></p>
<blockquote>
<p>Remove one or more albums from the current user’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&lt;String&gt; { "1cq06d0kTUnFmJHixz1RaF" }</code></td>
</tr>
</tbody>
</table>
<p>Returns a <strong>ErrorResponse</strong> which just contains a possible error. (<code>response.HasError()</code> and <code>response.Error</code>)</p>
<p><strong>Usage</strong> </p>
<pre><code class="cs">ErrorResponse response = _spotify.RemoveSavedAlbums(new List&lt;string&gt; { &quot;1cq06d0kTUnFmJHixz1RaF&quot; });
if(!response.HasError())
Console.WriteLine(&quot;success&quot;);
</code></pre>
<hr />
<h2 id="checksavedalbums">CheckSavedAlbums</h2>
<p><span class="label label-warning">AUTH REQUIRED</span></p>
<blockquote>
<p>Check if one or more albums is already saved in the current Spotify user’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&lt;String&gt; { "1cq06d0kTUnFmJHixz1RaF" }</code></td>
</tr>
</tbody>
</table>
<p>Returns a <strong>ListResponse<bool></strong> which contains a property, <code>List&lt;bool&gt; List</code></p>
<p><strong>Usage</strong> </p>
<pre><code class="cs">ListResponse&lt;bool&gt; albumsSaved = _spotify.CheckSavedAlbums(new List&lt;String&gt; { &quot;1cq06d0kTUnFmJHixz1RaF&quot; });
if(albumsSaved.List[0])
Console.WriteLine(&quot;The album is in your library!&quot;);
</code></pre>
<hr /></div> <hr /></div>
</div> </div>

31
mkdocs/search_index.json
View File

File diff suppressed because one or more lines are too long

30
sitemap.xml
View File

@ -4,7 +4,7 @@
<url> <url>
<loc>None/</loc> <loc>None/</loc>
<lastmod>2015-11-07</lastmod> <lastmod>2015-12-07</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
@ -13,79 +13,79 @@
<url> <url>
<loc>None/SpotifyWebAPI/gettingstarted/</loc> <loc>None/SpotifyWebAPI/gettingstarted/</loc>
<lastmod>2015-11-07</lastmod> <lastmod>2015-12-07</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/examples/</loc> <loc>None/SpotifyWebAPI/examples/</loc>
<lastmod>2015-11-07</lastmod> <lastmod>2015-12-07</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/auth/</loc> <loc>None/SpotifyWebAPI/auth/</loc>
<lastmod>2015-11-07</lastmod> <lastmod>2015-12-07</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/albums/</loc> <loc>None/SpotifyWebAPI/albums/</loc>
<lastmod>2015-11-07</lastmod> <lastmod>2015-12-07</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/artists/</loc> <loc>None/SpotifyWebAPI/artists/</loc>
<lastmod>2015-11-07</lastmod> <lastmod>2015-12-07</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/browse/</loc> <loc>None/SpotifyWebAPI/browse/</loc>
<lastmod>2015-11-07</lastmod> <lastmod>2015-12-07</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/follow/</loc> <loc>None/SpotifyWebAPI/follow/</loc>
<lastmod>2015-11-07</lastmod> <lastmod>2015-12-07</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/library/</loc> <loc>None/SpotifyWebAPI/library/</loc>
<lastmod>2015-11-07</lastmod> <lastmod>2015-12-07</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/playlists/</loc> <loc>None/SpotifyWebAPI/playlists/</loc>
<lastmod>2015-11-07</lastmod> <lastmod>2015-12-07</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/profiles/</loc> <loc>None/SpotifyWebAPI/profiles/</loc>
<lastmod>2015-11-07</lastmod> <lastmod>2015-12-07</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/search/</loc> <loc>None/SpotifyWebAPI/search/</loc>
<lastmod>2015-11-07</lastmod> <lastmod>2015-12-07</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/tracks/</loc> <loc>None/SpotifyWebAPI/tracks/</loc>
<lastmod>2015-11-07</lastmod> <lastmod>2015-12-07</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/util/</loc> <loc>None/SpotifyWebAPI/util/</loc>
<lastmod>2015-11-07</lastmod> <lastmod>2015-12-07</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
@ -95,7 +95,7 @@
<url> <url>
<loc>None/SpotifyLocalAPI/</loc> <loc>None/SpotifyLocalAPI/</loc>
<lastmod>2015-11-07</lastmod> <lastmod>2015-12-07</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>