soil-query-core/soil.query/QueryRef

QueryRef

interface QueryRef<T> : AutoCloseable

A reference to an Query for QueryKey.

Parameters

T

Type of data to retrieve.

Properties

Link copied to clipboard
abstract val id: QueryId<T>

A unique identifier used for managing QueryKey.

Link copied to clipboard
abstract val state: StateFlow<QueryState<T>>

State Flow to receive the current state of the query.

Functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
abstract suspend fun invalidate()

Invalidates the Query.

Link copied to clipboard
abstract suspend fun join()

Joins the Query.

Link copied to clipboard
abstract suspend fun resume()

Resumes the Query.