sarsoo/Spotify.NET
1
0
Fork 0
mirror of https://github.com/Sarsoo/Spotify.NET.git synced 2024-12-25 23:46:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
d7bf9c7405
Spotify.NET/SpotifyWebAPI/follow/index.html

418 lines
14 KiB
HTML
Raw Normal View History

Built docs | AppVeyor Build 236
2017-10-27 16:37:28 +01: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>- 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="../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>
Built docs | AppVeyor Build 255
2018-01-15 22:33:15 +00:00
<li >
<a href="../personalization/">- Personalization</a>
</li>
Built docs | AppVeyor Build 236
2017-10-27 16:37:28 +01:00
<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="../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&lt;String&gt; { "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, &quot;1KpCi9BOfviCVhmpI4G2sY&quot;);
//or if it's a User
ErrorResponse response = _spotify.Follow(FollowType.User, &quot;1122095781&quot;);
</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&lt;String&gt; { "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, &quot;1KpCi9BOfviCVhmpI4G2sY&quot;);
//or if it's a User
ErrorResponse response = _spotify.Unfollow(FollowType.User, &quot;1122095781&quot;);
</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&lt;String&gt; { "1KpCi9BOfviCVhmpI4G2sY" }</code> or <code>"1KpCi9BOfviCVhmpI4G2sY"</code></td>
</tr>
</tbody>
</table>
<p>Returns a <strong>ListResponse<Boolean></strong> which contains the property <code>List&lt;Boolean&gt; List</code></p>
<p><strong>Usage</strong> </p>
<pre><code class="cs">//Are you one of my Followers? :P
ListResponse&lt;Boolean&gt; response = _spotify.IsFollowing(FollowType.User, &quot;1122095781&quot;);
Console.WriteLine(response.List[0] ? &quot;Yis!&quot; : &quot;No :(&quot;);
</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(&quot;maxloermans&quot;, &quot;3SIp2VAsKI03mReF0dFBmI&quot;);
if(!response.HasError())
Console.WriteLine(&quot;success&quot;);
</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(&quot;maxloermans&quot;, &quot;3SIp2VAsKI03mReF0dFBmI&quot;);
if(!response.HasError())
Console.WriteLine(&quot;success&quot;);
</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&lt;String&gt; { "1KpCi9BOfviCVhmpI4G2sY" }</code> or <code>"1KpCi9BOfviCVhmpI4G2sY"</code></td>
</tr>
</tbody>
</table>
<p>Returns a <strong>ListResponse<Boolean></strong> which contains the property <code>List&lt;Boolean&gt; List</code></p>
<p><strong>Usage</strong> </p>
<pre><code class="cs">//Am I following the playlist?
ListResponse&lt;Boolean&gt; response = _spotify.IsFollowing(&quot;maxloermans&quot;, &quot;3SIp2VAsKI03mReF0dFBmI&quot;, &quot;1122095781&quot;);
Console.WriteLine(response.List[0] ? &quot;Yis!&quot; : &quot;No :(&quot;);
</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