SyncSubscriptionDescription

Information about a subscribed sync stream.

This includes the SyncStreamDescription along with information about the current sync status.

Properties

Link copied to clipboard
abstract val active: Boolean

Whether this stream is active, meaning that the subscription has been acknowledged by the sync service.

Link copied to clipboard
abstract val expiresAt: Instant?

For sync streams that have a time-to-live, the current time at which the stream would expire if not subscribed to again.

Link copied to clipboard

Whether this stream been subscribed to explicitly.

Link copied to clipboard
abstract val hasSynced: Boolean

Whether this stream subscription has been synced at least once.

Link copied to clipboard
abstract val isDefault: Boolean

Whether this stream subscription is included yb default, regardless of whether the stream has explicitly been subscribed to or not.

Link copied to clipboard
abstract val lastSyncedAt: Instant?

If hasSynced is true, the last time data from this stream has been synced.

Link copied to clipboard
abstract val name: String

THe name of the stream as it appears in the stream definition for the PowerSync service.

Link copied to clipboard
abstract val parameters: Map<String, Any?>?

The parameters used to subscribe to the stream, if any.