soil-query-core/soil.query/QueryClient

QueryClient

interface QueryClient

A Query client, which allows you to make queries actor and handle QueryKey and InfiniteQueryKey.

Inheritors

Properties

Link copied to clipboard
abstract val queryReceiver: QueryReceiver

Note: This property is exposed for limited use cases where you may need to call QueryKey.fetch and InfiniteQueryKey.fetch manually. It can be useful as an escape hatch or for synchronous invocations within the data layer.

Functions

Link copied to clipboard
abstract fun <T, S> getInfiniteQuery(key: InfiniteQueryKey<T, S>, marker: Marker = Marker.None): InfiniteQueryRef<T, S>

Gets the InfiniteQueryRef by the specified InfiniteQueryKey.

Link copied to clipboard
abstract fun <T> getQuery(key: QueryKey<T>, marker: Marker = Marker.None): QueryRef<T>

Gets the QueryRef by the specified QueryKey.

Link copied to clipboard
abstract fun <T, S> prefetchInfiniteQuery(key: InfiniteQueryKey<T, S>, marker: Marker = Marker.None): Job

Prefetches the infinite query by the specified InfiniteQueryKey.

Link copied to clipboard
abstract fun <T> prefetchQuery(key: QueryKey<T>, marker: Marker = Marker.None): Job

Prefetches the query by the specified QueryKey.