soil-query-core/soil.query/MutationModel

MutationModel

interface MutationModel<out T> : DataModel<T>

Data model for the state handled by MutationKey.

All data models related to mutations, implement this interface.

Parameters

T

Type of the return value from the mutation.

Inheritors

Properties

Link copied to clipboard
abstract val error: Throwable?

The error that occurred.

Link copied to clipboard
abstract val errorUpdatedAt: Long

The timestamp when the error occurred.

Link copied to clipboard
open val isFailure: Boolean

Returns true if the mutation is a failure, false otherwise.

Link copied to clipboard
open val isIdle: Boolean

Returns true if the mutation is idle, false otherwise.

Link copied to clipboard
open val isMutated: Boolean

Returns true if the mutation has been mutated, false otherwise.

Link copied to clipboard
open val isPending: Boolean

Returns true if the mutation is pending, false otherwise.

Link copied to clipboard
open val isSuccess: Boolean

Returns true if the mutation is successful, false otherwise.

Link copied to clipboard
abstract val mutatedCount: Int

The number of times the mutation has been mutated.

Link copied to clipboard
abstract val reply: Reply<T>

The return value from the data source.

Link copied to clipboard
abstract val replyUpdatedAt: Long

The timestamp when the data was updated.

Link copied to clipboard
open val revision: String

The revision of the currently snapshot.

Link copied to clipboard
abstract val status: MutationStatus

The status of the mutation.

Link copied to clipboard
open val submittedAt: Long

The timestamp when the mutation was submitted.

Functions

Link copied to clipboard
open override fun isAwaited(): Boolean

Returns true if the MutationModel is awaited.