Sync Android SDK for Java/com.twilio.sync.client.java/SyncClientJava

SyncClientJava

interface SyncClientJava : Listenable<SyncClientJava.Listener>

This is a central entity used to work with Sync.

After creating a SyncClientJava you can open, create and modify SyncDocumentJavas, SyncListJavas, SyncMapJavas and SyncStreamJavas.

Example:

SyncClientFactory.create(context, tokenProvider, new SuccessListener<SyncClientJava>() {

    @Override
    public void onSuccess(@NonNull SyncClientJava result) {
        future.set(result);
    }

    @Override
    public void onFailure(@NonNull ErrorInfo errorInfo) {
        fail("Cannot create SyncClient: " + errorInfo);
    }
});

Types

object Companion

interface Listener

This interface defines SyncClient callback methods.

Properties

connectionState

abstract val connectionState: <Error class: unknown class>

Current transport state.

abstract val documents: DocumentsJava

Provides methods to work with sync documents.

abstract val lists: ListsJava

Provides methods to work with sync lists.

abstract val maps: MapsJava

Provides methods to work with sync maps.

abstract val streams: StreamsJava

Provides methods to work with sync streams.

Functions

abstract override fun addListener(listener: SyncClientJava.Listener)

Method to add listener for this SyncClientJava.

removeAllListeners

abstract override fun removeAllListeners()

Method to remove all listeners from this SyncClientJava.

abstract override fun removeListener(listener: SyncClientJava.Listener)

Method to Method to remove listener from this SyncClientJava.

abstract fun shutdown()

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