replica-core/me.aartikov.replica.single/ReplicaSettings

ReplicaSettings

data class ReplicaSettings( val staleTime: Duration?, val clearTime: Duration? = null, val clearErrorTime: Duration? = 250.milliseconds, val cancelTime: Duration? = 250.milliseconds, val revalidateOnActiveObserverAdded: Boolean = true, val revalidateOnNetworkConnection: Boolean = true)

Configures behaviour of a replica.

Constructors

ReplicaSettings

fun ReplicaSettings( staleTime: Duration?, clearTime: Duration? = null, clearErrorTime: Duration? = 250.milliseconds, cancelTime: Duration? = 250.milliseconds, revalidateOnActiveObserverAdded: Boolean = true, revalidateOnNetworkConnection: Boolean = true)

Types

Companion

object Companion

Properties

cancelTime

val cancelTime: Duration?

specifies how quickly request will be canceled when there is no observers (null means never).

clearErrorTime

val clearErrorTime: Duration?

specifies how quickly error will be cleared when there is no observers (null means never).

clearTime

val clearTime: Duration? = null

specifies how quickly data will be cleared when there is no observers (null means never).

revalidateOnActiveObserverAdded

val revalidateOnActiveObserverAdded: Boolean = true

specifies if stale data will be refreshed when an active observer is added.

revalidateOnNetworkConnection

val revalidateOnNetworkConnection: Boolean = true

specifies if stale data will be refreshed when a network connection is established and a replica has active observer. Note: NetworkConnectivityProvider has to be added to ReplicaClient.

staleTime

val staleTime: Duration?

specifies how quickly fetched data will became stale (null means never).