soil-query-compose/soil.query.compose/SubscriptionObject

SubscriptionObject

@Stable
sealed interface SubscriptionObject<out T> : SubscriptionModel<T>

A SubscriptionObject represents SubscriptionModels interface for receiving data.

Parameters

T

Type of data to receive.

Inheritors

Properties

Link copied to clipboard
abstract val data: T?

The received value from the data source.

Link copied to clipboard
abstract val error: Throwable?
Link copied to clipboard
abstract val errorUpdatedAt: Long
Link copied to clipboard
Link copied to clipboard
open val isFailure: Boolean
Link copied to clipboard
open val isPending: Boolean
Link copied to clipboard
open val isSuccess: Boolean
Link copied to clipboard
abstract val reply: Reply<T>
Link copied to clipboard
abstract val replyUpdatedAt: Long
Link copied to clipboard
abstract val reset: suspend () -> Unit

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

Link copied to clipboard
open val revision: String
Link copied to clipboard
abstract val status: SubscriptionStatus
Link copied to clipboard
abstract val subscribe: suspend () -> Unit

Starts the subscription if not already subscribed.

Link copied to clipboard
Link copied to clipboard
abstract val unsubscribe: () -> Unit

Cancels the subscription if currently subscribed.

Functions

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