soil-query-core/soil.query/InfiniteQueryKey

InfiniteQueryKey

interface InfiniteQueryKey<T, S>

InfiniteQueryKey for managing Query associated with id.

The difference from QueryKey is that it's an interface for infinite fetching data using a retrieval method known as "infinite scroll."

Parameters

T

Type of data to retrieve.

S

Type of parameter.

Properties

Link copied to clipboard
open val contentCacheable: QueryContentCacheable<QueryChunks<T, S>>?

Function to determine if the data should be cached.

Link copied to clipboard
open val contentEquals: QueryContentEquals<QueryChunks<T, S>>?

Function to compare the content of the data.

Link copied to clipboard
abstract val fetch: suspend QueryReceiver.(param: S) -> T

Suspending function to retrieve data.

Link copied to clipboard
abstract val id: InfiniteQueryId<T, S>

A unique identifier used for managing InfiniteQueryKey.

Link copied to clipboard
abstract val initialParam: () -> S

Function returning the initial parameter.

Link copied to clipboard
abstract val loadMoreParam: (QueryChunks<T, S>) -> S?

Function returning the parameter for additional fetching.

Functions

Link copied to clipboard
open fun onConfigureOptions(): QueryOptionsOverride?

Function to configure the QueryOptions.

Link copied to clipboard
open fun onRecoverData(): QueryRecoverData<QueryChunks<T, S>>?

Function to convert specific exceptions as data.