soil-query-core/soil.query/SubscriptionState

SubscriptionState

data class SubscriptionState<T> : SubscriptionModel<T>

State for managing the execution result of Subscription.

Types

Link copied to clipboard
object Companion
Link copied to clipboard
@JvmInline
value class OmitKey(val name: String)

Properties

Link copied to clipboard
open override val error: Throwable? = null

The error that occurred.

Link copied to clipboard
open override val errorUpdatedAt: Long = 0

The timestamp when the error occurred.

Link copied to clipboard
open val hasSubscribers: Boolean

Returns true if the subscription has subscribers, false otherwise.

Link copied to clipboard
open val isFailure: Boolean

Returns true if the query is a failure, 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
open override val reply: Reply<T>

The return value from the data source.

Link copied to clipboard
open override val replyUpdatedAt: Long = 0

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
open override val status: SubscriptionStatus

The received status of the subscription.

Link copied to clipboard
open override val subscriberStatus: SubscriberStatus

The subscriber status of the subscription.

Functions

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

Returns true if the SubscriptionModel is awaited.

Link copied to clipboard
fun omit(keys: Set<SubscriptionState.OmitKey>, defaultSubscriberStatus: SubscriberStatus = SubscriberStatus.NoSubscribers): SubscriptionState<T>

Returns a new SubscriptionState with the items included in keys omitted from the current SubscriptionState.