soil-query-compose/soil.query.compose/InfiniteQuerySuccessObject

InfiniteQuerySuccessObject

data class InfiniteQuerySuccessObject<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 InfiniteQuerySuccessObject represents the successful state of the InfiniteQueryObject.

Parameters

T

Type of data to retrieve.

S

Type of parameter.

Constructors

InfiniteQuerySuccessObject

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?)

Creates a InfiniteQuerySuccessObject.

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 loadMore: suspend (param: S) -> Unit

Fetches data for the InfiniteQueryKey using the parameter.

open override val loadMoreParam: S?

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

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