Spotify.NET/SpotifyWebAPI/albums/index.html
2015-07-26 14:22:35 +00:00

294 lines
9.7 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>- Albums - 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="./">- Albums</a>
</li>
<li >
<a href="../artists/">- Artists</a>
</li>
<li >
<a href="../browse/">- Browse</a>
</li>
<li >
<a href="../follow/">- Follow</a>
</li>
<li >
<a href="../library/">- Library</a>
</li>
<li >
<a href="../playlists/">- Playlists</a>
</li>
<li >
<a href="../profiles/">- Profiles</a>
</li>
<li >
<a href="../search/">- Search</a>
</li>
<li >
<a href="../tracks/">- Tracks</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalAPI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="../../SpotifyLocalAPI/">SpotifyLocalAPI</a>
</li>
</ul>
</li>
</ul>
<!-- Search, Navigation and Repo links -->
<ul class="nav navbar-nav navbar-right">
<li >
<a rel="next" href="../auth/">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li >
<a rel="prev" href="../artists/">
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="#getalbumtracks">GetAlbumTracks</a></li>
<li class="main "><a href="#getalbum">GetAlbum</a></li>
<li class="main "><a href="#getseveralalbums">GetSeveralAlbums</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h2 id="getalbumtracks">GetAlbumTracks</h2>
<blockquote>
<p>Get Spotify catalog information about an album's tracks. Optional parameters can be used to limit the number of tracks returned.</p>
</blockquote>
<p><strong>Paramters</strong> </p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>The Spotify ID for the album.</td>
<td><code>"5O7V8l4SeXTymVp3IesT9C"</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 track to return. Default: 0 (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 <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="cs">Paging&lt;SimpleTrack&gt; tracks = _spotify.GetAlbumTracks(&quot;5O7V8l4SeXTymVp3IesT9C&quot;);
tracks.Items.ForEach(item =&gt; 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>
<blockquote>
<p>Get Spotify catalog information for a single album.</p>
</blockquote>
<p><strong>Paramters</strong> </p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>The Spotify ID for the album.</td>
<td><code>5O7V8l4SeXTymVp3IesT9C</code></td>
</tr>
<tr>
<td>[market]</td>
<td>An ISO 3166-1 alpha-2 country code. Provide this parameter if you want to apply Track Relinking.</td>
<td><code>"DE"</code></td>
</tr>
</tbody>
</table>
<p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#album-object-full">FullAlbum</a></p>
<p><strong>Usage</strong> </p>
<pre><code class="cs">FullAlbum album = _spotify.GetAlbum(&quot;5O7V8l4SeXTymVp3IesT9C&quot;);
Console.WriteLine(album.Name + &quot;| Popularity: &quot; + album.Popularity); //Display name and Popularity
</code></pre>
<hr />
<h2 id="getseveralalbums">GetSeveralAlbums</h2>
<blockquote>
<p>Get Spotify catalog information for multiple albums identified by their Spotify IDs.</p>
</blockquote>
<p><strong>Paramters</strong> </p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td>ids</td>
<td>A list of the Spotify IDs for the albums. Maximum: 20 IDs.</td>
<td><code>new List&lt;String&gt;() { "5O7V8l4SeXTymVp3IesT9C" }</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>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="cs">SeveralAlbums albums = _spotify.GetSeveralAlbums(new List&lt;String&gt;() { &quot;5O7V8l4SeXTymVp3IesT9C&quot; });
Console.WriteLine(albums.Albums[0].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>