SubscriptionModel

interface SubscriptionModel<out T> : DataModel<T>

Data model for the state handled by SubscriptionKey.

All data models related to subscriptions, implement this interface.

Parameters

T

Type of data to receive.

Inheritors

Properties

Link copied to clipboard
abstract val error: Throwable?

The error that occurred.

Link copied to clipboard
abstract val errorUpdatedAt: Long

The timestamp when the error occurred.

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
abstract val reply: Reply<T>

The return value from the data source.

Link copied to clipboard
abstract val replyUpdatedAt: Long

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

The received status of the subscription.

Functions

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

Returns true if the SubscriptionModel is awaited.