paging-legacy/co.anitrend.arch.paging.legacy.source.live/SupportPagingLiveDataSource

SupportPagingLiveDataSource

abstract class SupportPagingLiveDataSource<K : Any, V : Any> : AbstractPagingLiveDataSource<K, V>

A data source that is targeted for androidx.paging.PagedList without a backing source

Since

v1.3.0

Constructors

SupportPagingLiveDataSource

constructor()

Properties

isInvalid

open val isInvalid: Boolean

loadState

open override val loadState: Flow<LoadState>

Observable for network state during requests that the UI can monitor and act based on state changes

requestHelper

open override val requestHelper: RequestHelper

Request helper that controls the flow of requests to the implementing data source to avoid multiple requests of the same type before others are completed for this instance

Functions

addInvalidatedCallback

open fun addInvalidatedCallback(onInvalidatedCallback: DataSource.InvalidatedCallback)

invalidate

open override fun invalidate()

Signal the data source to stop loading, and notify its callback.

loadAfter

abstract fun loadAfter(params: PageKeyedDataSource.LoadParams<K>, callback: PageKeyedDataSource.LoadCallback<K, V>)

loadBefore

abstract fun loadBefore(params: PageKeyedDataSource.LoadParams<K>, callback: PageKeyedDataSource.LoadCallback<K, V>)

loadInitial

abstract fun loadInitial(params: PageKeyedDataSource.LoadInitialParams<K>, callback: PageKeyedDataSource.LoadInitialCallback<K, V>)

map

override fun <ToValue : Any> map(function: Function<V, ToValue>): PageKeyedDataSource<K, ToValue>

override fun <ToValue : Any> map(function: (V) -> ToValue): PageKeyedDataSource<K, ToValue>

mapByPage

override fun <ToValue : Any> mapByPage(function: Function<List<V>, List<ToValue>>): PageKeyedDataSource<K, ToValue>

override fun <ToValue : Any> mapByPage(function: (List<V>) -> List<ToValue>): PageKeyedDataSource<K, ToValue>

refresh

open suspend override fun refresh()

Invalidate data source and, re-run the last successful or last failed request if applicable

removeInvalidatedCallback

open fun removeInvalidatedCallback(onInvalidatedCallback: DataSource.InvalidatedCallback)

retryFailed

open suspend override fun retryFailed()

Performs the necessary operation to invoke a network retry request