soil-query-core/soil.query/MutationState

MutationState

data class MutationState<T> : MutationModel<T>

State for managing the execution result of Mutation.

Types

Companion

object Companion

OmitKey

@JvmInline

value class OmitKey(val name: String)

Properties

error

open override val error: Throwable? = null

The error that occurred.

errorUpdatedAt

open override val errorUpdatedAt: Long = 0

The timestamp when the error occurred.

isFailure

open val isFailure: Boolean

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

isIdle

open val isIdle: Boolean

Returns true if the mutation is idle, false otherwise.

isMutated

open val isMutated: Boolean

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

isPending

open val isPending: Boolean

Returns true if the mutation is pending, false otherwise.

isSuccess

open val isSuccess: Boolean

Returns true if the mutation is successful, false otherwise.

mutatedCount

open override val mutatedCount: Int = 0

The number of times the mutation has been mutated.

open override val reply: Reply<T>

The return value from the data source.

replyUpdatedAt

open override val replyUpdatedAt: Long = 0

The timestamp when the data was updated.

revision

open val revision: String

The revision of the currently snapshot.

status

open override val status: MutationStatus

The status of the mutation.

submittedAt

open val submittedAt: Long

The timestamp when the mutation was submitted.

Functions

isAwaited

open override fun isAwaited(): Boolean

Returns true if the MutationModel is awaited.

omit

fun omit(keys: Set<MutationState.OmitKey>): MutationState<T>

Returns a new MutationState with the items included in keys omitted from the current MutationState.