Class SyncSubscriptionDescription

Namespace: PowerSync.Common.Client.Sync.Stream

Assembly: PowerSync.Common.dll

Information about a subscribed sync stream. This includes the ISyncStreamDescription, along with information about the current sync status.

public class SyncSubscriptionDescription : ISyncStreamDescription

Inheritance: object

SyncSubscriptionDescription

Implements: ISyncStreamDescription

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Active: Whether this stream subscription is currently active.

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

HasExplicitSubscription: Whether this stream has been subscribed to explicitly. It's possible for both IsDefault and HasExplicitSubscription to be true at the same time - this happens when a default stream was subscribed explicitly.

HasSynced: Whether this stream subscription has been synced at least once.

IsDefault: Whether this stream subscription is included by default, regardless of whether the stream has explicitly been subscribed to or not. It's possible for both IsDefault and HasExplicitSubscription to be true at the same time - this happens when a default stream was subscribed explicitly.

LastSyncedAt: If HasSynced is true, the last time data from this stream has been synced.

Name: The name of the stream as it appears in the stream definition for the PowerSync service.

Parameters: The parameters used to subscribe to the stream, if any. The same stream can be subscribed to multiple times with different parameters.

Edit this page