com.caplin.streamlink

Interface DataEvent

All Known Subinterfaces:

ChatEvent, ContainerEvent, DirectoryEvent, NewsEvent, PageEvent, PermissionEvent, RecordType1Event, RecordType2Event, RecordType3Event, StoryEvent

public interface DataEvent

Provides access to fundamental information about subscription events relating to changes in data, such as the subject and the type of event that has occurred.

In application code, use the derived interfaces that related to specific types of data, rather than this base-level interface. For example RecordType1Event interface is derived from DataEvent; it provides information about changes to a subscribed subject of type record, including the fields that have changed and their new values.

See Also:

ChatEvent, ContainerEvent, NewsEvent, PermissionEvent, RecordType1Event, RecordType2Event, RecordType3Event, StoryEvent

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getSubject() Returns the subject to which the event relates.
boolean	isImage() Returns whether this was an image event or an update event.

Method Detail

getSubject

java.lang.String getSubject()

Returns the subject to which the event relates.

Returns:

the subject

isImage

boolean isImage()

Returns whether this was an image event or an update event.

If this method returns true, all data for the subject is contained within this event; you should therefore clear the application's caches of any current data for the subject of this event before refreshing them with the new data.

Returns:

true if this event contains all data for the subject (an "image"), false if the event contains only some of the data (an "update").