soil-query-core/soil.query/QueryRef

QueryRef

interface QueryRef<T> : Actor

A reference to an Query for QueryKey.

Parameters

T

Type of data to retrieve.

Properties

abstract val key: QueryKey<T>

The QueryKey for the Query.

abstract val marker: Marker

The Marker specified in QueryClient.getQuery.

abstract val options: QueryOptions

The QueryOptions configured for the query.

abstract val state: StateFlow<QueryState<T>>

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 resume()

Resumes the Query.

abstract suspend fun send(command: QueryCommand<T>)

Sends a QueryCommand to the Actor.