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

SyncApiClient

interface SyncApiClient : EventEmitter

Functions

abstract suspend fun cancel(wait: Boolean = false)

abstract suspend fun emitEvent(event: Event<*>)

abstract suspend fun start(filter: String? = null, setPresence: Presence? = null, currentBatchToken: MutableStateFlow<String?> = MutableStateFlow(null), timeout: Long = 30000, withTransaction: suspend (block: suspend () -> Unit) -> Unit = { it() }, asUserId: UserId? = null, wait: Boolean = false, scope: CoroutineScope)

startOnce

abstract suspend fun <T> startOnce(filter: String? = null, setPresence: Presence? = null, currentBatchToken: MutableStateFlow<String?> = MutableStateFlow(null), timeout: Long = 0, withTransaction: suspend (block: suspend () -> Unit) -> Unit = { it() }, asUserId: UserId? = null, runOnce: suspend (Sync.Response) -> T): Result<T>

stop

abstract suspend fun stop(wait: Boolean = false)

abstract fun <T : EventContent> subscribe(clazz: KClass<T>, subscriber: suspend (Event<T>) -> Unit)

subscribeAfterSyncResponse

abstract fun subscribeAfterSyncResponse(subscriber: AfterSyncResponseSubscriber)

subscribeAllEvents

abstract fun subscribeAllEvents(subscriber: suspend (Event<EventContent>) -> Unit)

subscribeDeviceLists

abstract fun subscribeDeviceLists(subscriber: DeviceListsSubscriber)

subscribeOlmKeysChange

abstract fun subscribeOlmKeysChange(subscriber: OlmKeysChangeSubscriber)

subscribeSyncResponse

abstract fun subscribeSyncResponse(subscriber: SyncResponseSubscriber)

sync

abstract suspend fun sync(filter: String? = null, since: String? = null, fullState: Boolean = false, setPresence: Presence? = null, timeout: Long = 0, asUserId: UserId? = null): Result<Sync.Response>

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

unsubscribe

abstract fun <T : EventContent> unsubscribe(clazz: KClass<T>, subscriber: suspend (Event<T>) -> Unit)

unsubscribeAfterSyncResponse

abstract fun unsubscribeAfterSyncResponse(subscriber: AfterSyncResponseSubscriber)

unsubscribeAllEvents

abstract fun unsubscribeAllEvents(subscriber: suspend (Event<EventContent>) -> Unit)

unsubscribeDeviceLists

abstract fun unsubscribeDeviceLists(subscriber: DeviceListsSubscriber)

unsubscribeOlmKeysChange

abstract fun unsubscribeOlmKeysChange(subscriber: OlmKeysChangeSubscriber)

unsubscribeSyncResponse

abstract fun unsubscribeSyncResponse(subscriber: SyncResponseSubscriber)

Properties

currentSyncState

abstract val currentSyncState: StateFlow<SyncState>

Inheritors

SyncApiClientImpl

Extensions

startOnce

suspend fun SyncApiClient.startOnce(filter: String? = null, setPresence: Presence? = null, currentBatchToken: MutableStateFlow<String?> = MutableStateFlow(null), timeout: Long = 0, withTransaction: suspend (block: suspend () -> Unit) -> Unit = { it() }, asUserId: UserId? = null): Result<Unit>