soil-query-compose/soil.query.compose/MutationIdleObject

MutationIdleObject

data class MutationIdleObject<T, S>(val reply: Reply<T>, val replyUpdatedAt: Long, val error: Throwable?, val errorUpdatedAt: Long, val mutatedCount: Int, val mutate: suspend (S) -> T, val mutateAsync: suspend (S) -> Unit, val reset: suspend () -> Unit) : MutationObject<T, S>

A MutationIdleObject represents the initial idle state of the MutationObject.

Parameters

T

Type of the return value from the mutation.

S

Type of the variable to be mutated.

Constructors

MutationIdleObject

constructor(reply: Reply<T>, replyUpdatedAt: Long, error: Throwable?, errorUpdatedAt: Long, mutatedCount: Int, mutate: suspend (S) -> T, mutateAsync: suspend (S) -> Unit, reset: suspend () -> Unit)

Properties

open override val data: T?

The return value from the data source. (Backward compatibility with MutationModel)

open override val error: Throwable?

open override val errorUpdatedAt: Long

open val isFailure: Boolean

open val isIdle: Boolean

open val isMutated: Boolean

open val isPending: Boolean

open val isSuccess: Boolean

open override val mutate: suspend (S) -> T

Mutates the variable.

open override val mutateAsync: suspend (S) -> Unit

Mutates the variable asynchronously.

open override val mutatedCount: Int

open override val reply: Reply<T>

open override val replyUpdatedAt: Long

open override val reset: suspend () -> Unit

Resets the mutation state.

open val revision: String

open override val status: MutationStatus

open val submittedAt: Long

Functions

open override fun isAwaited(): Boolean