com.twilio.sync

Class SyncStreamObserver

java.lang.Object

com.twilio.sync.SyncStreamObserver

public abstract class SyncStreamObserver
extends java.lang.Object

Observer for all operations on a SyncStream. You should create your own subclass of StreamObserver and override functions you are interested in. Observer will receive callbacks for all operations on a SyncStream. 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
SyncStreamObserver() 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 SyncStream operation has encountered a error in local request.
void	onMessagePublished(EventContext context, SyncStream.Message message) This callback is invoked when SyncStream has successfully published a message.
void	onOpened(SyncStream syncStream) This callback is invoked when SyncStream object has been initialised and opened locally.
void	onRemoved(EventContext context) This callback is invoked when the SyncStream has been removed.

Methods inherited from class java.lang.Object

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

Constructor Detail

SyncStreamObserver

public SyncStreamObserver()

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(SyncStream syncStream)

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

Parameters:

syncStream - SyncStream object that has been opened. This parameter you should take and use as your initialised instance of a stream.

onRemoved

public void onRemoved(EventContext context)

This callback is invoked when the SyncStream has been removed.

Parameters:

context - Context indicating if change was local or remote.

onMessagePublished

public void onMessagePublished(EventContext context,
                               SyncStream.Message message)

This callback is invoked when SyncStream has successfully published a message.

Parameters:

context - Context indicating if change was local or remote.

message - Snapshot of the received message.

onErrorOccurred

public void onErrorOccurred(ErrorInfo error)

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

Parameters:

error - Error description.

dispose

public void dispose()