soil-query-core/soil.query/MutationCommand/Context

Context

interface Context<T>

Context for mutation command.

Parameters

T

Type of the return value from the mutation.

Properties

abstract val dispatch: MutationDispatch<T>

abstract val notifier: MutationNotifier

abstract val options: MutationOptions

abstract val receiver: MutationReceiver

abstract val relay: MutationErrorRelay?

abstract val state: MutationModel<T>

Functions

dispatchMutateFailure

fun <T> MutationCommand.Context<T>.dispatchMutateFailure(error: Throwable)

Dispatches the mutate failure.

dispatchMutateResult

inline suspend fun <T, S> MutationCommand.Context<T>.dispatchMutateResult(key: MutationKey<T, S>, variable: S, marker: Marker, noinline callback: MutationCallback<T>?)

Dispatches the mutation result.

dispatchMutateSuccess

fun <T> MutationCommand.Context<T>.dispatchMutateSuccess(data: T)

Dispatches the mutate success.

suspend fun <T, S> MutationCommand.Context<T>.mutate(key: MutationKey<T, S>, variable: S, retryFn: RetryFn<T> = options.exponentialBackOff(onRetry = onRetryCallback(key.id))): Result<T>

Mutates the data.

reportMutationError

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

fun <T> MutationCommand.Context<T>.shouldMutate(revision: String): Boolean

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