@@ -11,6 +11,9 @@ <h3>All Types</h3>
11
11
< tr >
12
12
(common, js, jvm)
13
13
< 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 >
14
17
</ tr >
15
18
< tr >
16
19
(common, js, jvm)
@@ -113,6 +116,10 @@ <h5><a href="../com.adamratzman.spotify/-authorization-type/index.html">com.adam
113
116
</ tr >
114
117
< tr >
115
118
(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)
116
123
< h5 > < a href ="../com.adamratzman.spotify.endpoints.public/-browse-a-p-i.html "> com.adamratzman.spotify.endpoints.public.BrowseAPI</ a > </ h5 >
117
124
</ tr >
118
125
< tr >
@@ -177,9 +184,18 @@ <h5><a href="../com.adamratzman.spotify.endpoints.client/-client-profile-api/ind
177
184
</ tr >
178
185
< tr >
179
186
(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)
180
192
< h5 > < a href ="../com.adamratzman.spotify.endpoints.client/-client-user-a-p-i.html "> com.adamratzman.spotify.endpoints.client.ClientUserAPI</ a > </ h5 >
181
193
</ tr >
182
194
< 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 >
183
199
(jvm) (extensions in package com.adamratzman.spotify.utils)
184
200
< h5 > < a href ="../com.adamratzman.spotify.utils/java.util.concurrent.-concurrent-hash-map/index.html "> java.util.concurrent.ConcurrentHashMap</ a > </ h5 >
185
201
</ tr >
@@ -246,6 +262,19 @@ <h5><a href="../com.adamratzman.spotify.models/-disallowable-playback-action/ind
246
262
</ tr >
247
263
< tr >
248
264
(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)
249
278
< h5 > < a href ="../com.adamratzman.spotify.models/-error-object/index.html "> com.adamratzman.spotify.models.ErrorObject</ a > </ h5 >
250
279
< p > An endpoint exception from Spotify</ p >
251
280
</ tr >
@@ -288,6 +317,12 @@ <h5><a href="../com.adamratzman.spotify.endpoints.public/-following-api/index.ht
288
317
< p > This endpoint allow you check the playlists that a Spotify user follows.</ p >
289
318
</ tr >
290
319
< 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 >
291
326
(js) (extensions in package com.adamratzman.spotify.utils)
292
327
< h5 > < a href ="../com.adamratzman.spotify.utils/kotlin.collections.-hash-map/index.html "> kotlin.collections.HashMap</ a > </ h5 >
293
328
</ tr >
@@ -324,6 +359,10 @@ <h5><a href="../com.adamratzman.spotify.models/-identifiable-nullable/index.html
324
359
</ tr >
325
360
< tr >
326
361
(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)
327
366
< h5 > < a href ="../com.adamratzman.spotify/-i-spotify-api-builder/index.html "> com.adamratzman.spotify.ISpotifyApiBuilder</ a > </ h5 >
328
367
< p > Spotify Api builder interface</ p >
329
368
</ tr >
@@ -361,6 +400,11 @@ <h5><a href="../com.adamratzman.spotify.utils/-locale/index.html">com.adamratzma
361
400
</ tr >
362
401
< tr >
363
402
(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)
364
408
< h5 > < a href ="../com.adamratzman.spotify.models/-local-track-uri/index.html "> com.adamratzman.spotify.models.LocalTrackUri</ a > </ h5 >
365
409
< p > Represents a Spotify < strong > local track</ strong > URI</ p >
366
410
</ tr >
@@ -380,17 +424,36 @@ <h5><a href="../com.adamratzman.spotify.models/-needs-api/index.html">com.adamra
380
424
</ tr >
381
425
< tr >
382
426
(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)
383
434
< 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
385
436
(whose value is an array of the requested objects) along with other keys like previous, next and
386
437
limit that can be useful in future calls.</ p >
387
438
</ tr >
388
439
< tr >
389
440
(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)
390
445
< h5 > < a href ="../com.adamratzman.spotify.models/-paging-traversal-type/index.html "> com.adamratzman.spotify.models.PagingTraversalType</ a > </ h5 >
391
446
</ tr >
392
447
< tr >
393
448
(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)
394
457
< h5 > < a href ="../com.adamratzman.spotify.models/-playback-action/index.html "> com.adamratzman.spotify.models.PlaybackAction</ a > </ h5 >
395
458
< p > Action a user takes that will affect current playback</ p >
396
459
</ tr >
@@ -484,6 +547,12 @@ <h5><a href="../com.adamratzman.spotify.models/-result-enum/index.html">com.adam
484
547
</ tr >
485
548
< tr >
486
549
(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)
487
556
< h5 > < a href ="../com.adamratzman.spotify.models/-saved-album/index.html "> com.adamratzman.spotify.models.SavedAlbum</ a > </ h5 >
488
557
< p > Represents an album saved in a user's library</ p >
489
558
</ tr >
@@ -499,7 +568,22 @@ <h5><a href="../com.adamratzman.spotify.endpoints.public/-search-a-p-i.html">com
499
568
< tr >
500
569
(common, js, jvm)
501
570
< 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 >
503
587
</ tr >
504
588
< tr >
505
589
(common, js, jvm)
@@ -513,11 +597,31 @@ <h5><a href="../com.adamratzman.spotify.models/-simple-artist/index.html">com.ad
513
597
</ tr >
514
598
< tr >
515
599
(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)
516
615
< h5 > < a href ="../com.adamratzman.spotify.models/-simple-playlist/index.html "> com.adamratzman.spotify.models.SimplePlaylist</ a > </ h5 >
517
616
< 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 >
518
617
</ tr >
519
618
< tr >
520
619
(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)
521
625
< h5 > < a href ="../com.adamratzman.spotify.models/-simple-track/index.html "> com.adamratzman.spotify.models.SimpleTrack</ a > </ h5 >
522
626
< 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 >
523
627
</ tr >
@@ -623,6 +727,12 @@ <h5><a href="../com.adamratzman.spotify.models/-spotify-image/index.html">com.ad
623
727
</ tr >
624
728
< tr >
625
729
(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)
626
736
< h5 > < a href ="../com.adamratzman.spotify/-spotify-logger/index.html "> com.adamratzman.spotify.SpotifyLogger</ a > </ h5 >
627
737
</ tr >
628
738
< tr >
@@ -753,13 +863,11 @@ <h5><a href="../com.adamratzman.spotify.endpoints.public/-tracks-a-p-i.html">com
753
863
</ tr >
754
864
< tr >
755
865
(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 >
759
867
</ tr >
760
868
< tr >
761
869
(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 >
763
871
</ tr >
764
872
< tr >
765
873
(common, js, jvm)
0 commit comments