soil-query-core/soil.query/QueryCommand/Context

Context

interface Context<T>

Context for query command.

Parameters

T

Type of the return value from the query.

Properties

abstract val dispatch: QueryDispatch<T>

abstract val options: QueryOptions

abstract val receiver: QueryReceiver

abstract val relay: QueryErrorRelay?

abstract val state: QueryModel<T>

Functions

dispatchFetchChunksResult

inline suspend fun <T, S> QueryCommand.Context<QueryChunks<T, S>>.dispatchFetchChunksResult(key: InfiniteQueryKey<T, S>, variable: S, marker: Marker, noinline callback: QueryCallback<QueryChunks<T, S>>?)

Dispatches the result of fetching data for the InfiniteQueryKey.

dispatchFetchFailure

fun <T> QueryCommand.Context<T>.dispatchFetchFailure(error: Throwable)

Dispatches the fetch failure.

dispatchFetchResult

inline suspend fun <T> QueryCommand.Context<T>.dispatchFetchResult(key: QueryKey<T>, marker: Marker, noinline callback: QueryCallback<T>?)

Dispatches the fetch result.

dispatchFetchSuccess

fun <T> QueryCommand.Context<T>.dispatchFetchSuccess(data: T, contentEquals: QueryContentEquals<T>? = null)

Dispatches the fetch success.

dispatchRevalidateChunksResult

inline suspend fun <T, S> QueryCommand.Context<QueryChunks<T, S>>.dispatchRevalidateChunksResult(key: InfiniteQueryKey<T, S>, chunks: QueryChunks<T, S>, marker: Marker, noinline callback: QueryCallback<QueryChunks<T, S>>?)

Dispatches the result of revalidating data for the InfiniteQueryKey.

suspend fun <T> QueryCommand.Context<T>.fetch(key: QueryKey<T>, retryFn: RetryFn<T> = options.exponentialBackOff(onRetry = onRetryCallback(key.id))): Result<T>

Fetches the data.

suspend fun <T, S> QueryCommand.Context<QueryChunks<T, S>>.fetch(key: InfiniteQueryKey<T, S>, variable: S, retryFn: RetryFn<T> = options.exponentialBackOff(onRetry = onRetryCallback(key.id))): Result<T>

Fetches data for the InfiniteQueryKey using the value of variable.

reportQueryError

fun <T> QueryCommand.Context<T>.reportQueryError(error: Throwable, id: UniqueId, marker: Marker)

Reports the query error.

suspend fun <T, S> QueryCommand.Context<QueryChunks<T, S>>.revalidate(key: InfiniteQueryKey<T, S>, chunks: QueryChunks<T, S>): Result<QueryChunks<T, S>>

Revalidates the data for the InfiniteQueryKey using the value of chunks.

fun <T> QueryCommand.Context<T>.shouldFetch(revision: String? = null): Boolean

Determines whether a fetch operation is necessary based on the current state.

fun <T> QueryCommand.Context<T>.shouldPause(error: Throwable): QueryFetchStatus.Paused?

Determines whether query processing needs to be paused based on error.