com.twilio.sync

Class MapObserver

java.lang.Object

com.twilio.sync.MapObserver

public abstract class MapObserver
extends java.lang.Object

Observer for all operations on a Map. You should create your own subclass of MapObserver and override functions you are interested in. Observer will receive callbacks for all operations on a Map. 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
MapObserver() 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 Map has been removed.
void	onErrorOccurred(ErrorInfo error) This callback is invoked when a Map operation has encountered a error in local request.
void	onItemAdded(EventContext context, Map.Item itemSnapshot) This callback is invoked when Map item has been added.
void	onItemRemoved(EventContext context, java.lang.String itemKey, org.json.JSONObject prevDataSnapshot) This callback is invoked when Map item has been removed.
void	onItemUpdated(EventContext context, Map.Item itemSnapshot, org.json.JSONObject prevItemSnapshot) This callback is invoked when Map item has been updated.
void	onOpened(Map map) This callback is invoked when Map 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

MapObserver

public MapObserver()

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(Map map)

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

Parameters:

map - Map 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,
                        Map.Item itemSnapshot)

This callback is invoked when Map item has been added.

Parameters:

context - Context indicating if change was local or remote.

itemSnapshot - Snapshot of the item that was added.

onItemUpdated

public void onItemUpdated(EventContext context,
                          Map.Item itemSnapshot,
                          org.json.JSONObject prevItemSnapshot)

This callback is invoked when Map item has been updated.

Parameters:

context - Context indicating if change was local or remote.

itemSnapshot - Snapshot of the item after the change.

prevItemSnapshot - Snapshot of the item before the change.

onItemRemoved

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

This callback is invoked when Map item has been removed.

Parameters:

context - Context indicating if change was local or remote.

itemKey - Key of the item that has been removed.

prevDataSnapshot - Snapshot of the item immediately prior deletion.

onCollectionRemoved

public void onCollectionRemoved(EventContext context)

This callback is invoked when the entire Map 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 Map operation has encountered a error in local request.

Parameters:

error - Error description.

dispose

public void dispose()