soil-query-compose/soil.query.compose/QuerySuccessObject

QuerySuccessObject

data class QuerySuccessObject<T>(val reply: Reply<T>, val replyUpdatedAt: Long, val error: Throwable?, val errorUpdatedAt: Long, val staleAt: Long, val fetchStatus: QueryFetchStatus, val isInvalidated: Boolean, val refresh: suspend () -> Unit) : QueryObject<T>

A QuerySuccessObject represents the successful state of the QueryObject.

Parameters

T

Type of data to retrieve.

Constructors

QuerySuccessObject

constructor(reply: Reply<T>, replyUpdatedAt: Long, error: Throwable?, errorUpdatedAt: Long, staleAt: Long, fetchStatus: QueryFetchStatus, isInvalidated: Boolean, refresh: suspend () -> Unit)

Properties

open override val data: T

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

open override val error: Throwable?

open override val errorUpdatedAt: Long

open override val fetchStatus: QueryFetchStatus

open val isFailure: Boolean

open val isFetching: Boolean

open override val isInvalidated: Boolean

open val isPending: Boolean

open val isSuccess: Boolean

open override val refresh: suspend () -> Unit

Refreshes the data.

open override val reply: Reply<T>

open override val replyUpdatedAt: Long

open val revision: String

open override val staleAt: Long

open override val status: QueryStatus

Functions

open override fun isAwaited(): Boolean

open fun isPaused(currentAt: Long): Boolean

open fun isStaled(currentAt: Long): Boolean