com.twilio.sync

Class SyncClient

java.lang.Object

com.twilio.sync.SyncClient

public class SyncClient
extends java.lang.Object

This is a central entity used to work with Sync. After creating a SyncClient you can open, create and modify Documents, Lists and Maps.

todo: more detailed description with code examples please.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SyncClient.ConnectionState Enum representing underlying twilsock connection state.
static interface	SyncClient.ConnectionStateListener Listener interface to receive connection state change events.
static class	SyncClient.Properties Specify properties for creating new Sync Client.

Method Summary

Modifier and Type	Method and Description
static void	create(android.content.Context context, java.lang.String accessToken, SyncClient.Properties props, SuccessListener<SyncClient> listener) Public factory method to create a new instance of Sync Client.
void	dispose()
SyncClient.ConnectionState	getConnectionState()
static java.lang.String	getSdkVersion()
void	openDocument(Options options, DocumentObserver observer, SuccessListener<Document> output) Open or create a Document object.
void	openList(Options options, ListObserver observer, SuccessListener<List> output) Open or create a List object.
void	openMap(Options options, MapObserver observer, SuccessListener<Map> output) Open or create a Map object.
void	openStream(Options options, StreamObserver observer, SuccessListener<Stream> output) Open or create a Stream object.
void	setConnectionStateListener(SyncClient.ConnectionStateListener listener) Set new connection state listener on the client.
static void	setLogLevel(int level)
void	shutdown() Cleanly shut down the SyncClient and free up associated resources.
void	updateToken(java.lang.String accessToken, SuccessListener<java.lang.Void> listener) Update SyncClient with a refreshed token.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static void create(@NonNull
                          android.content.Context context,
                          java.lang.String accessToken,
                          SyncClient.Properties props,
                          SuccessListener<SyncClient> listener)

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

Parameters:

context - Pass Application Context here, cannot be null.

accessToken - Access token containing at least a Sync Grant to access sync features.

props - Properties for initializing client. Properties.defaultProperties() could be commonly used. See SyncClient.Properties for more details.

listener - Listener to receive the newly created Sync Client.

getSdkVersion

public static java.lang.String getSdkVersion()

Returns:

The version of the Sync SDK.

updateToken

public void updateToken(java.lang.String accessToken,
                        SuccessListener<java.lang.Void> listener)

Update SyncClient with a refreshed token.

Parameters:

accessToken - New access token containing at least a Sync Grant to access sync features.

listener - Listener to receive status of the operation.

shutdown

public void shutdown()

Cleanly shut down the SyncClient and free up associated resources. Call this when exiting application or when done working with the SyncClient to properly finish working with Sync.

Avoid calling methods on Sync objects from their own callback events, as it may lead to unexpected nesting and poorly predictable behavior. SyncClient shutdown method must not be called from an event callback.

It will dispose() the client after shutdown, so it could not be reused.

openDocument

public void openDocument(Options options,
                         DocumentObserver observer,
                         SuccessListener<Document> output)

Open or create a Document object.

Parameters:

options - Options that specify open mode and possible SID or Unique Name of the Document.

observer - Observer to receive callbacks on all actions performed on the document both locally and remotely.

output - Listener that will receive opened document in its onSuccess() callback or any error in onError() callback.

openList

public void openList(Options options,
                     ListObserver observer,
                     SuccessListener<List> output)

Open or create a List object.

Parameters:

options - Options that specify open mode and possible SID or Unique Name of the List.

observer - Observer to receive callbacks on all actions performed on the list both locally and remotely.

output - Listener that will receive opened list in its onSuccess() callback or any error in onError() callback.

openMap

public void openMap(Options options,
                    MapObserver observer,
                    SuccessListener<Map> output)

Open or create a Map object.

Parameters:

options - Options that specify open mode and possible SID or Unique Name of the Map.

observer - Observer to receive callbacks on all actions performed on the map both locally and remotely.

output - Listener that will receive opened map in its onSuccess() callback or any error in onError() callback.

openStream

public void openStream(Options options,
                       StreamObserver observer,
                       SuccessListener<Stream> output)

Open or create a Stream object.

Parameters:

options - Options that specify open mode and possible SID or Unique Name of the Stream.

observer - Observer to receive callbacks on all actions performed on the stream both locally and remotely.

output - Listener that will receive opened stream in its onSuccess() callback or any error in onError() callback.

getConnectionState

public SyncClient.ConnectionState getConnectionState()

Returns:

Current transport state.

setConnectionStateListener

public void setConnectionStateListener(SyncClient.ConnectionStateListener listener)

Set new connection state listener on the client. Set to null to clear. As soon as listener is set it will receive onConnectionStateChanged callback with the current state of the connection.

Parameters:

listener - New listener to use or null to remove listener.

setLogLevel

public static void setLogLevel(int level)

dispose

public void dispose()