Skip to content

Commit 99a1c4b

Browse files
authored
Merge pull request #52 from adamint/dev
fix docs
2 parents 5c836fa + 90a42f0 commit 99a1c4b

File tree

20 files changed

+45
-253
lines changed

20 files changed

+45
-253
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ <h3>All Types</h3>
169169
<td>
170170
<a href="../com.adamratzman.spotify.utils/-cursor/index.html">com.adamratzman.spotify.utils.Cursor</a></td>
171171
<td>
172-
<p>The cursor to use as key to find the next page of items.</p>
172+
<p>The cursor to use as key to find the next (or previous) page of items.</p>
173173
</td>
174174
</tr>
175175
<tr>

docs/-spotify-kotlin-wrapper/com.adamratzman.spotify.endpoints.client/-client-library-a-p-i/index.html

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -92,24 +92,5 @@ <h3>Functions</h3>
9292
</tr>
9393
</tbody>
9494
</table>
95-
<h3>Inherited Functions</h3>
96-
<table>
97-
<tbody>
98-
<tr>
99-
<td>
100-
<p><a href="../../com.adamratzman.spotify.utils/-spotify-endpoint/to-action.html">toAction</a></p>
101-
</td>
102-
<td>
103-
<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">T</span><span class="symbol">&gt;</span> <span class="identifier">toAction</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.utils.SpotifyEndpoint$toAction(java.util.function.Supplier((com.adamratzman.spotify.utils.SpotifyEndpoint.toAction.T)))/supplier">supplier</span><span class="symbol">:</span>&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html"><span class="identifier">Supplier</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.utils/-spotify-endpoint/to-action.html#T"><span class="identifier">T</span></a><span class="symbol">&gt;</span><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="../../com.adamratzman.spotify.utils/-spotify-endpoint/to-action.html#T"><span class="identifier">T</span></a><span class="symbol">&gt;</span></code></td>
104-
</tr>
105-
<tr>
106-
<td>
107-
<p><a href="../../com.adamratzman.spotify.utils/-spotify-endpoint/to-action-paging.html">toActionPaging</a></p>
108-
</td>
109-
<td>
110-
<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">Z</span><span class="symbol">, </span><span class="identifier">T</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../../com.adamratzman.spotify.utils/-abstract-paging-object/index.html"><span class="identifier">AbstractPagingObject</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.utils/-spotify-endpoint/to-action-paging.html#Z"><span class="identifier">Z</span></a><span class="symbol">&gt;</span><span class="symbol">&gt;</span> <span class="identifier">toActionPaging</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.utils.SpotifyEndpoint$toActionPaging(java.util.function.Supplier((com.adamratzman.spotify.utils.SpotifyEndpoint.toActionPaging.T)))/supplier">supplier</span><span class="symbol">:</span>&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html"><span class="identifier">Supplier</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.utils/-spotify-endpoint/to-action-paging.html#T"><span class="identifier">T</span></a><span class="symbol">&gt;</span><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/-spotify-endpoint/to-action-paging.html#Z"><span class="identifier">Z</span></a><span class="symbol">,</span>&nbsp;<a href="../../com.adamratzman.spotify.utils/-spotify-endpoint/to-action-paging.html#T"><span class="identifier">T</span></a><span class="symbol">&gt;</span></code></td>
111-
</tr>
112-
</tbody>
113-
</table>
11495
</BODY>
11596
</HTML>

docs/-spotify-kotlin-wrapper/com.adamratzman.spotify.endpoints.client/-client-personalization-a-p-i/index.html

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -87,24 +87,5 @@ <h3>Functions</h3>
8787
</tr>
8888
</tbody>
8989
</table>
90-
<h3>Inherited Functions</h3>
91-
<table>
92-
<tbody>
93-
<tr>
94-
<td>
95-
<p><a href="../../com.adamratzman.spotify.utils/-spotify-endpoint/to-action.html">toAction</a></p>
96-
</td>
97-
<td>
98-
<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">T</span><span class="symbol">&gt;</span> <span class="identifier">toAction</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.utils.SpotifyEndpoint$toAction(java.util.function.Supplier((com.adamratzman.spotify.utils.SpotifyEndpoint.toAction.T)))/supplier">supplier</span><span class="symbol">:</span>&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html"><span class="identifier">Supplier</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.utils/-spotify-endpoint/to-action.html#T"><span class="identifier">T</span></a><span class="symbol">&gt;</span><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="../../com.adamratzman.spotify.utils/-spotify-endpoint/to-action.html#T"><span class="identifier">T</span></a><span class="symbol">&gt;</span></code></td>
99-
</tr>
100-
<tr>
101-
<td>
102-
<p><a href="../../com.adamratzman.spotify.utils/-spotify-endpoint/to-action-paging.html">toActionPaging</a></p>
103-
</td>
104-
<td>
105-
<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">Z</span><span class="symbol">, </span><span class="identifier">T</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../../com.adamratzman.spotify.utils/-abstract-paging-object/index.html"><span class="identifier">AbstractPagingObject</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.utils/-spotify-endpoint/to-action-paging.html#Z"><span class="identifier">Z</span></a><span class="symbol">&gt;</span><span class="symbol">&gt;</span> <span class="identifier">toActionPaging</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.utils.SpotifyEndpoint$toActionPaging(java.util.function.Supplier((com.adamratzman.spotify.utils.SpotifyEndpoint.toActionPaging.T)))/supplier">supplier</span><span class="symbol">:</span>&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html"><span class="identifier">Supplier</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.utils/-spotify-endpoint/to-action-paging.html#T"><span class="identifier">T</span></a><span class="symbol">&gt;</span><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/-spotify-endpoint/to-action-paging.html#Z"><span class="identifier">Z</span></a><span class="symbol">,</span>&nbsp;<a href="../../com.adamratzman.spotify.utils/-spotify-endpoint/to-action-paging.html#T"><span class="identifier">T</span></a><span class="symbol">&gt;</span></code></td>
106-
</tr>
107-
</tbody>
108-
</table>
10990
</BODY>
11091
</HTML>

docs/-spotify-kotlin-wrapper/com.adamratzman.spotify.endpoints.client/-client-player-a-p-i/get-recently-played.html

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,15 @@
88
<a href="../../index.html">SpotifyKotlinWrapper</a>&nbsp;/&nbsp;<a href="../index.html">com.adamratzman.spotify.endpoints.client</a>&nbsp;/&nbsp;<a href="index.html">ClientPlayerAPI</a>&nbsp;/&nbsp;<a href="./get-recently-played.html">getRecentlyPlayed</a><br/>
99
<br/>
1010
<h1>getRecentlyPlayed</h1>
11-
<a name="com.adamratzman.spotify.endpoints.client.ClientPlayerAPI$getRecentlyPlayed()"></a>
12-
<code><span class="keyword">fun </span><span class="identifier">getRecentlyPlayed</span><span class="symbol">(</span><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/-play-history/index.html"><span class="identifier">PlayHistory</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/-play-history/index.html"><span class="identifier">PlayHistory</span></a><span class="symbol">&gt;</span><span class="symbol">&gt;</span></code>
11+
<a name="com.adamratzman.spotify.endpoints.client.ClientPlayerAPI$getRecentlyPlayed(kotlin.Int, kotlin.String, kotlin.String)"></a>
12+
<code><span class="keyword">fun </span><span class="identifier">getRecentlyPlayed</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientPlayerAPI$getRecentlyPlayed(kotlin.Int, kotlin.String, 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.ClientPlayerAPI$getRecentlyPlayed(kotlin.Int, kotlin.String, kotlin.String)/before">before</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="identifier" id="com.adamratzman.spotify.endpoints.client.ClientPlayerAPI$getRecentlyPlayed(kotlin.Int, kotlin.String, 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/-play-history/index.html"><span class="identifier">PlayHistory</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/-play-history/index.html"><span class="identifier">PlayHistory</span></a><span class="symbol">&gt;</span><span class="symbol">&gt;</span></code>
1313
<p>Get tracks from the current user’s recently played tracks.</p>
14+
<h3>Parameters</h3>
15+
<p><a name="limit"></a>
16+
<code>limit</code> - The number of objects to return. Default: 20. Minimum: 1. Maximum: 50.</p>
17+
<p><a name="before"></a>
18+
<code>before</code> - The timestamp (retrieved via cursor) <strong>not including</strong>, but before which, tracks will have been played. This can be combined with <a href="get-recently-played.html#com.adamratzman.spotify.endpoints.client.ClientPlayerAPI$getRecentlyPlayed(kotlin.Int, kotlin.String, kotlin.String)/limit">limit</a></p>
19+
<p><a name="after"></a>
20+
<code>after</code> - The timestamp (retrieved via cursor) <strong>not including</strong>, after which, the retrieval starts. This can be combined with <a href="get-recently-played.html#com.adamratzman.spotify.endpoints.client.ClientPlayerAPI$getRecentlyPlayed(kotlin.Int, kotlin.String, kotlin.String)/limit">limit</a></p>
1421
</BODY>
1522
</HTML>

docs/-spotify-kotlin-wrapper/com.adamratzman.spotify.endpoints.client/-client-player-a-p-i/index.html

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ <h3>Functions</h3>
8787
<p><a href="get-recently-played.html">getRecentlyPlayed</a></p>
8888
</td>
8989
<td>
90-
<code><span class="keyword">fun </span><span class="identifier">getRecentlyPlayed</span><span class="symbol">(</span><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/-play-history/index.html"><span class="identifier">PlayHistory</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/-play-history/index.html"><span class="identifier">PlayHistory</span></a><span class="symbol">&gt;</span><span class="symbol">&gt;</span></code>
90+
<code><span class="keyword">fun </span><span class="identifier">getRecentlyPlayed</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientPlayerAPI$getRecentlyPlayed(kotlin.Int, kotlin.String, 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.ClientPlayerAPI$getRecentlyPlayed(kotlin.Int, kotlin.String, kotlin.String)/before">before</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="identifier" id="com.adamratzman.spotify.endpoints.client.ClientPlayerAPI$getRecentlyPlayed(kotlin.Int, kotlin.String, 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/-play-history/index.html"><span class="identifier">PlayHistory</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/-play-history/index.html"><span class="identifier">PlayHistory</span></a><span class="symbol">&gt;</span><span class="symbol">&gt;</span></code>
9191
<p>Get tracks from the current user’s recently played tracks.</p>
9292
</td>
9393
</tr>
@@ -185,24 +185,5 @@ <h3>Functions</h3>
185185
</tr>
186186
</tbody>
187187
</table>
188-
<h3>Inherited Functions</h3>
189-
<table>
190-
<tbody>
191-
<tr>
192-
<td>
193-
<p><a href="../../com.adamratzman.spotify.utils/-spotify-endpoint/to-action.html">toAction</a></p>
194-
</td>
195-
<td>
196-
<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">T</span><span class="symbol">&gt;</span> <span class="identifier">toAction</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.utils.SpotifyEndpoint$toAction(java.util.function.Supplier((com.adamratzman.spotify.utils.SpotifyEndpoint.toAction.T)))/supplier">supplier</span><span class="symbol">:</span>&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html"><span class="identifier">Supplier</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.utils/-spotify-endpoint/to-action.html#T"><span class="identifier">T</span></a><span class="symbol">&gt;</span><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="../../com.adamratzman.spotify.utils/-spotify-endpoint/to-action.html#T"><span class="identifier">T</span></a><span class="symbol">&gt;</span></code></td>
197-
</tr>
198-
<tr>
199-
<td>
200-
<p><a href="../../com.adamratzman.spotify.utils/-spotify-endpoint/to-action-paging.html">toActionPaging</a></p>
201-
</td>
202-
<td>
203-
<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">Z</span><span class="symbol">, </span><span class="identifier">T</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../../com.adamratzman.spotify.utils/-abstract-paging-object/index.html"><span class="identifier">AbstractPagingObject</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.utils/-spotify-endpoint/to-action-paging.html#Z"><span class="identifier">Z</span></a><span class="symbol">&gt;</span><span class="symbol">&gt;</span> <span class="identifier">toActionPaging</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.utils.SpotifyEndpoint$toActionPaging(java.util.function.Supplier((com.adamratzman.spotify.utils.SpotifyEndpoint.toActionPaging.T)))/supplier">supplier</span><span class="symbol">:</span>&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html"><span class="identifier">Supplier</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.utils/-spotify-endpoint/to-action-paging.html#T"><span class="identifier">T</span></a><span class="symbol">&gt;</span><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/-spotify-endpoint/to-action-paging.html#Z"><span class="identifier">Z</span></a><span class="symbol">,</span>&nbsp;<a href="../../com.adamratzman.spotify.utils/-spotify-endpoint/to-action-paging.html#T"><span class="identifier">T</span></a><span class="symbol">&gt;</span></code></td>
204-
</tr>
205-
</tbody>
206-
</table>
207188
</BODY>
208189
</HTML>

0 commit comments

Comments
 (0)