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

PagingObjectBase

@Serializable

abstract class PagingObjectBase<T : Any, Z : PagingObjectBase<T, Z>> : NeedsApi, List<T?> (source)

Inheritors

AbstractPagingObject

CursorBasedPagingObject

Constructors

PagingObjectBase

constructor()

Properties

@Transient

lateinit var api: GenericSpotifyApi

The API client associated with the request

abstract val href: String

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

abstract val items: List<T?>

The requested data.

abstract val limit: Int

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

abstract val next: String?

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

abstract val offset: Int

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

abstract val previous: String?

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

open override val size: Int

abstract val total: Int

The maximum number of items available to return.

Functions

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

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

@FlowPreview

@ExperimentalCoroutinesApi

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

Flow the Paging action.

fun flowBackward(): Flow<Z>

Flow from current page backwards.

@ExperimentalCoroutinesApi

fun flowEndOrdered(): Flow<Z>

@ExperimentalCoroutinesApi

fun flowForward(): Flow<Z>

Flow from current page forwards.

@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<Z>

Flow the paging objects.

flowPagingObjectsOrdered

@ExperimentalCoroutinesApi

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

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<Z>

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

abstract suspend fun getAllItems(): List<T?>

Retrieve all T associated with this rest action

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

abstract suspend fun getAllPagingObjects(): List<Z>

Retrieve all PagingObjectBase associated with this rest action

getAllPagingObjectsRestAction

fun getAllPagingObjectsRestAction(): SpotifyRestAction<List<Z>>

Retrieve all PagingObjectBase associated with this rest action

suspend fun getNext(): Z?

getNextRestAction

fun getNextRestAction(): SpotifyRestAction<Z?>

suspend fun getPrevious(): Z?

getPreviousRestAction

fun getPreviousRestAction(): SpotifyRestAction<Z?>

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

abstract suspend fun getWithNextTotalPagingObjects(total: Int): List<Z>

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

getWithNextTotalPagingObjectsRestAction

fun getWithNextTotalPagingObjectsRestAction(total: Int): SpotifyRestAction<List<Z>>

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

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

open override fun isEmpty(): Boolean

abstract operator override fun iterator(): Iterator<T?>

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

abstract fun listIterator(): ListIterator<T?>

abstract fun listIterator(index: Int): ListIterator<T?>

abstract fun subList(fromIndex: Int, toIndex: Int): List<T?>

open suspend 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.