Sync Android SDK/com.twilio.sync.client/SyncClient

SyncClient

This is a central entity used to work with Sync.

After creating a SyncClient you can open, create and modify SyncDocuments, SyncLists, SyncMaps and SyncStreams.

Example:

val syncClient = runCatching { SyncClient(context) { requestToken() } }.getOrElse { t ->
     val errorInfo = (t as? TwilioException)?.errorInfo
     Log.w(TAG, "Error creating SyncClient: $errorInfo")
     return
}

Types

Companion

object Companion

Events

interface Events

This interface defines scope of Flows for collecting SyncClient events.

Properties

connectionState

abstract val connectionState: <Error class: unknown class>

Current transport state.

documents

abstract val documents: Documents

Provides methods to work with SyncDocuments.

events

abstract val events: SyncClient.Events

Provides scope of Flows objects to get notified about events.

lists

abstract val lists: Lists

Provides methods to work with SyncLists.

maps

abstract val maps: Maps

Provides methods to work with SyncMaps.

streams

abstract val streams: Streams

Provides methods to work with SyncStreams.

Functions

shutdown

abstract fun shutdown(logout: Boolean = false)

Cleanly shuts down the SyncClient when you are done with it. After calling this method client could not be reused.

use

inline fun <R> SyncClient.use(block: (SyncClient) -> R): R

Executes the given block function on SyncClient and then shuts it down correctly whether an exception is thrown or not.