Sync Android SDK/com.twilio.sync/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.

todo: more detailed description with code examples please.

Types

ConnectionState

enum ConnectionState

Enum representing underlying twilsock connection state.

LogLevel

class LogLevel

Log level constants for passing to setLogLevel.

Properties

interface Properties

Specify properties for creating new Sync Client.

SyncClientListener

interface SyncClientListener

This interface defines SyncClient callback methods.

Functions

create

open fun create(context: Context, accessToken: String, props: SyncClient.Properties, listener: SuccessListener<SyncClient>)

Public factory method to create a new instance of Sync Client.

getConnectionState

abstract fun getConnectionState(): SyncClient.ConnectionState

getSdkVersion

open fun getSdkVersion(): String

openDocument

abstract fun openDocument(options: SyncOptions, observer: SyncDocumentObserver, output: SuccessListener<SyncDocument>)

Open or create a SyncDocument object.

openList

abstract fun openList(options: SyncOptions, observer: SyncListObserver, output: SuccessListener<SyncList>)

Open or create a SyncList object.

openMap

abstract fun openMap(options: SyncOptions, observer: SyncMapObserver, output: SuccessListener<SyncMap>)

Open or create a SyncMap object.

openStream

abstract fun openStream(options: SyncOptions, observer: SyncStreamObserver, output: SuccessListener<SyncStream>)

Open or create a SyncStream object.

setListener

abstract fun setListener(listener: SyncClient.SyncClientListener)

Set new listener on the client.

setLogLevel

open fun setLogLevel(level: Int)

Set verbosity level for log messages to be printed to android logcat.

shutdown

abstract fun shutdown()

Cleanly shut down the SyncClient and free up associated resources.

updateToken

abstract fun updateToken(accessToken: String, listener: SuccessListener<Void>)

Update SyncClient with a refreshed token.