Skip to content

Commit f4c9f88

Browse files
authored
Merge pull request #202 from adamint/dev
local track serialization, bulk track requesting
2 parents 42b83ed + 25404a6 commit f4c9f88

File tree

363 files changed

+7633
-675
lines changed

Some content is hidden

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

363 files changed

+7633
-675
lines changed

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

Lines changed: 114 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ <h3>All Types</h3>
1111
<tr>
1212
(common, js, jvm)
1313
<h5><a href="../com.adamratzman.spotify.models/-abstract-paging-object/index.html">com.adamratzman.spotify.models.AbstractPagingObject</a></h5>
14+
<p>The offset-based paging object is a container for a set of objects. It contains a key called items
15+
(whose value is an array of the requested objects) along with other keys like previous, next and
16+
limit that can be useful in future calls.</p>
1417
</tr>
1518
<tr>
1619
(common, js, jvm)
@@ -113,6 +116,10 @@ <h5><a href="../com.adamratzman.spotify/-authorization-type/index.html">com.adam
113116
</tr>
114117
<tr>
115118
(common, js, jvm)
119+
<h5><a href="../com.adamratzman.spotify.models/-basic-show-information/index.html">com.adamratzman.spotify.models.BasicShowInformation</a></h5>
120+
</tr>
121+
<tr>
122+
(common, js, jvm)
116123
<h5><a href="../com.adamratzman.spotify.endpoints.public/-browse-a-p-i.html">com.adamratzman.spotify.endpoints.public.BrowseAPI</a></h5>
117124
</tr>
118125
<tr>
@@ -177,9 +184,18 @@ <h5><a href="../com.adamratzman.spotify.endpoints.client/-client-profile-api/ind
177184
</tr>
178185
<tr>
179186
(common, js, jvm)
187+
<h5><a href="../com.adamratzman.spotify.endpoints.client/-client-search-api/index.html">com.adamratzman.spotify.endpoints.client.ClientSearchApi</a></h5>
188+
<p>Get Spotify catalog information about artists, albums, tracks, playlists, episodes, or shows that match a keyword string.</p>
189+
</tr>
190+
<tr>
191+
(common, js, jvm)
180192
<h5><a href="../com.adamratzman.spotify.endpoints.client/-client-user-a-p-i.html">com.adamratzman.spotify.endpoints.client.ClientUserAPI</a></h5>
181193
</tr>
182194
<tr>
195+
(common, js, jvm)
196+
<h5><a href="../com.adamratzman.spotify.models/-collection-uri/index.html">com.adamratzman.spotify.models.CollectionUri</a></h5>
197+
</tr>
198+
<tr>
183199
(jvm) (extensions in package com.adamratzman.spotify.utils)
184200
<h5><a href="../com.adamratzman.spotify.utils/java.util.concurrent.-concurrent-hash-map/index.html">java.util.concurrent.ConcurrentHashMap</a></h5>
185201
</tr>
@@ -246,6 +262,19 @@ <h5><a href="../com.adamratzman.spotify.models/-disallowable-playback-action/ind
246262
</tr>
247263
<tr>
248264
(common, js, jvm)
265+
<h5><a href="../com.adamratzman.spotify.models/-episode/index.html">com.adamratzman.spotify.models.Episode</a></h5>
266+
<p>An episode (podcast) on Spotify</p>
267+
</tr>
268+
<tr>
269+
(common, js, jvm)
270+
<h5><a href="../com.adamratzman.spotify.endpoints.public/-episode-api/index.html">com.adamratzman.spotify.endpoints.public.EpisodeApi</a></h5>
271+
</tr>
272+
<tr>
273+
(common, js, jvm)
274+
<h5><a href="../com.adamratzman.spotify.models/-episode-uri/index.html">com.adamratzman.spotify.models.EpisodeUri</a></h5>
275+
</tr>
276+
<tr>
277+
(common, js, jvm)
249278
<h5><a href="../com.adamratzman.spotify.models/-error-object/index.html">com.adamratzman.spotify.models.ErrorObject</a></h5>
250279
<p>An endpoint exception from Spotify</p>
251280
</tr>
@@ -288,6 +317,12 @@ <h5><a href="../com.adamratzman.spotify.endpoints.public/-following-api/index.ht
288317
<p>This endpoint allow you check the playlists that a Spotify user follows.</p>
289318
</tr>
290319
<tr>
320+
(common, js, jvm)
321+
<h5><a href="../com.adamratzman.spotify/-generic-spotify-api.html">com.adamratzman.spotify.GenericSpotifyApi</a></h5>
322+
<p>Represents a generic instance of the Spotify API client, with common functionality and information between
323+
implementations of the API</p>
324+
</tr>
325+
<tr>
291326
(js) (extensions in package com.adamratzman.spotify.utils)
292327
<h5><a href="../com.adamratzman.spotify.utils/kotlin.collections.-hash-map/index.html">kotlin.collections.HashMap</a></h5>
293328
</tr>
@@ -324,6 +359,10 @@ <h5><a href="../com.adamratzman.spotify.models/-identifiable-nullable/index.html
324359
</tr>
325360
<tr>
326361
(common, js, jvm)
362+
<h5><a href="../com.adamratzman.spotify.models/-immutable-collection-uri/index.html">com.adamratzman.spotify.models.ImmutableCollectionUri</a></h5>
363+
</tr>
364+
<tr>
365+
(common, js, jvm)
327366
<h5><a href="../com.adamratzman.spotify/-i-spotify-api-builder/index.html">com.adamratzman.spotify.ISpotifyApiBuilder</a></h5>
328367
<p>Spotify Api builder interface</p>
329368
</tr>
@@ -361,6 +400,11 @@ <h5><a href="../com.adamratzman.spotify.utils/-locale/index.html">com.adamratzma
361400
</tr>
362401
<tr>
363402
(common, js, jvm)
403+
<h5><a href="../com.adamratzman.spotify.models/-local-track/index.html">com.adamratzman.spotify.models.LocalTrack</a></h5>
404+
<p>Local track object that representing a song uploaded from a client locally</p>
405+
</tr>
406+
<tr>
407+
(common, js, jvm)
364408
<h5><a href="../com.adamratzman.spotify.models/-local-track-uri/index.html">com.adamratzman.spotify.models.LocalTrackUri</a></h5>
365409
<p>Represents a Spotify <strong>local track</strong> URI</p>
366410
</tr>
@@ -380,17 +424,36 @@ <h5><a href="../com.adamratzman.spotify.models/-needs-api/index.html">com.adamra
380424
</tr>
381425
<tr>
382426
(common, js, jvm)
427+
<h5><a href="../com.adamratzman.spotify.models/-nullable-paging-object/index.html">com.adamratzman.spotify.models.NullablePagingObject</a></h5>
428+
<p>The offset-based nullable paging object is a container for a set of objects. It contains a key called items
429+
(whose value is an array of the requested objects) along with other keys like previous, next and
430+
limit that can be useful in future calls. Its items are not guaranteed to be not null</p>
431+
</tr>
432+
<tr>
433+
(common, js, jvm)
383434
<h5><a href="../com.adamratzman.spotify.models/-paging-object/index.html">com.adamratzman.spotify.models.PagingObject</a></h5>
384-
<p>The offset-based paging object is a container for a set of objects. It contains a key called items
435+
<p>The offset-based non-nullable paging object is a container for a set of objects. It contains a key called items
385436
(whose value is an array of the requested objects) along with other keys like previous, next and
386437
limit that can be useful in future calls.</p>
387438
</tr>
388439
<tr>
389440
(common, js, jvm)
441+
<h5><a href="../com.adamratzman.spotify.models/-paging-object-base/index.html">com.adamratzman.spotify.models.PagingObjectBase</a></h5>
442+
</tr>
443+
<tr>
444+
(common, js, jvm)
390445
<h5><a href="../com.adamratzman.spotify.models/-paging-traversal-type/index.html">com.adamratzman.spotify.models.PagingTraversalType</a></h5>
391446
</tr>
392447
<tr>
393448
(common, js, jvm)
449+
<h5><a href="../com.adamratzman.spotify.models/-playable/index.html">com.adamratzman.spotify.models.Playable</a></h5>
450+
</tr>
451+
<tr>
452+
(common, js, jvm)
453+
<h5><a href="../com.adamratzman.spotify.models/-playable-uri/index.html">com.adamratzman.spotify.models.PlayableUri</a></h5>
454+
</tr>
455+
<tr>
456+
(common, js, jvm)
394457
<h5><a href="../com.adamratzman.spotify.models/-playback-action/index.html">com.adamratzman.spotify.models.PlaybackAction</a></h5>
395458
<p>Action a user takes that will affect current playback</p>
396459
</tr>
@@ -484,6 +547,12 @@ <h5><a href="../com.adamratzman.spotify.models/-result-enum/index.html">com.adam
484547
</tr>
485548
<tr>
486549
(common, js, jvm)
550+
<h5><a href="../com.adamratzman.spotify.models/-resume-point/index.html">com.adamratzman.spotify.models.ResumePoint</a></h5>
551+
<p>Represents the user’s most recent position in the episode. Set if the supplied access token is a user token and has
552+
the scope <a href="../com.adamratzman.spotify/-spotify-scope/-u-s-e-r_-r-e-a-d_-p-l-a-y-b-a-c-k_-p-o-s-i-t-i-o-n.html#com.adamratzman.spotify.SpotifyScope.USER_READ_PLAYBACK_POSITION">SpotifyScope.USER_READ_PLAYBACK_POSITION</a>.</p>
553+
</tr>
554+
<tr>
555+
(common, js, jvm)
487556
<h5><a href="../com.adamratzman.spotify.models/-saved-album/index.html">com.adamratzman.spotify.models.SavedAlbum</a></h5>
488557
<p>Represents an album saved in a user's library</p>
489558
</tr>
@@ -499,7 +568,22 @@ <h5><a href="../com.adamratzman.spotify.endpoints.public/-search-a-p-i.html">com
499568
<tr>
500569
(common, js, jvm)
501570
<h5><a href="../com.adamratzman.spotify.endpoints.public/-search-api/index.html">com.adamratzman.spotify.endpoints.public.SearchApi</a></h5>
502-
<p>Get Spotify catalog information about artists, albums, tracks or playlists that match a keyword string.</p>
571+
<p>Get Spotify catalog information about artists, albums, tracks or playlists that match a keyword string.
572+
It is possible to have 0 results and no exception thrown with these methods. Check the size of items returned.</p>
573+
</tr>
574+
<tr>
575+
(common, js, jvm)
576+
<h5><a href="../com.adamratzman.spotify.models/-show/index.html">com.adamratzman.spotify.models.Show</a></h5>
577+
<p>Information about a Spotify show, including its episodes</p>
578+
</tr>
579+
<tr>
580+
(common, js, jvm)
581+
<h5><a href="../com.adamratzman.spotify.endpoints.public/-show-api/index.html">com.adamratzman.spotify.endpoints.public.ShowApi</a></h5>
582+
<p>Endpoints for retrieving information about one or more shows and their episodes from the Spotify catalog.</p>
583+
</tr>
584+
<tr>
585+
(common, js, jvm)
586+
<h5><a href="../com.adamratzman.spotify.models/-show-uri/index.html">com.adamratzman.spotify.models.ShowUri</a></h5>
503587
</tr>
504588
<tr>
505589
(common, js, jvm)
@@ -513,11 +597,31 @@ <h5><a href="../com.adamratzman.spotify.models/-simple-artist/index.html">com.ad
513597
</tr>
514598
<tr>
515599
(common, js, jvm)
600+
<h5><a href="../com.adamratzman.spotify.models/-simple-episode/index.html">com.adamratzman.spotify.models.SimpleEpisode</a></h5>
601+
<p>A simplified episode (podcast) on Spotify</p>
602+
</tr>
603+
<tr>
604+
(common, js, jvm)
605+
<h5><a href="../com.adamratzman.spotify.models/-simple-local-album/index.html">com.adamratzman.spotify.models.SimpleLocalAlbum</a></h5>
606+
<p>Local album object that goes with <a href="../com.adamratzman.spotify.models/-local-track/index.html#com.adamratzman.spotify.models.LocalTrack">LocalTrack</a> - represents the local album it was obtained from (likely "Local Files")</p>
607+
</tr>
608+
<tr>
609+
(common, js, jvm)
610+
<h5><a href="../com.adamratzman.spotify.models/-simple-local-artist/index.html">com.adamratzman.spotify.models.SimpleLocalArtist</a></h5>
611+
<p>Local artist object (goes with <a href="../com.adamratzman.spotify.models/-local-track/index.html#com.adamratzman.spotify.models.LocalTrack">LocalTrack</a>) representing an artist on a local track</p>
612+
</tr>
613+
<tr>
614+
(common, js, jvm)
516615
<h5><a href="../com.adamratzman.spotify.models/-simple-playlist/index.html">com.adamratzman.spotify.models.SimplePlaylist</a></h5>
517616
<p>Simplified Playlist object that can be used to retrieve a full <a href="../com.adamratzman.spotify.models/-playlist/index.html#com.adamratzman.spotify.models.Playlist">Playlist</a></p>
518617
</tr>
519618
<tr>
520619
(common, js, jvm)
620+
<h5><a href="../com.adamratzman.spotify.models/-simple-show/index.html">com.adamratzman.spotify.models.SimpleShow</a></h5>
621+
<p>Basic information about a Spotify show</p>
622+
</tr>
623+
<tr>
624+
(common, js, jvm)
521625
<h5><a href="../com.adamratzman.spotify.models/-simple-track/index.html">com.adamratzman.spotify.models.SimpleTrack</a></h5>
522626
<p>Simplified Playlist object that can be used to retrieve a full <a href="../com.adamratzman.spotify.models/-playlist/index.html#com.adamratzman.spotify.models.Playlist">Playlist</a></p>
523627
</tr>
@@ -623,6 +727,12 @@ <h5><a href="../com.adamratzman.spotify.models/-spotify-image/index.html">com.ad
623727
</tr>
624728
<tr>
625729
(common, js, jvm)
730+
<h5><a href="../com.adamratzman.spotify/-spotify-implicit-grant-api/index.html">com.adamratzman.spotify.SpotifyImplicitGrantApi</a></h5>
731+
<p>An API instance created through implicit grant flow, with access to private information
732+
managed through the scopes exposed in <a href="#">token</a>. <a href="#">token</a> is not refreshable and is only accessible for limited time.</p>
733+
</tr>
734+
<tr>
735+
(common, js, jvm)
626736
<h5><a href="../com.adamratzman.spotify/-spotify-logger/index.html">com.adamratzman.spotify.SpotifyLogger</a></h5>
627737
</tr>
628738
<tr>
@@ -753,13 +863,11 @@ <h5><a href="../com.adamratzman.spotify.endpoints.public/-tracks-a-p-i.html">com
753863
</tr>
754864
<tr>
755865
(common, js, jvm)
756-
<h5><a href="../com.adamratzman.spotify.models/-track-uri/index.html">com.adamratzman.spotify.models.TrackUri</a></h5>
757-
<p>Represents a Spotify <strong>Track</strong> URI, ether LocalTrack or SpotifyTrack, parsed from either a Spotify ID or taken
758-
from an endpoint</p>
866+
<h5><a href="../com.adamratzman.spotify.models/-track-u-r-i.html">com.adamratzman.spotify.models.TrackURI</a></h5>
759867
</tr>
760868
<tr>
761869
(common, js, jvm)
762-
<h5><a href="../com.adamratzman.spotify.models/-track-u-r-i.html">com.adamratzman.spotify.models.TrackURI</a></h5>
870+
<h5><a href="../com.adamratzman.spotify.models/-track-uri.html">com.adamratzman.spotify.models.TrackUri</a></h5>
763871
</tr>
764872
<tr>
765873
(common, js, jvm)

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.annotations/-spotify-experimental-http-api/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<br/>
1010
<h1>SpotifyExperimentalHttpApi</h1>
1111
<a name="com.adamratzman.spotify.annotations.SpotifyExperimentalHttpApi"></a>
12-
(common, js, jvm) <code><span class="identifier">@Target</span><span class="symbol">(</span>[AnnotationTarget.CLASS, AnnotationTarget.FUNCTION]<span class="symbol">)</span> <span class="keyword">annotation</span> <span class="keyword">class </span><span class="identifier">SpotifyExperimentalHttpApi</span></code>
12+
(common, js, jvm) <code><span class="identifier">@Target</span><span class="symbol">(</span>[AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY]<span class="symbol">)</span> <span class="keyword">annotation</span> <span class="keyword">class </span><span class="identifier">SpotifyExperimentalHttpApi</span></code>
1313
<h3>Constructors</h3>
1414
<table>
1515
<tbody>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<br/>
1010
<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>
12-
(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>
12+
(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/-generic-spotify-api.html"><span class="identifier">GenericSpotifyApi</span></a><span class="symbol">)</span></code>
1313
<p>These endpoints allow you manage the artists, users and playlists that a Spotify user follows.</p>
1414
<p><strong><a href="https://developer.spotify.com/documentation/web-api/reference/follow/">Api Reference</a></strong></p>
1515
</BODY>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ <h4><a href="-init-.html">&lt;init&gt;</a></h4>
2222
</td>
2323
<td>
2424
<p>These endpoints allow you manage the artists, users and playlists that a Spotify user follows.</p>
25-
<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></td>
25+
<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/-generic-spotify-api.html"><span class="identifier">GenericSpotifyApi</span></a><span class="symbol">)</span></code></td>
2626
</tr>
2727
</tbody>
2828
</table>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<br/>
1010
<h1>&lt;init&gt;</h1>
1111
<a name="com.adamratzman.spotify.endpoints.client.ClientLibraryApi$&lt;init&gt;(com.adamratzman.spotify.SpotifyApi((, com.adamratzman.spotify.ISpotifyApiBuilder((, )))))"></a>
12-
(common, js, jvm) <code><span class="identifier">&lt;init&gt;</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientLibraryApi$<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>
12+
(common, js, jvm) <code><span class="identifier">&lt;init&gt;</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientLibraryApi$<init>(com.adamratzman.spotify.SpotifyApi((, com.adamratzman.spotify.ISpotifyApiBuilder((, )))))/api">api</span><span class="symbol">:</span>&nbsp;<a href="../../com.adamratzman.spotify/-generic-spotify-api.html"><span class="identifier">GenericSpotifyApi</span></a><span class="symbol">)</span></code>
1313
<p>Endpoints for retrieving information about, and managing, tracks that the current user has saved in their “Your Music” library.</p>
1414
<p><strong><a href="https://developer.spotify.com/documentation/web-api/reference/library/">Api Reference</a></strong></p>
1515
</BODY>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.endpoints.client/-client-library-api/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ <h4><a href="-init-.html">&lt;init&gt;</a></h4>
2222
</td>
2323
<td>
2424
<p>Endpoints for retrieving information about, and managing, tracks that the current user has saved in their “Your Music” library.</p>
25-
<code><span class="identifier">&lt;init&gt;</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientLibraryApi$<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></td>
25+
<code><span class="identifier">&lt;init&gt;</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientLibraryApi$<init>(com.adamratzman.spotify.SpotifyApi((, com.adamratzman.spotify.ISpotifyApiBuilder((, )))))/api">api</span><span class="symbol">:</span>&nbsp;<a href="../../com.adamratzman.spotify/-generic-spotify-api.html"><span class="identifier">GenericSpotifyApi</span></a><span class="symbol">)</span></code></td>
2626
</tr>
2727
</tbody>
2828
</table>

0 commit comments

Comments
 (0)