soil-query-core/soil.query/InfiniteQueryRef

InfiniteQueryRef

interface InfiniteQueryRef<T, S> : Actor

A reference to an Query for InfiniteQueryKey.

Parameters

T

Type of data to retrieve.

S

Type of parameter.

Properties

abstract val id: InfiniteQueryId<T, S>

A unique identifier used for managing InfiniteQueryKey.

abstract val state: StateFlow<QueryState<QueryChunks<T, S>>>

State Flow to receive the current state of the query.

Functions

abstract suspend fun invalidate()

Invalidates the Query.

abstract fun launchIn(scope: CoroutineScope): Job

Launches the actor.

abstract suspend fun loadMore(param: S)

Fetches data for the InfiniteQueryKey using the value of param.

abstract fun nextParam(data: QueryChunks<T, S>): S?

Function returning the parameter for additional fetching.

abstract suspend fun resume()

Resumes the Query.