PagingObjectBase

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

Constructors

PagingObjectBase

common

fun PagingObjectBase()

Functions

contains

common

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

containsAll

common

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

flow

common

@FlowPreview()

@ExperimentalCoroutinesApi()

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

Flow the Paging action.

flowBackward

common

fun flowBackward(): Flow<Z>

Flow from current page backwards.

flowEndOrdered

common

@ExperimentalCoroutinesApi()

fun flowEndOrdered(): Flow<Z>

flowForward

common

@ExperimentalCoroutinesApi()

fun flowForward(): Flow<Z>

Flow from current page forwards.

flowOrdered

common

@FlowPreview()

@ExperimentalCoroutinesApi()

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

Flow the paging action ordered.

flowPagingObjects

common

@ExperimentalCoroutinesApi()

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

Flow the paging objects.

flowPagingObjectsOrdered

common

@ExperimentalCoroutinesApi()

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

Flow the paging objects ordered.

flowStartOrdered

common

@ExperimentalCoroutinesApi()

fun flowStartOrdered(): Flow<Z>

get

common

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

getAllItems

common

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

Retrieve all T associated with this rest action

getAllItemsNotNull

common

suspend fun getAllItemsNotNull(): List<T>

Get all items of type T associated with the request.

getAllItemsNotNullRestAction

common

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

Get all items of type T associated with the request.

getAllItemsRestAction

common

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

Retrieve all T associated with this rest action

getAllPagingObjects

common

abstract suspend fun getAllPagingObjects(): List<Z>

Retrieve all PagingObjectBase associated with this rest action

getAllPagingObjectsRestAction

common

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

Retrieve all PagingObjectBase associated with this rest action

getNext

common

suspend fun getNext(): Z?

getNextRestAction

common

fun getNextRestAction(): SpotifyRestAction<Z?>

getPrevious

common

suspend fun getPrevious(): Z?

getPreviousRestAction

common

fun getPreviousRestAction(): SpotifyRestAction<Z?>

getWithNextItems

common

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

common

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

common

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

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

getWithNextTotalPagingObjectsRestAction

common

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

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

indexOf

common

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

isEmpty

common

open override fun isEmpty(): Boolean

iterator

common

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

lastIndexOf

common

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

listIterator

common

abstract fun listIterator(): ListIterator<T?>

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

subList

common

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

take

common

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

Returns a list containing at most first n elements.

Properties

api

common

lateinit var api: GenericSpotifyApi

The API client associated with the request

href

common

abstract val href: String

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

items

common

abstract val items: List<T?>

The requested data.

limit

common

abstract val limit: Int

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

common

abstract val next: String?

URL to the next page of items.

offset

common

abstract val offset: Int

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

common

abstract val previous: String?

URL to the previous page of items.

size

common

open override val size: Int

total

common

abstract val total: Int

The maximum number of items available to return.

Inheritors

AbstractPagingObject

CursorBasedPagingObject

Sources

common source