trixnity-clientserverapi-client/de.connect2x.trixnity.clientserverapi.client/SyncApiClient

SyncApiClient

interface SyncApiClient : ClientEventEmitter<SyncEvents>

Inheritors

SyncApiClientImpl

Properties

currentSyncState

abstract val currentSyncState: StateFlow<SyncState>

Functions

abstract suspend fun cancel()

abstract suspend fun emit(events: SyncEvents)

abstract suspend fun start(filter: String? = null, setPresence: Presence? = null, timeout: Duration = 30.seconds)

abstract suspend fun <T> startOnce(filter: String? = null, setPresence: Presence? = null, timeout: Duration = ZERO, runOnce: suspend (SyncEvents) -> T): Result<T>

suspend fun SyncApiClient.startOnce(filter: String? = null, setPresence: Presence? = null, timeout: Duration = ZERO): Result<Unit>

abstract suspend fun stop()

abstract fun subscribe(priority: Int, subscriber: Subscriber<SyncEvents>): Unsubscriber

abstract suspend fun sync(filter: String? = null, since: String? = null, fullState: Boolean = false, setPresence: Presence? = null, timeout: Duration = ZERO, useStateAfter: Boolean? = null): Result<Sync.Response>

This is the plain sync request. If you want to subscribe to events and more, use start or startOnce.