trixnity-clientserverapi-client/net.folivo.trixnity.clientserverapi.client/SyncApiClient

SyncApiClient

interface SyncApiClient : ClientEventEmitter<SyncEvents>

Inheritors

Properties

Link copied to clipboard
abstract val currentSyncState: StateFlow<SyncState>

Functions

Link copied to clipboard
abstract suspend fun cancel(wait: Boolean = false)
Link copied to clipboard
abstract suspend fun emit(events: SyncEvents)
Link copied to clipboard
abstract suspend fun start(filter: String? = null, setPresence: Presence? = null, getBatchToken: suspend () -> String?, setBatchToken: suspend (String) -> Unit, timeout: Duration = 30.seconds, withTransaction: suspend (block: suspend () -> Unit) -> Unit = { it() }, asUserId: UserId? = null, wait: Boolean = false, scope: CoroutineScope)
Link copied to clipboard
abstract suspend fun <T> startOnce(filter: String? = null, setPresence: Presence? = null, getBatchToken: suspend () -> String?, setBatchToken: suspend (String) -> Unit, timeout: Duration = ZERO, withTransaction: suspend (block: suspend () -> Unit) -> Unit = { it() }, asUserId: UserId? = null, runOnce: suspend (Sync.Response) -> T): Result<T>
Link copied to clipboard
suspend fun SyncApiClient.startOnce(filter: String? = null, setPresence: Presence? = null, getBatchToken: suspend () -> String?, setBatchToken: suspend (String) -> Unit, timeout: Duration = ZERO, withTransaction: suspend (block: suspend () -> Unit) -> Unit = { it() }, asUserId: UserId? = null): Result<Unit>
Link copied to clipboard
abstract suspend fun stop(wait: Boolean = false)
Link copied to clipboard
abstract fun subscribe(priority: Int, subscriber: Subscriber<SyncEvents>): Unsubscriber
Link copied to clipboard
abstract suspend fun sync(filter: String? = null, since: String? = null, fullState: Boolean = false, setPresence: Presence? = null, timeout: Duration = ZERO, asUserId: UserId? = null): Result<Sync.Response>

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