soil-query-compose/soil.query.compose/SubscriptionSuccessObject

SubscriptionSuccessObject

data class SubscriptionSuccessObject<T>(val reply: Reply<T>, val replyUpdatedAt: Long, val error: Throwable?, val errorUpdatedAt: Long, val subscriberStatus: SubscriberStatus, val subscribe: suspend () -> Unit, val unsubscribe: () -> Unit, val reset: suspend () -> Unit) : SubscriptionObject<T>

A SubscriptionSuccessObject represents the successful state of the SubscriptionObject.

Parameters

T

Type of data to receive.

Constructors

SubscriptionSuccessObject

constructor(reply: Reply<T>, replyUpdatedAt: Long, error: Throwable?, errorUpdatedAt: Long, subscriberStatus: SubscriberStatus, subscribe: suspend () -> Unit, unsubscribe: () -> Unit, reset: suspend () -> Unit)

Properties

open override val data: T

The received value from the data source.

open override val error: Throwable?

open override val errorUpdatedAt: Long

open val hasSubscribers: Boolean

open val isFailure: Boolean

open val isPending: Boolean

open val isSuccess: Boolean

open override val reply: Reply<T>

open override val replyUpdatedAt: Long

open override val reset: suspend () -> Unit

Resets the subscribed data and re-executes the subscription process.

open val revision: String

open override val status: SubscriptionStatus

open override val subscribe: suspend () -> Unit

Starts the subscription if not already subscribed.

subscriberStatus

open override val subscriberStatus: SubscriberStatus

open override val unsubscribe: () -> Unit

Cancels the subscription if currently subscribed.

Functions

open override fun isAwaited(): Boolean