PowerSync Core/com.powersync.sync/SyncStatus

SyncStatus

data class SyncStatus : SyncStatusData(source)

Types

Companion

object Companion

Properties

anyError

open override val anyError: Any?

Convenience getter for either the value of downloadError or uploadError

connected

open override val connected: Boolean

true if currently connected.

connecting

open override val connecting: Boolean

true if the PowerSync connection is busy connecting.

downloadError

open override val downloadError: Any?

Error during downloading (including connecting).

downloading

open override val downloading: Boolean

true if actively downloading changes.

downloadProgress

open override val downloadProgress: SyncDownloadProgress?

Realtime progress information about downloaded operations during an active sync.

hasSynced

open override val hasSynced: Boolean?

Indicates whether there has been at least one full sync, if any.

lastSyncedAt

open override val lastSyncedAt: Instant?

Time that a last sync has fully completed, if any.

priorityStatusEntries

open override val priorityStatusEntries: List<PriorityStatusEntry>

Available PriorityStatusEntry reporting the sync status for buckets within priorities.

syncStreams

val syncStreams: List<SyncStreamStatus>?

All sync streams currently being tracked in the database.

uploadError

open override val uploadError: Any?

Error during uploading.

uploading

open override val uploading: Boolean

true if uploading changes

Functions

asFlow

fun asFlow(): SharedFlow<SyncStatusData>

forStream

fun forStream(stream: SyncStreamDescription): SyncStreamStatus?

Status information for stream, if it's a stream that is currently tracked by the sync client.

statusForPriority

fun statusForPriority(priority: StreamPriority): PriorityStatusEntry

Status information for whether buckets in priority have been synchronized.

toString

open override fun toString(): String