Skip to content

Commit d5f9d1f

Browse files
committed
update documentation
1 parent c415ed2 commit d5f9d1f

File tree

205 files changed

+1752
-314
lines changed

Some content is hidden

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

205 files changed

+1752
-314
lines changed

docs/docs/spotify-web-api-kotlin/alltypes/index.html

Lines changed: 52 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ <h5><a href="../com.adamratzman.spotify.models/-authentication-error/index.html"
109109
<tr>
110110
(common, js, jvm)
111111
<h5><a href="../com.adamratzman.spotify/-authorization-type/index.html">com.adamratzman.spotify.AuthorizationType</a></h5>
112+
<p>The type of Spotify authorization used to build an Api instance</p>
112113
</tr>
113114
<tr>
114115
(common, js, jvm)
@@ -158,7 +159,7 @@ <h5><a href="../com.adamratzman.spotify.endpoints.client/-client-player-a-p-i.ht
158159
(common, js, jvm)
159160
<h5><a href="../com.adamratzman.spotify.endpoints.client/-client-player-api/index.html">com.adamratzman.spotify.endpoints.client.ClientPlayerApi</a></h5>
160161
<p>These endpoints allow for viewing and controlling user playback. Please view <a href="https://developer.spotify.com/web-api/working-with-connect/">the official documentation</a>
161-
for more information on how this works. This is in beta and is available for <strong>premium users only</strong>. Endpoints are <strong>not</strong> guaranteed to work</p>
162+
for more information on how this works. This is in beta and is available for <strong>premium users only</strong>. Endpoints are <strong>not</strong> guaranteed to work and are subject to change!</p>
162163
</tr>
163164
<tr>
164165
(common, js, jvm)
@@ -292,10 +293,27 @@ <h5><a href="../com.adamratzman.spotify.utils/kotlin.collections.-hash-map/index
292293
</tr>
293294
<tr>
294295
(common, js, jvm)
296+
<h5><a href="../com.adamratzman.spotify.http/-http-connection/index.html">com.adamratzman.spotify.http.HttpConnection</a></h5>
297+
<p>Provides a fast, easy, and slim way to execute and retrieve HTTP GET, POST, PUT, and DELETE requests</p>
298+
</tr>
299+
<tr>
300+
(common, js, jvm)
301+
<h5><a href="../com.adamratzman.spotify.http/-http-connection-status/index.html">com.adamratzman.spotify.http.HttpConnectionStatus</a></h5>
302+
</tr>
303+
<tr>
304+
(common, js, jvm)
305+
<h5><a href="../com.adamratzman.spotify.http/-http-header/index.html">com.adamratzman.spotify.http.HttpHeader</a></h5>
306+
</tr>
307+
<tr>
308+
(common, js, jvm)
295309
<h5><a href="../com.adamratzman.spotify.http/-http-request-method/index.html">com.adamratzman.spotify.http.HttpRequestMethod</a></h5>
296310
</tr>
297311
<tr>
298312
(common, js, jvm)
313+
<h5><a href="../com.adamratzman.spotify.http/-http-response/index.html">com.adamratzman.spotify.http.HttpResponse</a></h5>
314+
</tr>
315+
<tr>
316+
(common, js, jvm)
299317
<h5><a href="../com.adamratzman.spotify.models/-identifiable/index.html">com.adamratzman.spotify.models.Identifiable</a></h5>
300318
<p>Represents an identifiable Spotify object such as an Album or Recommendation Seed</p>
301319
</tr>
@@ -307,14 +325,23 @@ <h5><a href="../com.adamratzman.spotify.models/-identifiable-nullable/index.html
307325
<tr>
308326
(common, js, jvm)
309327
<h5><a href="../com.adamratzman.spotify/-i-spotify-api-builder/index.html">com.adamratzman.spotify.ISpotifyApiBuilder</a></h5>
328+
<p>Spotify Api builder interface</p>
310329
</tr>
311330
<tr>
312331
(common, js, jvm)
313332
<h5><a href="../com.adamratzman.spotify/-i-spotify-app-api-builder.html">com.adamratzman.spotify.ISpotifyAppApiBuilder</a></h5>
333+
<p>App Api builder interface</p>
314334
</tr>
315335
<tr>
316336
(common, js, jvm)
317337
<h5><a href="../com.adamratzman.spotify/-i-spotify-client-api-builder/index.html">com.adamratzman.spotify.ISpotifyClientApiBuilder</a></h5>
338+
<p>Client interface exposing <a href="../com.adamratzman.spotify/-i-spotify-client-api-builder/get-authorization-url.html#com.adamratzman.spotify.ISpotifyClientApiBuilder$getAuthorizationUrl(kotlin.Array((com.adamratzman.spotify.SpotifyScope)))">getAuthorizationUrl</a></p>
339+
</tr>
340+
<tr>
341+
(common, js, jvm)
342+
<h5><a href="../com.adamratzman.spotify.utils/-language/index.html">com.adamratzman.spotify.utils.Language</a></h5>
343+
<p><a href="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</a>
344+
language code.</p>
318345
</tr>
319346
<tr>
320347
(common, js, jvm)
@@ -329,6 +356,11 @@ <h5><a href="../com.adamratzman.spotify.models/-linked-track/index.html">com.ada
329356
</tr>
330357
<tr>
331358
(common, js, jvm)
359+
<h5><a href="../com.adamratzman.spotify.utils/-locale/index.html">com.adamratzman.spotify.utils.Locale</a></h5>
360+
<p>Locale code.</p>
361+
</tr>
362+
<tr>
363+
(common, js, jvm)
332364
<h5><a href="../com.adamratzman.spotify.models/-local-track-uri/index.html">com.adamratzman.spotify.models.LocalTrackUri</a></h5>
333365
<p>Represents a Spotify <strong>local track</strong> URI</p>
334366
</tr>
@@ -428,6 +460,10 @@ <h5><a href="../com.adamratzman.spotify.models/-recommendation-seed/index.html">
428460
</tr>
429461
<tr>
430462
(common, js, jvm)
463+
<h5><a href="../com.adamratzman.spotify.models/-release-date/index.html">com.adamratzman.spotify.models.ReleaseDate</a></h5>
464+
</tr>
465+
<tr>
466+
(common, js, jvm)
431467
<h5><a href="../com.adamratzman.spotify.models/-relinking-available-response/index.html">com.adamratzman.spotify.models.RelinkingAvailableResponse</a></h5>
432468
<p>Represents a response for which a relinked track could be available</p>
433469
</tr>
@@ -494,7 +530,7 @@ <h5><a href="../com.adamratzman.spotify/-spotify-api/index.html">com.adamratzman
494530
</tr>
495531
<tr>
496532
(common, js, jvm)
497-
<h5><a href="../com.adamratzman.spotify/-spotify-a-p-i.html">com.adamratzman.spotify.SpotifyApi</a></h5>
533+
<h5><a href="../com.adamratzman.spotify/-spotify-a-p-i.html">com.adamratzman.spotify.SpotifyAPI</a></h5>
498534
</tr>
499535
<tr>
500536
(common, js, jvm)
@@ -504,6 +540,7 @@ <h5><a href="../com.adamratzman.spotify/-spotify-api-builder/index.html">com.ada
504540
<tr>
505541
(common, js, jvm)
506542
<h5><a href="../com.adamratzman.spotify/-spotify-api-options/index.html">com.adamratzman.spotify.SpotifyApiOptions</a></h5>
543+
<p>API Utilities</p>
507544
</tr>
508545
<tr>
509546
(common, js, jvm)
@@ -523,6 +560,7 @@ <h5><a href="../com.adamratzman.spotify/-spotify-app-a-p-i.html">com.adamratzman
523560
<tr>
524561
(common, js, jvm)
525562
<h5><a href="../com.adamratzman.spotify/-spotify-app-api-builder/index.html">com.adamratzman.spotify.SpotifyAppApiBuilder</a></h5>
563+
<p><a href="../com.adamratzman.spotify/-spotify-app-api/index.html#com.adamratzman.spotify.SpotifyAppApi">SpotifyAppApi</a> builder for api creation using client authorization</p>
526564
</tr>
527565
<tr>
528566
(common, js, jvm)
@@ -541,11 +579,12 @@ <h5><a href="../com.adamratzman.spotify/-spotify-client-api/index.html">com.adam
541579
</tr>
542580
<tr>
543581
(common, js, jvm)
544-
<h5><a href="../com.adamratzman.spotify/-spotify-client-a-p-i.html">com.adamratzman.spotify.SpotifyClientApi</a></h5>
582+
<h5><a href="../com.adamratzman.spotify/-spotify-client-a-p-i.html">com.adamratzman.spotify.SpotifyClientAPI</a></h5>
545583
</tr>
546584
<tr>
547585
(common, js, jvm)
548586
<h5><a href="../com.adamratzman.spotify/-spotify-client-api-builder/index.html">com.adamratzman.spotify.SpotifyClientApiBuilder</a></h5>
587+
<p><a href="../com.adamratzman.spotify/-spotify-client-api/index.html#com.adamratzman.spotify.SpotifyClientApi">SpotifyClientApi</a> builder for api creation using client authorization</p>
549588
</tr>
550589
<tr>
551590
(common, js, jvm)
@@ -571,6 +610,14 @@ <h5><a href="../com.adamratzman.spotify/-spotify-exception/index.html">com.adamr
571610
</tr>
572611
<tr>
573612
(common, js, jvm)
613+
<h5><a href="../com.adamratzman.spotify.annotations/-spotify-experimental-function-api/index.html">com.adamratzman.spotify.annotations.SpotifyExperimentalFunctionApi</a></h5>
614+
</tr>
615+
<tr>
616+
(common, js, jvm)
617+
<h5><a href="../com.adamratzman.spotify.annotations/-spotify-experimental-http-api/index.html">com.adamratzman.spotify.annotations.SpotifyExperimentalHttpApi</a></h5>
618+
</tr>
619+
<tr>
620+
(common, js, jvm)
574621
<h5><a href="../com.adamratzman.spotify.models/-spotify-image/index.html">com.adamratzman.spotify.models.SpotifyImage</a></h5>
575622
<p>A Spotify image</p>
576623
</tr>
@@ -634,6 +681,7 @@ <h5><a href="../com.adamratzman.spotify.models/-spotify-uri-exception/index.html
634681
<tr>
635682
(common, js, jvm)
636683
<h5><a href="../com.adamratzman.spotify/-spotify-user-authorization/index.html">com.adamratzman.spotify.SpotifyUserAuthorization</a></h5>
684+
<p>User-defined authorization parameters</p>
637685
</tr>
638686
<tr>
639687
(common, js, jvm)
@@ -697,6 +745,7 @@ <h5><a href="../com.adamratzman.spotify.endpoints.public/-track-api/index.html">
697745
<tr>
698746
(common, js, jvm)
699747
<h5><a href="../com.adamratzman.spotify.endpoints.public/-track-attribute/index.html">com.adamratzman.spotify.endpoints.public.TrackAttribute</a></h5>
748+
<p>The track attribute wrapper contains a set value for a specific <a href="../com.adamratzman.spotify.endpoints.public/-tuneable-track-attribute/index.html#com.adamratzman.spotify.endpoints.public.TuneableTrackAttribute">TuneableTrackAttribute</a></p>
700749
</tr>
701750
<tr>
702751
(common, js, jvm)

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.endpoints.client/-client-following-api/-init-.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,6 @@ <h1>&lt;init&gt;</h1>
1111
<a name="com.adamratzman.spotify.endpoints.client.ClientFollowingApi$&lt;init&gt;(com.adamratzman.spotify.SpotifyApi((, com.adamratzman.spotify.ISpotifyApiBuilder((, )))))"></a>
1212
(common, js, jvm) <code><span class="identifier">&lt;init&gt;</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientFollowingApi$<init>(com.adamratzman.spotify.SpotifyApi((, com.adamratzman.spotify.ISpotifyApiBuilder((, )))))/api">api</span><span class="symbol">:</span>&nbsp;<a href="../../com.adamratzman.spotify/-spotify-api/index.html"><span class="identifier">SpotifyApi</span></a><span class="symbol">&lt;</span><span class="identifier">*</span><span class="symbol">,</span>&nbsp;<span class="identifier">*</span><span class="symbol">&gt;</span><span class="symbol">)</span></code>
1313
<p>These endpoints allow you manage the artists, users and playlists that a Spotify user follows.</p>
14+
<p><strong><a href="https://developer.spotify.com/documentation/web-api/reference/follow/">Api Reference</a></strong></p>
1415
</BODY>
1516
</HTML>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.endpoints.client/-client-following-api/follow-artist.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ <h1>followArtist</h1>
1212
(common, js, jvm) <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/-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>
1313
<p>Add the current user as a follower of an artist</p>
1414
<p><strong>Requires</strong> the <a href="../../com.adamratzman.spotify/-spotify-scope/-u-s-e-r_-f-o-l-l-o-w_-m-o-d-i-f-y.html#com.adamratzman.spotify.SpotifyScope.USER_FOLLOW_MODIFY">SpotifyScope.USER_FOLLOW_MODIFY</a> scope</p>
15+
<p><strong><a href="https://developer.spotify.com/documentation/web-api/reference/follow/follow-artists-users/">Api Reference</a></strong></p>
1516
<h3>Exceptions</h3>
1617
<p><a name="BadRequestException"></a>
1718
<code>BadRequestException</code> - if an invalid id is provided</p>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.endpoints.client/-client-following-api/follow-artists.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ <h1>followArtists</h1>
1212
(common, js, jvm) <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/-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>
1313
<p>Add the current user as a follower of other artists</p>
1414
<p><strong>Requires</strong> the <a href="../../com.adamratzman.spotify/-spotify-scope/-u-s-e-r_-f-o-l-l-o-w_-m-o-d-i-f-y.html#com.adamratzman.spotify.SpotifyScope.USER_FOLLOW_MODIFY">SpotifyScope.USER_FOLLOW_MODIFY</a> scope</p>
15+
<p><strong><a href="https://developer.spotify.com/documentation/web-api/reference/follow/follow-artists-users/">Api Reference</a></strong></p>
1516
<h3>Exceptions</h3>
1617
<p><a name="BadRequestException"></a>
1718
<code>BadRequestException</code> - if an invalid id is provided</p>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.endpoints.client/-client-following-api/follow-playlist.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ <h1>followPlaylist</h1>
1616
<p>Note that the scopes you provide determine only whether the current user can themselves follow the playlist
1717
publicly or privately (i.e. show others what they are following), not whether the playlist itself is
1818
public or private.</p>
19+
<p><strong><a href="https://developer.spotify.com/documentation/web-api/reference/follow/follow-playlist/">Api Reference</a></strong></p>
1920
<h3>Parameters</h3>
2021
<p><a name="playlist"></a>
2122
<code>playlist</code> - the spotify id or uri of the playlist. Any playlist can be followed, regardless of its

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.endpoints.client/-client-following-api/follow-user.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ <h1>followUser</h1>
1212
(common, js, jvm) <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/-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>
1313
<p>Add the current user as a follower of another user</p>
1414
<p><strong>Requires</strong> the <a href="../../com.adamratzman.spotify/-spotify-scope/-u-s-e-r_-f-o-l-l-o-w_-m-o-d-i-f-y.html#com.adamratzman.spotify.SpotifyScope.USER_FOLLOW_MODIFY">SpotifyScope.USER_FOLLOW_MODIFY</a> scope</p>
15+
<p><strong><a href="https://developer.spotify.com/documentation/web-api/reference/follow/follow-artists-users/">Api Reference</a></strong></p>
1516
<h3>Exceptions</h3>
1617
<p><a name="BadRequestException"></a>
1718
<code>BadRequestException</code> - if an invalid id is provided</p>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.endpoints.client/-client-following-api/follow-users.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ <h1>followUsers</h1>
1212
(common, js, jvm) <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/-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>
1313
<p>Add the current user as a follower of other users</p>
1414
<p><strong>Requires</strong> the <a href="../../com.adamratzman.spotify/-spotify-scope/-u-s-e-r_-f-o-l-l-o-w_-m-o-d-i-f-y.html#com.adamratzman.spotify.SpotifyScope.USER_FOLLOW_MODIFY">SpotifyScope.USER_FOLLOW_MODIFY</a> scope</p>
15+
<p><strong><a href="https://developer.spotify.com/documentation/web-api/reference/follow/follow-artists-users/">Api Reference</a></strong></p>
1516
<h3>Exceptions</h3>
1617
<p><a name="BadRequestException"></a>
1718
<code>BadRequestException</code> - if an invalid id is provided</p>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.endpoints.client/-client-following-api/get-followed-artists.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ <h1>getFollowedArtists</h1>
1212
(common, js, jvm) <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/-spotify-rest-action-paging/index.html"><span class="identifier">SpotifyRestActionPaging</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.models/-artist/index.html"><span class="identifier">Artist</span></a><span class="symbol">,</span>&nbsp;<a href="../../com.adamratzman.spotify.models/-cursor-based-paging-object/index.html"><span class="identifier">CursorBasedPagingObject</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.models/-artist/index.html"><span class="identifier">Artist</span></a><span class="symbol">&gt;</span><span class="symbol">&gt;</span></code>
1313
<p>Get the current user’s followed artists.</p>
1414
<p><strong>Requires</strong> the <a href="../../com.adamratzman.spotify/-spotify-scope/-u-s-e-r_-f-o-l-l-o-w_-r-e-a-d.html#com.adamratzman.spotify.SpotifyScope.USER_FOLLOW_READ">SpotifyScope.USER_FOLLOW_READ</a> scope</p>
15+
<p><strong><a href="https://developer.spotify.com/documentation/web-api/reference/follow/get-followed/">Api Reference</a></strong></p>
1516
<h3>Parameters</h3>
1617
<p><a name="limit"></a>
1718
<code>limit</code> - The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.</p>

0 commit comments

Comments
 (0)