soil-query-compose/soil.query.compose/InfiniteQueryObject

InfiniteQueryObject

@Stable
sealed interface InfiniteQueryObject<out T, S> : QueryModel<T>

A InfiniteQueryObject represents QueryModels interface for infinite fetching data using a retrieval method known as "infinite scroll."

Parameters

T

Type of data to retrieve.

S

Type of parameter.

Inheritors

Properties

Link copied to clipboard
abstract val data: T?

The return value from the data source. (Backward compatibility with QueryModel)

Link copied to clipboard
abstract val error: Throwable?
Link copied to clipboard
abstract val errorUpdatedAt: Long
Link copied to clipboard
Link copied to clipboard
open val isFailure: Boolean
Link copied to clipboard
open val isFetching: Boolean
Link copied to clipboard
abstract val isInvalidated: Boolean
Link copied to clipboard
open val isPending: Boolean
Link copied to clipboard
open val isSuccess: Boolean
Link copied to clipboard
abstract val loadMore: suspend (param: S) -> Unit

Fetches data for the InfiniteQueryKey using the parameter.

Link copied to clipboard
abstract val loadMoreParam: S?

The parameter for next fetching. If null, it means there is no more data to fetch.

Link copied to clipboard
abstract val refresh: suspend () -> Unit

Refreshes the data.

Link copied to clipboard
abstract val reply: Reply<T>
Link copied to clipboard
abstract val replyUpdatedAt: Long
Link copied to clipboard
open val revision: String
Link copied to clipboard
abstract val staleAt: Long
Link copied to clipboard
abstract val status: QueryStatus

Functions

Link copied to clipboard
open override fun isAwaited(): Boolean
Link copied to clipboard
open fun isPaused(currentAt: Long): Boolean
Link copied to clipboard
open fun isStaled(currentAt: Long): Boolean