Skip to content

Commit f0cd737

Browse files
adamintadamint
committed
push new docs
Signed-off-by: Adam Ratzman <[email protected]>
1 parent b2a5872 commit f0cd737

File tree

938 files changed

+34861
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

938 files changed

+34861
-0
lines changed

‎docs/-spotify-kotlin-wrapper/alltypes/index.html

Lines changed: 591 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/-spotify-kotlin-wrapper/com.adamratzman.spotify.endpoints.client/-client-following-a-p-i/-init-.html

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<HTML>
2+
<HEAD>
3+
<meta charset="UTF-8">
4+
<title>ClientFollowingAPI.<init> - SpotifyKotlinWrapper</title>
5+
<link rel="stylesheet" href="../../../style.css">
6+
</HEAD>
7+
<BODY>
8+
<a href="../../index.html">SpotifyKotlinWrapper</a>&nbsp;/&nbsp;<a href="../index.html">com.adamratzman.spotify.endpoints.client</a>&nbsp;/&nbsp;<a href="index.html">ClientFollowingAPI</a>&nbsp;/&nbsp;<a href="./-init-.html">&lt;init&gt;</a><br/>
9+
<br/>
10+
<h1>&lt;init&gt;</h1>
11+
<a name="com.adamratzman.spotify.endpoints.client.ClientFollowingAPI$&lt;init&gt;(com.adamratzman.spotify.main.SpotifyAPI)"></a>
12+
<code><span class="identifier">ClientFollowingAPI</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientFollowingAPI$<init>(com.adamratzman.spotify.main.SpotifyAPI)/api">api</span><span class="symbol">:</span>&nbsp;<a href="../../com.adamratzman.spotify.main/-spotify-a-p-i/index.html"><span class="identifier">SpotifyAPI</span></a><span class="symbol">)</span></code>
13+
<p>These endpoints allow you manage the artists, users and playlists that a Spotify user follows.</p>
14+
</BODY>
15+
</HTML>

‎docs/-spotify-kotlin-wrapper/com.adamratzman.spotify.endpoints.client/-client-following-a-p-i/follow-artist.html

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<HTML>
2+
<HEAD>
3+
<meta charset="UTF-8">
4+
<title>ClientFollowingAPI.followArtist - SpotifyKotlinWrapper</title>
5+
<link rel="stylesheet" href="../../../style.css">
6+
</HEAD>
7+
<BODY>
8+
<a href="../../index.html">SpotifyKotlinWrapper</a>&nbsp;/&nbsp;<a href="../index.html">com.adamratzman.spotify.endpoints.client</a>&nbsp;/&nbsp;<a href="index.html">ClientFollowingAPI</a>&nbsp;/&nbsp;<a href="./follow-artist.html">followArtist</a><br/>
9+
<br/>
10+
<h1>followArtist</h1>
11+
<a name="com.adamratzman.spotify.endpoints.client.ClientFollowingAPI$followArtist(kotlin.String)"></a>
12+
<code><span class="keyword">fun </span><span class="identifier">followArtist</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientFollowingAPI$followArtist(kotlin.String)/artistId">artistId</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.adamratzman.spotify.main/-spotify-rest-action/index.html"><span class="identifier">SpotifyRestAction</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a><span class="symbol">&gt;</span></code>
13+
<p>Add the current user as a follower of an artist</p>
14+
<h3>Exceptions</h3>
15+
<p><a name="BadRequestException"></a>
16+
<code>BadRequestException</code> - if an invalid id is provided</p>
17+
</BODY>
18+
</HTML>

‎docs/-spotify-kotlin-wrapper/com.adamratzman.spotify.endpoints.client/-client-following-a-p-i/follow-artists.html

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<HTML>
2+
<HEAD>
3+
<meta charset="UTF-8">
4+
<title>ClientFollowingAPI.followArtists - SpotifyKotlinWrapper</title>
5+
<link rel="stylesheet" href="../../../style.css">
6+
</HEAD>
7+
<BODY>
8+
<a href="../../index.html">SpotifyKotlinWrapper</a>&nbsp;/&nbsp;<a href="../index.html">com.adamratzman.spotify.endpoints.client</a>&nbsp;/&nbsp;<a href="index.html">ClientFollowingAPI</a>&nbsp;/&nbsp;<a href="./follow-artists.html">followArtists</a><br/>
9+
<br/>
10+
<h1>followArtists</h1>
11+
<a name="com.adamratzman.spotify.endpoints.client.ClientFollowingAPI$followArtists(kotlin.Array((kotlin.String)))"></a>
12+
<code><span class="keyword">fun </span><span class="identifier">followArtists</span><span class="symbol">(</span><span class="keyword">vararg</span> <span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientFollowingAPI$followArtists(kotlin.Array((kotlin.String)))/artists">artists</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.adamratzman.spotify.main/-spotify-rest-action/index.html"><span class="identifier">SpotifyRestAction</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a><span class="symbol">&gt;</span></code>
13+
<p>Add the current user as a follower of other artists</p>
14+
<h3>Exceptions</h3>
15+
<p><a name="BadRequestException"></a>
16+
<code>BadRequestException</code> - if an invalid id is provided</p>
17+
</BODY>
18+
</HTML>

‎docs/-spotify-kotlin-wrapper/com.adamratzman.spotify.endpoints.client/-client-following-a-p-i/follow-playlist.html

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<HTML>
2+
<HEAD>
3+
<meta charset="UTF-8">
4+
<title>ClientFollowingAPI.followPlaylist - SpotifyKotlinWrapper</title>
5+
<link rel="stylesheet" href="../../../style.css">
6+
</HEAD>
7+
<BODY>
8+
<a href="../../index.html">SpotifyKotlinWrapper</a>&nbsp;/&nbsp;<a href="../index.html">com.adamratzman.spotify.endpoints.client</a>&nbsp;/&nbsp;<a href="index.html">ClientFollowingAPI</a>&nbsp;/&nbsp;<a href="./follow-playlist.html">followPlaylist</a><br/>
9+
<br/>
10+
<h1>followPlaylist</h1>
11+
<a name="com.adamratzman.spotify.endpoints.client.ClientFollowingAPI$followPlaylist(kotlin.String, kotlin.Boolean)"></a>
12+
<code><span class="keyword">fun </span><span class="identifier">followPlaylist</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientFollowingAPI$followPlaylist(kotlin.String, kotlin.Boolean)/playlist">playlist</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientFollowingAPI$followPlaylist(kotlin.String, kotlin.Boolean)/followPublicly">followPublicly</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a>&nbsp;<span class="symbol">=</span>&nbsp;true<span class="symbol">)</span><span class="symbol">: </span><a href="../../com.adamratzman.spotify.main/-spotify-rest-action/index.html"><span class="identifier">SpotifyRestAction</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a><span class="symbol">&gt;</span></code>
13+
<p>Add the current user as a follower of a playlist.</p>
14+
<h3>Parameters</h3>
15+
<p><a name="playlist"></a>
16+
<code>playlist</code> - the spotify id or uri of the playlist. Any playlist can be followed, regardless of its
17+
public/private status, as long as you know its playlist ID.</p>
18+
<p><a name="followPublicly"></a>
19+
<code>followPublicly</code> - Defaults to true. If true the playlist will be included in user’s public playlists,
20+
if false it will remain private. To be able to follow playlists privately, the user must have granted the playlist-modify-private scope.</p>
21+
<h3>Exceptions</h3>
22+
<p><a name="BadRequestException"></a>
23+
<code>BadRequestException</code> - if the playlist is not found</p>
24+
</BODY>
25+
</HTML>

‎docs/-spotify-kotlin-wrapper/com.adamratzman.spotify.endpoints.client/-client-following-a-p-i/follow-user.html

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<HTML>
2+
<HEAD>
3+
<meta charset="UTF-8">
4+
<title>ClientFollowingAPI.followUser - SpotifyKotlinWrapper</title>
5+
<link rel="stylesheet" href="../../../style.css">
6+
</HEAD>
7+
<BODY>
8+
<a href="../../index.html">SpotifyKotlinWrapper</a>&nbsp;/&nbsp;<a href="../index.html">com.adamratzman.spotify.endpoints.client</a>&nbsp;/&nbsp;<a href="index.html">ClientFollowingAPI</a>&nbsp;/&nbsp;<a href="./follow-user.html">followUser</a><br/>
9+
<br/>
10+
<h1>followUser</h1>
11+
<a name="com.adamratzman.spotify.endpoints.client.ClientFollowingAPI$followUser(kotlin.String)"></a>
12+
<code><span class="keyword">fun </span><span class="identifier">followUser</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientFollowingAPI$followUser(kotlin.String)/user">user</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.adamratzman.spotify.main/-spotify-rest-action/index.html"><span class="identifier">SpotifyRestAction</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a><span class="symbol">&gt;</span></code>
13+
<p>Add the current user as a follower of another user</p>
14+
<h3>Exceptions</h3>
15+
<p><a name="BadRequestException"></a>
16+
<code>BadRequestException</code> - if an invalid id is provided</p>
17+
</BODY>
18+
</HTML>

‎docs/-spotify-kotlin-wrapper/com.adamratzman.spotify.endpoints.client/-client-following-a-p-i/follow-users.html

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<HTML>
2+
<HEAD>
3+
<meta charset="UTF-8">
4+
<title>ClientFollowingAPI.followUsers - SpotifyKotlinWrapper</title>
5+
<link rel="stylesheet" href="../../../style.css">
6+
</HEAD>
7+
<BODY>
8+
<a href="../../index.html">SpotifyKotlinWrapper</a>&nbsp;/&nbsp;<a href="../index.html">com.adamratzman.spotify.endpoints.client</a>&nbsp;/&nbsp;<a href="index.html">ClientFollowingAPI</a>&nbsp;/&nbsp;<a href="./follow-users.html">followUsers</a><br/>
9+
<br/>
10+
<h1>followUsers</h1>
11+
<a name="com.adamratzman.spotify.endpoints.client.ClientFollowingAPI$followUsers(kotlin.Array((kotlin.String)))"></a>
12+
<code><span class="keyword">fun </span><span class="identifier">followUsers</span><span class="symbol">(</span><span class="keyword">vararg</span> <span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientFollowingAPI$followUsers(kotlin.Array((kotlin.String)))/users">users</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.adamratzman.spotify.main/-spotify-rest-action/index.html"><span class="identifier">SpotifyRestAction</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a><span class="symbol">&gt;</span></code>
13+
<p>Add the current user as a follower of other users</p>
14+
<h3>Exceptions</h3>
15+
<p><a name="BadRequestException"></a>
16+
<code>BadRequestException</code> - if an invalid id is provided</p>
17+
</BODY>
18+
</HTML>

‎docs/-spotify-kotlin-wrapper/com.adamratzman.spotify.endpoints.client/-client-following-a-p-i/get-followed-artists.html

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<HTML>
2+
<HEAD>
3+
<meta charset="UTF-8">
4+
<title>ClientFollowingAPI.getFollowedArtists - SpotifyKotlinWrapper</title>
5+
<link rel="stylesheet" href="../../../style.css">
6+
</HEAD>
7+
<BODY>
8+
<a href="../../index.html">SpotifyKotlinWrapper</a>&nbsp;/&nbsp;<a href="../index.html">com.adamratzman.spotify.endpoints.client</a>&nbsp;/&nbsp;<a href="index.html">ClientFollowingAPI</a>&nbsp;/&nbsp;<a href="./get-followed-artists.html">getFollowedArtists</a><br/>
9+
<br/>
10+
<h1>getFollowedArtists</h1>
11+
<a name="com.adamratzman.spotify.endpoints.client.ClientFollowingAPI$getFollowedArtists(kotlin.Int, kotlin.String)"></a>
12+
<code><span class="keyword">fun </span><span class="identifier">getFollowedArtists</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientFollowingAPI$getFollowedArtists(kotlin.Int, kotlin.String)/limit">limit</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientFollowingAPI$getFollowedArtists(kotlin.Int, kotlin.String)/after">after</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="../../com.adamratzman.spotify.main/-spotify-rest-action-paging/index.html"><span class="identifier">SpotifyRestActionPaging</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.utils/-artist/index.html"><span class="identifier">Artist</span></a><span class="symbol">,</span>&nbsp;<a href="../../com.adamratzman.spotify.utils/-cursor-based-paging-object/index.html"><span class="identifier">CursorBasedPagingObject</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.utils/-artist/index.html"><span class="identifier">Artist</span></a><span class="symbol">&gt;</span><span class="symbol">&gt;</span></code>
13+
<p>Get the current user’s followed artists.</p>
14+
<p><strong>Return</strong><br/>
15+
<a href="../../com.adamratzman.spotify.utils/-cursor-based-paging-object/index.html">CursorBasedPagingObject</a> (<a href="https://github.com/adamint/spotify-web-api-kotlin/blob/master/README.md#the-benefits-of-linkedresults-pagingobjects-and-cursor-based-paging-objects">Information about them</a>
16+
with full <a href="../../com.adamratzman.spotify.utils/-artist/index.html">Artist</a> objects</p>
17+
</BODY>
18+
</HTML>

0 commit comments

Comments
 (0)