mirror of
https://github.com/Sarsoo/Spotify.NET.git
synced 2024-12-26 07:56:26 +00:00
407 lines
13 KiB
HTML
407 lines
13 KiB
HTML
<!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="../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="../player/">- Player</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../playlists/">- Playlists</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../profiles/">- Profiles</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../search/">- Search</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../tracks/">- Tracks</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../util/">- Util</a>
|
||
</li>
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
<li >
|
||
<a href="../../SpotifyLocalAPI/">SpotifyLocalAPI</a>
|
||
</li>
|
||
|
||
|
||
</ul>
|
||
|
||
<!-- Search, Navigation and Repo links -->
|
||
<ul class="nav navbar-nav navbar-right">
|
||
|
||
<li >
|
||
<a rel="next" href="../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://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.4/highlight.min.js"></script>
|
||
<script src="https://code.jquery.com/jquery-1.10.2.min.js"></script>
|
||
<script src="../../js/bootstrap-3.0.3.min.js"></script>
|
||
<script src="../../js/base.js"></script>
|
||
<script src="../../highlight.js"></script>
|
||
</body>
|
||
</html> |