soil-query-core/soil.query/SubscriptionKey

SubscriptionKey

interface SubscriptionKey<T>

SubscriptionKey for managing Subscription associated with id.

Parameters

T

Type of data to receive.

Properties

Link copied to clipboard
open val contentCacheable: SubscriptionContentCacheable<T>?

Function to determine if the data should be cached.

Link copied to clipboard
open val contentEquals: SubscriptionContentEquals<T>?

Function to compare the content of the data.

Link copied to clipboard
abstract val id: SubscriptionId<T>

A unique identifier used for managing SubscriptionKey.

Link copied to clipboard
abstract val subscribe: SubscriptionReceiver.() -> Flow<T>

Function to subscribe to the data as Flow.

Functions

Link copied to clipboard
open fun onConfigureOptions(): SubscriptionOptionsOverride?

Function to configure the SubscriptionOptions.

Link copied to clipboard
open fun onRecoverData(): SubscriptionRecoverData<T>?

Function to recover data from the error.