soil-query-core/soil.query/QueryModel

QueryModel

interface QueryModel<out T> : DataModel<T>

Data model for the state handled by QueryKey or InfiniteQueryKey.

All data models related to queries, implement this interface.

Parameters

T

Type of data to retrieve.

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
abstract val fetchStatus: QueryFetchStatus

The fetch status of the query.

Link copied to clipboard
open val isFailure: Boolean

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

Link copied to clipboard
open val isFetching: Boolean

Returns true if the query is fetching, false otherwise.

Link copied to clipboard
abstract val isInvalidated: Boolean

Returns true if the query is invalidated, false otherwise.

Link copied to clipboard
open val isPending: Boolean

Returns true if the query is pending, false otherwise.

Link copied to clipboard
open val isSuccess: Boolean

Returns true if the query is successful, false otherwise.

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 staleAt: Long

The timestamp when the data is considered stale.

Link copied to clipboard
abstract val status: QueryStatus

The status of the query.

Functions

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

Returns true if the QueryModel is awaited.

Link copied to clipboard
open fun isPaused(currentAt: Long = epoch()): Boolean

Returns true if the query is paused, false otherwise.

Link copied to clipboard
open fun isStaled(currentAt: Long = epoch()): Boolean

Returns true if the query is staled, false otherwise.