update PlayerApi#getRecentlyPlayed

Signed-off-by: Adam Ratzman <[email protected]>

Author: adamint

build.gradle

@@ -22,7 +22,7 @@ apply plugin: 'kotlin'
 apply plugin: 'org.jetbrains.dokka'
 
 group 'com.adamratzman'
-version '2.1.0'
+version '2.1.1'
 
 archivesBaseName = 'spotify-api-kotlin'
 

src/main/kotlin/com/adamratzman/spotify/endpoints/client/ClientPlayerAPI.kt

@@ -55,10 +55,22 @@ class ClientPlayerAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
 
     /**
      * Get tracks from the current user’s recently played tracks.
+     *
+     * @param limit The number of objects to return. Default: 20. Minimum: 1. Maximum: 50.
+     * @param before The timestamp (retrieved via cursor) **not including**, but before which, tracks will have been played. This can be combined with [limit]
+     * @param after The timestamp (retrieved via cursor) **not including**, after which, the retrieval starts. This can be combined with [limit]
+     *
      */
-    fun getRecentlyPlayed(): SpotifyRestActionPaging<PlayHistory, CursorBasedPagingObject<PlayHistory>> {
+    fun getRecentlyPlayed(
+        limit: Int? = null,
+        before: String? = null,
+        after: String? = null
+    ): SpotifyRestActionPaging<PlayHistory, CursorBasedPagingObject<PlayHistory>> {
         return toActionPaging(Supplier {
-            get(EndpointBuilder("/me/player/recently-played").toString()).toCursorBasedPagingObject<PlayHistory>(
+            get(
+                EndpointBuilder("/me/player/recently-played")
+                    .with("limit", limit).with("before", before).with("after", after).toString()
+            ).toCursorBasedPagingObject<PlayHistory>(
                 endpoint = this
             )
         })

src/main/kotlin/com/adamratzman/spotify/utils/Endpoints.kt

@@ -112,8 +112,8 @@ abstract class SpotifyEndpoint(val api: SpotifyAPI) {
         HttpHeader("Authorization", "Bearer ${api.token.accessToken}")
     )
 
-    fun <T> toAction(supplier: Supplier<T>) = SpotifyRestAction(api, supplier)
-    fun <Z, T : AbstractPagingObject<Z>> toActionPaging(supplier: Supplier<T>) = SpotifyRestActionPaging(api, supplier)
+    internal fun <T> toAction(supplier: Supplier<T>) = SpotifyRestAction(api, supplier)
+    internal fun <Z, T : AbstractPagingObject<Z>> toActionPaging(supplier: Supplier<T>) = SpotifyRestActionPaging(api, supplier)
 }
 
 internal class EndpointBuilder(private val path: String) {

src/main/kotlin/com/adamratzman/spotify/utils/Helpers.kt

@@ -10,15 +10,9 @@ import java.net.URLEncoder
 import java.util.Base64
 
 /**
- * The cursor to use as key to find the next page of items.
- *
- * @property after nullable cursor value
- */
-data class Cursor(val after: String?)
-
-/**
- *
+ * The cursor to use as key to find the next (or previous) page of items.
  */
+data class Cursor(val before: String? = null, val after: String? = null)
 
 abstract class RelinkingAvailableResponse(@Json(ignored = true) val linkedTrack: LinkedTrack? = null) : Linkable() {
     fun isRelinked() = linkedTrack != null