com.twilio.sync

Class SyncMapObserver

java.lang.Object

com.twilio.sync.SyncMapObserver

public abstract class SyncMapObserver
extends java.lang.Object

Observer for all operations on a SyncMap. You should create your own subclass of MapObserver and override functions you are interested in. Observer will receive callbacks for all operations on a SyncMap. 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
SyncMapObserver() Keep default constructor, you don't need to override it.

Method Summary

Modifier and Type	Method and Description
void	dispose()
void	onCollectionRemoved(EventContext context) This callback is invoked when the entire SyncMap has been removed.
void	onErrorOccurred(ErrorInfo error) This callback is invoked when a SyncMap operation has encountered a error in local request.
void	onItemAdded(EventContext context, SyncMap.Item item) This callback is invoked when SyncMap item has been added.
void	onItemRemoved(EventContext context, java.lang.String itemKey, org.json.JSONObject previousItemData) This callback is invoked when SyncMap item has been removed.
void	onItemUpdated(EventContext context, SyncMap.Item item, org.json.JSONObject previousItemData) This callback is invoked when SyncMap item has been updated.
void	onOpened(SyncMap syncMap) This callback is invoked when SyncMap object has been initialised and opened locally.

Methods inherited from class java.lang.Object

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

Constructor Detail

SyncMapObserver

public SyncMapObserver()

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(SyncMap syncMap)

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

Parameters:

syncMap - SyncMap object that has been opened. This parameter you should take and use as your initialised instance of a map.

onItemAdded

public void onItemAdded(EventContext context,
                        SyncMap.Item item)

This callback is invoked when SyncMap item has been added.

Parameters:

context - Context indicating if change was local or remote.

item - The item that was added.

onItemUpdated

public void onItemUpdated(EventContext context,
                          SyncMap.Item item,
                          org.json.JSONObject previousItemData)

This callback is invoked when SyncMap item has been updated.

Parameters:

context - Context indicating if change was local or remote.

item - The item after the change.

previousItemData - Snapshot of the item before the change.

onItemRemoved

public void onItemRemoved(EventContext context,
                          java.lang.String itemKey,
                          org.json.JSONObject previousItemData)

This callback is invoked when SyncMap item has been removed.

Parameters:

context - Context indicating if change was local or remote.

itemKey - Key of the item that has been removed.

previousItemData - Snapshot of the item immediately prior deletion.

onCollectionRemoved

public void onCollectionRemoved(EventContext context)

This callback is invoked when the entire SyncMap has been removed.

Parameters:

context - Context indicating if change was local or remote.

onErrorOccurred

public void onErrorOccurred(ErrorInfo error)

This callback is invoked when a SyncMap operation has encountered a error in local request.

Parameters:

error - Error description.

dispose

public void dispose()