com.twilio.sync

Class SyncDocumentObserver

java.lang.Object

com.twilio.sync.SyncDocumentObserver

public abstract class SyncDocumentObserver
extends java.lang.Object

Observer for all operations on a SyncDocument. You should create your own subclass of DocumentObserver and override functions you are interested in. Observer will receive callbacks for all operations on a SyncDocument. To distinguish parallel streams of local operations your application could use local flow identifier. Callbacks in the observer will be called from a background thread. You will need to repost your work to UI thread if you do any UI-related operations in the callback.

Constructor Summary

Constructors

Constructor and Description
SyncDocumentObserver() Keep default constructor, you don't need to override it.

Method Summary

Modifier and Type	Method and Description
void	dispose()
void	onErrorOccurred(ErrorInfo error) This callback is invoked when a SyncDocument operation has encountered an error.
void	onOpened(SyncDocument doc) This callback is invoked when SyncDocument object has been initialised and opened locally.
void	onRemoved(EventContext context, org.json.JSONObject previousData) This callback is invoked when entire SyncDocument has been removed by a local request.
void	onUpdated(EventContext context, org.json.JSONObject data, org.json.JSONObject previousData) This callback is invoked when a SyncDocument has been modified by a local request.

Methods inherited from class java.lang.Object

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

Constructor Detail

SyncDocumentObserver

public SyncDocumentObserver()

Keep default constructor, you don't need to override it. If you do override make sure to call the inherited constructor.

Method Detail

onOpened

public void onOpened(SyncDocument doc)

This callback is invoked when SyncDocument object has been initialised and opened locally.

Parameters:

doc - SyncDocument object that has been opened. This parameter you should take and use as your initialised instance of a document.

onRemoved

public void onRemoved(EventContext context,
                      org.json.JSONObject previousData)

This callback is invoked when entire SyncDocument has been removed by a local request.

Parameters:

context - Context indicating if change was local or remote.

previousData - Previous contents of the document.

onUpdated

public void onUpdated(EventContext context,
                      org.json.JSONObject data,
                      org.json.JSONObject previousData)

This callback is invoked when a SyncDocument has been modified by a local request.

Parameters:

context - Context indicating if change was local or remote.

data - New contents of the document.

previousData - Previous contents of the document.

onErrorOccurred

public void onErrorOccurred(ErrorInfo error)

This callback is invoked when a SyncDocument operation has encountered an error.

Parameters:

error - Error description.

dispose

public void dispose()