PowerSync Core/com.powersync.sync/SyncStream

SyncStream

interface SyncStream : SyncStreamDescription(source)

A handle to a SyncStreamDescription that allows subscribing to the stream.

To obtain an instance of SyncStream, call com.powersync.PowerSyncDatabase.syncStream.

Properties

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.

Functions

Link copied to clipboard
abstract suspend fun subscribe(ttl: Duration? = null, priority: StreamPriority? = null): SyncStreamSubscription
Link copied to clipboard
abstract suspend fun unsubscribeAll()