Skip to content

Commit 4b5075f

Browse files
committed
document some exceptions & response objects
1 parent 1646af0 commit 4b5075f

File tree

357 files changed

+1546
-1035
lines changed

Some content is hidden

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

357 files changed

+1546
-1035
lines changed

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,7 @@ <h5><a href="../com.adamratzman.spotify.models/-external-id/index.html">com.adam
264264
<tr>
265265
(common, js, jvm)
266266
<h5><a href="../com.adamratzman.spotify.models/-external-url/index.html">com.adamratzman.spotify.models.ExternalUrl</a></h5>
267+
<p>Key/value pair mapping a name to an arbitrary url</p>
267268
</tr>
268269
<tr>
269270
(common, js, jvm)
@@ -427,6 +428,7 @@ <h5><a href="../com.adamratzman.spotify.models/-recommendation-seed/index.html">
427428
<tr>
428429
(common, js, jvm)
429430
<h5><a href="../com.adamratzman.spotify.models/-relinking-available-response/index.html">com.adamratzman.spotify.models.RelinkingAvailableResponse</a></h5>
431+
<p>Represents a response for which a relinked track could be available</p>
430432
</tr>
431433
<tr>
432434
(common, js, jvm)
@@ -664,7 +666,7 @@ <h5><a href="../com.adamratzman.spotify.utils/-time-unit/index.html">com.adamrat
664666
<tr>
665667
(common, js, jvm)
666668
<h5><a href="../com.adamratzman.spotify.models/-token/index.html">com.adamratzman.spotify.models.Token</a></h5>
667-
<p>Represents a Spotify Token, retrieved through instantiating a <a href="#">SpotifyAPI</a></p>
669+
<p>Represents a Spotify Token, retrieved through instantiating a <a href="../com.adamratzman.spotify/-spotify-api/index.html#com.adamratzman.spotify.SpotifyApi">SpotifyApi</a></p>
668670
</tr>
669671
<tr>
670672
(common, js, jvm)

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.models/-album-uri/-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.models.AlbumUri$&lt;init&gt;(kotlin.String)"></a>
12-
(common, js, jvm) <code><span class="identifier">&lt;init&gt;</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.models.AlbumUri$<init>(kotlin.String)/_input">_input</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>&nbsp;<span class="symbol">=</span>&nbsp;TRANSIENT_EMPTY_STRING<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.models.AlbumUri$<init>(kotlin.String)/input">input</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></code>
1313
<p>Represents a Spotify <strong>Album</strong> URI, parsed from either a Spotify ID or taken from an endpoint.</p>
1414
</BODY>
1515
</HTML>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.models/-album-uri/index.html

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,19 @@ <h1>AlbumUri</h1>
1111
<a name="com.adamratzman.spotify.models.AlbumUri"></a>
1212
(common, js, jvm) <code><span class="keyword">class </span><span class="identifier">AlbumUri</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../-spotify-uri/index.html"><span class="identifier">SpotifyUri</span></a></code>
1313
<p>Represents a Spotify <strong>Album</strong> URI, parsed from either a Spotify ID or taken from an endpoint.</p>
14+
<h3>Types</h3>
15+
<table>
16+
<tbody>
17+
<tr>
18+
<td>
19+
(common, js, jvm)
20+
<h4><a href="-companion.html">Companion</a></h4>
21+
</td>
22+
<td>
23+
<code><span class="keyword">companion</span> <span class="keyword">object </span><span class="identifier">Companion</span>&nbsp;<span class="symbol">:</span>&nbsp;<span class="identifier">KSerializer</span><span class="symbol">&lt;</span><a href="./index.html"><span class="identifier">AlbumUri</span></a><span class="symbol">&gt;</span></code></td>
24+
</tr>
25+
</tbody>
26+
</table>
1427
<h3>Constructors</h3>
1528
<table>
1629
<tbody>
@@ -21,7 +34,7 @@ <h4><a href="-init-.html">&lt;init&gt;</a></h4>
2134
</td>
2235
<td>
2336
<p>Represents a Spotify <strong>Album</strong> URI, parsed from either a Spotify ID or taken from an endpoint.</p>
24-
<code><span class="identifier">&lt;init&gt;</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.models.AlbumUri$<init>(kotlin.String)/_input">_input</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>&nbsp;<span class="symbol">=</span>&nbsp;TRANSIENT_EMPTY_STRING<span class="symbol">)</span></code></td>
37+
<code><span class="identifier">&lt;init&gt;</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.models.AlbumUri$<init>(kotlin.String)/input">input</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></code></td>
2538
</tr>
2639
</tbody>
2740
</table>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.models/-album/-init-.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<HTML>
2+
<HEAD>
3+
<meta charset="UTF-8">
4+
<title>com.adamratzman.spotify.models.Album.externalUrlsString - spotify-web-api-kotlin</title>
5+
<link rel="stylesheet" href="../../../style.css">
6+
</HEAD>
7+
<BODY>
8+
<a href="../../index.html">spotify-web-api-kotlin</a>&nbsp;/&nbsp;<a href="../index.html">com.adamratzman.spotify.models</a>&nbsp;/&nbsp;<a href="index.html">Album</a>&nbsp;/&nbsp;<a href="./external-urls-string.html">externalUrlsString</a><br/>
9+
<br/>
10+
<h1>externalUrlsString</h1>
11+
<a name="com.adamratzman.spotify.models.Album$externalUrlsString"></a>
12+
(common, js, jvm) <code><span class="keyword">protected</span> <span class="keyword">val </span><span class="identifier">externalUrlsString</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html"><span class="identifier">Map</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><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">&gt;</span></code>
13+
</BODY>
14+
</HTML>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.models/-album/index.html

Lines changed: 9 additions & 1 deletion
Large diffs are not rendered by default.

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.models/-artist-uri/-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.models.ArtistUri$&lt;init&gt;(kotlin.String)"></a>
12-
(common, js, jvm) <code><span class="identifier">&lt;init&gt;</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.models.ArtistUri$<init>(kotlin.String)/_input">_input</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>&nbsp;<span class="symbol">=</span>&nbsp;TRANSIENT_EMPTY_STRING<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.models.ArtistUri$<init>(kotlin.String)/input">input</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></code>
1313
<p>Represents a Spotify <strong>Artist</strong> URI, parsed from either a Spotify ID or taken from an endpoint.</p>
1414
</BODY>
1515
</HTML>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.models/-artist-uri/index.html

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,19 @@ <h1>ArtistUri</h1>
1111
<a name="com.adamratzman.spotify.models.ArtistUri"></a>
1212
(common, js, jvm) <code><span class="keyword">class </span><span class="identifier">ArtistUri</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../-spotify-uri/index.html"><span class="identifier">SpotifyUri</span></a></code>
1313
<p>Represents a Spotify <strong>Artist</strong> URI, parsed from either a Spotify ID or taken from an endpoint.</p>
14+
<h3>Types</h3>
15+
<table>
16+
<tbody>
17+
<tr>
18+
<td>
19+
(common, js, jvm)
20+
<h4><a href="-companion.html">Companion</a></h4>
21+
</td>
22+
<td>
23+
<code><span class="keyword">companion</span> <span class="keyword">object </span><span class="identifier">Companion</span>&nbsp;<span class="symbol">:</span>&nbsp;<span class="identifier">KSerializer</span><span class="symbol">&lt;</span><a href="./index.html"><span class="identifier">ArtistUri</span></a><span class="symbol">&gt;</span></code></td>
24+
</tr>
25+
</tbody>
26+
</table>
1427
<h3>Constructors</h3>
1528
<table>
1629
<tbody>
@@ -21,7 +34,7 @@ <h4><a href="-init-.html">&lt;init&gt;</a></h4>
2134
</td>
2235
<td>
2336
<p>Represents a Spotify <strong>Artist</strong> URI, parsed from either a Spotify ID or taken from an endpoint.</p>
24-
<code><span class="identifier">&lt;init&gt;</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.models.ArtistUri$<init>(kotlin.String)/_input">_input</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>&nbsp;<span class="symbol">=</span>&nbsp;TRANSIENT_EMPTY_STRING<span class="symbol">)</span></code></td>
37+
<code><span class="identifier">&lt;init&gt;</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.models.ArtistUri$<init>(kotlin.String)/input">input</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></code></td>
2538
</tr>
2639
</tbody>
2740
</table>

0 commit comments

Comments
 (0)