InfiniteQueryRefreshErrorObject

data class InfiniteQueryRefreshErrorObject<T, S>(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, val loadMore: suspend (param: S) -> Unit, val loadMoreParam: S?) : InfiniteQueryObject<T, S>

A InfiniteQueryRefreshErrorObject represents the refresh error state of the InfiniteQueryObject.

This state is used when the data is successfully retrieved once, but an error occurs during the refresh or additional fetching.

Parameters

T

Type of data to retrieve.

S

Type of parameter.

Constructors

Link copied to clipboard
constructor(reply: Reply<T>, replyUpdatedAt: Long, error: Throwable, errorUpdatedAt: Long, staleAt: Long, fetchStatus: QueryFetchStatus, isInvalidated: Boolean, refresh: suspend () -> Unit, loadMore: suspend (param: S) -> Unit, loadMoreParam: S?)

Properties

Link copied to clipboard
open override val data: T

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

Link copied to clipboard
open override val error: Throwable
Link copied to clipboard
open override val errorUpdatedAt: Long
Link copied to clipboard
open override val fetchStatus: QueryFetchStatus
Link copied to clipboard
open val isFailure: Boolean
Link copied to clipboard
Link copied to clipboard
open override val isInvalidated: Boolean
Link copied to clipboard
open val isPending: Boolean
Link copied to clipboard
open val isSuccess: Boolean
Link copied to clipboard
open override val loadMore: suspend (param: S) -> Unit

Fetches data for the InfiniteQueryKey using the parameter.

Link copied to clipboard
open override val loadMoreParam: S?

The parameter for next fetching. If null, it means there is no more data to fetch.

Link copied to clipboard
open override val refresh: suspend () -> Unit

Refreshes the data.

Link copied to clipboard
open override val reply: Reply<T>
Link copied to clipboard
open override val replyUpdatedAt: Long
Link copied to clipboard
open val revision: String
Link copied to clipboard
open override val staleAt: Long
Link copied to clipboard
open override val status: QueryStatus

Functions

Link copied to clipboard
open override fun isAwaited(): Boolean
Link copied to clipboard
open fun isPaused(currentAt: Long): Boolean
Link copied to clipboard
open fun isStaled(currentAt: Long): Boolean