spotify-api-kotlin/com.adamratzman.spotify.models/CursorBasedPagingObject

CursorBasedPagingObject

@Serializable

data class CursorBasedPagingObject<T : Any>(val href: String, val items: List<T>, val limit: Int, val next: String? = null, val cursor: Cursor? = null, val total: Int = 0, val offset: Int = 0, val previous: String? = null) : PagingObjectBase<T, CursorBasedPagingObject<T>> (source)

The cursor-based paging object is a container for a set of objects. It contains a key called items (whose value is an array of the requested objects) along with other keys like next and cursors that can be useful in future calls.

Parameters

href

A link to the Web API endpoint returning the full result of the request.

items

The requested data.

limit

The maximum number of items in the response (as set in the query or by default).

URL to the next page of items. ( null if none)

total

The maximum number of items available to return.

cursor

The cursors used to find the next set of items. If items is empty, cursor may be null.

Constructors

CursorBasedPagingObject

constructor(href: String, items: List<T>, limit: Int, next: String? = null, cursor: Cursor? = null, total: Int = 0, offset: Int = 0, previous: String? = null)

Properties

api

@Transient

lateinit var api: GenericSpotifyApi

The API client associated with the request

cursor

@SerialName(value = "cursors")

val cursor: Cursor? = null

href

open override val href: String

items

open override val items: List<T>

limit

open override val limit: Int

open override val next: String? = null

offset

open override val offset: Int = 0

The offset of the items returned (as set in the query or by default).

open override val previous: String? = null

URL to the previous page of items. ( null if none)

size

open override val size: Int

total

open override val total: Int = 0

Functions

contains

open operator override fun contains(element: T?): Boolean

containsAll

open override fun containsAll(elements: Collection<T?>): Boolean

flow

@FlowPreview

@ExperimentalCoroutinesApi

fun flow(context: CoroutineContext = Dispatchers.Default): Flow<T?>

Flow the Paging action.

flowBackward

fun flowBackward(): Flow<CursorBasedPagingObject<T>>

Flow from current page backwards.

flowEndOrdered

@ExperimentalCoroutinesApi

fun flowEndOrdered(): Flow<CursorBasedPagingObject<T>>

flowForward

@ExperimentalCoroutinesApi

fun flowForward(): Flow<CursorBasedPagingObject<T>>

Flow from current page forwards.

flowOrdered

@FlowPreview

@ExperimentalCoroutinesApi

fun flowOrdered(context: CoroutineContext = Dispatchers.Default): Flow<T?>

Flow the paging action ordered. This can be less performant than flow if you are in the middle of the pages.

flowPagingObjects

@ExperimentalCoroutinesApi

fun flowPagingObjects(context: CoroutineContext = Dispatchers.Default): Flow<CursorBasedPagingObject<T>>

Flow the paging objects.

flowPagingObjectsOrdered

@ExperimentalCoroutinesApi

fun flowPagingObjectsOrdered(context: CoroutineContext = Dispatchers.Default): Flow<CursorBasedPagingObject<T>>

Flow the paging objects ordered. This can be less performant than flowPagingObjects if you are in the middle of the pages.

flowStartOrdered

@ExperimentalCoroutinesApi

fun flowStartOrdered(): Flow<CursorBasedPagingObject<T>>

get

open operator override fun get(index: Int): T

getAllItems

open suspend override fun getAllItems(): List<T?>

Get all items of type T associated with the request

getAllItemsNotNull

suspend fun getAllItemsNotNull(): List<T>

Get all items of type T associated with the request. Filters out null objects.

getAllItemsNotNullRestAction

fun getAllItemsNotNullRestAction(): SpotifyRestAction<List<T>>

Get all items of type T associated with the request. Filters out null objects.

getAllItemsRestAction

fun getAllItemsRestAction(): SpotifyRestAction<List<T?>>

Retrieve all T associated with this rest action

getAllPagingObjects

open suspend override fun getAllPagingObjects(): List<CursorBasedPagingObject<T>>

Retrieve all PagingObjectBase associated with this rest action

getAllPagingObjectsRestAction

fun getAllPagingObjectsRestAction(): SpotifyRestAction<List<CursorBasedPagingObject<T>>>

Retrieve all PagingObjectBase associated with this rest action

getCursorBasedPagingObject

suspend fun getCursorBasedPagingObject(url: String): CursorBasedPagingObject<T>?

getNext

suspend fun getNext(): CursorBasedPagingObject<T>?

getNextRestAction

fun getNextRestAction(): SpotifyRestAction<CursorBasedPagingObject<T>?>

getPrevious

suspend fun getPrevious(): CursorBasedPagingObject<T>?

getPreviousRestAction

fun getPreviousRestAction(): SpotifyRestAction<CursorBasedPagingObject<T>?>

getWithNext

suspend fun getWithNext(total: Int): List<CursorBasedPagingObject<T>>

Synchronously retrieve the next total paging objects associated with this CursorBasedPagingObject, including this CursorBasedPagingObject.

getWithNextItems

suspend fun getWithNextItems(total: Int): List<T?>

Retrieve the items associated with the next total paging objects associated with this rest action, including the current one.

getWithNextItemsRestAction

fun getWithNextItemsRestAction(total: Int): SpotifyRestAction<List<T?>>

Retrieve the items associated with the next total paging objects associated with this rest action, including the current one.

getWithNextTotalPagingObjects

open suspend override fun getWithNextTotalPagingObjects(total: Int): List<CursorBasedPagingObject<T>>

Synchronously retrieve the next total paging objects associated with this PagingObjectBase, including this PagingObjectBase.

getWithNextTotalPagingObjectsRestAction

fun getWithNextTotalPagingObjectsRestAction(total: Int): SpotifyRestAction<List<CursorBasedPagingObject<T>>>

Synchronously retrieve the next total paging objects associated with this PagingObjectBase, including this PagingObjectBase.

indexOf

open override fun indexOf(element: T?): Int

isEmpty

open override fun isEmpty(): Boolean

iterator

open operator override fun iterator(): Iterator<T>

lastIndexOf

open override fun lastIndexOf(element: T?): Int

listIterator

open override fun listIterator(): ListIterator<T>

open override fun listIterator(index: Int): ListIterator<T>

subList

open override fun subList(fromIndex: Int, toIndex: Int): List<T>

take

open suspend override fun take(n: Int): List<T>

Returns a list containing at most first n elements. Note that additional requests may be performed. The limit used in the request used to produce this PagingObjectBase will be respected, so choose limit carefully.