sarsoo/Spotify.NET
1
0
Fork 0
mirror of https://github.com/Sarsoo/Spotify.NET.git synced 2024-12-25 15:36:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
978a183ccd
Spotify.NET/SpotifyWebAPI/personalization/index.html

308 lines
10 KiB
HTML
Raw Normal View History

Built docs | AppVeyor Build 255
2018-01-15 22:33:15 +00:00
<!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>- Personalization - 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>
Built docs | AppVeyor Build 272
2018-03-25 18:58:06 +01:00
<li >
<a href="../proxy/">Proxy</a>
</li>
Built docs | AppVeyor Build 255
2018-01-15 22:33:15 +00:00
<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="./">- Personalization</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="../library/">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li >
<a rel="prev" href="../player/">
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="#getuserstoptracks">GetUsersTopTracks</a></li>
<li class="main "><a href="#getuserstopartists">GetUsersTopArtists</a></li>
<li class="main "><a href="#getusersrecentlyplayedtracks">GetUsersRecentlyPlayedTracks</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h2 id="getuserstoptracks">GetUsersTopTracks</h2>
<blockquote>
<p>Get the current user’s top tracks based on calculated affinity.</p>
</blockquote>
<p><strong>Parameters</strong> </p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td>[timeRange]</td>
<td>Over what time frame the affinities are compute.</td>
<td><code>TimeRangeType.MediumTerm</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 entity to return. Default: 0 (i.e., the first track). Use with limit to get the next set of entities.</td>
<td><code>0</code></td>
</tr>
</tbody>
</table>
<p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#track-object-full">FullTrack</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>Paging&lt;FullTrack&gt; tracks = _spotify.GetUsersTopTracks();
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="getuserstopartists">GetUsersTopArtists</h2>
<blockquote>
<p>Get the current user’s top artists based on calculated affinity.</p>
</blockquote>
<p><strong>Parameters</strong> </p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td>[timeRange]</td>
<td>Over what time frame the affinities are compute.</td>
<td><code>TimeRangeType.MediumTerm</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 entity to return. Default: 0 (i.e., the first track). Use with limit to get the next set of entities.</td>
<td><code>0</code></td>
</tr>
</tbody>
</table>
<p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#artist-object-full">FullArtist</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>Paging&lt;FullArtist&gt; artists = _spotify.GetUsersTopArtists();
artists.Items.ForEach(item =&gt; Console.WriteLine(item.Name)); //Display all fetched Artist-Names (max 20)
</code></pre>
<hr />
<h2 id="getusersrecentlyplayedtracks">GetUsersRecentlyPlayedTracks</h2>
<blockquote>
<p>Get tracks from the current user’s recent play history.</p>
</blockquote>
<p><strong>Parameters</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 items to return. Default: 20. Minimum: 1. Maximum: 50.</td>
<td><code>20</code></td>
</tr>
<tr>
<td>[after]</td>
<td>Returns all items after (but not including) this cursor position.</td>
<td><code>DateTime.Now.AddDays(-1)</code></td>
</tr>
<tr>
<td>[before]</td>
<td>Returns all items before (but not including) this cursor position.</td>
<td><code>DateTime.Now.AddDays(-1)</code></td>
</tr>
</tbody>
</table>
<p>Returns a <code>PlayHistory</code> wrapped inside a <a href="https://developer.spotify.com/web-api/object-model/#cursor-based-paging-object">CursorPaging-object</a></p>
<p><strong>Usage</strong> </p>
<pre><code>CursorPaging&lt;PlayHistory&gt; histories = _spotify.GetUsersRecentlyPlayedTracks();
histories.Items.ForEach(item =&gt; Console.WriteLine(item.Track.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>
Reference in New Issue Copy Permalink