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 key: InfiniteQueryKey<T, S>

The InfiniteQueryKey for the Query.

abstract val marker: Marker

The Marker specified in QueryClient.getInfiniteQuery.

abstract val options: QueryOptions

The QueryOptions configured for the query.

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

State Flow to receive the current state of the query.

Functions

open suspend fun invalidate()

Invalidates the Query.

abstract fun launchIn(scope: CoroutineScope): Job

Launches the actor.

open suspend fun loadMore(param: S)

Fetches data for the InfiniteQueryKey using the value of param.

open suspend fun resume()

Resumes the Query.

abstract suspend fun send(command: InfiniteQueryCommand<T, S>)

Sends a QueryCommand to the Actor.