StreamLink.NET  7.1.5-7.1.5-3946-4e293d0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Pages
Properties | List of all members
Caplin.StreamLink.IDataEvent Interface Reference

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. More...

Inheritance diagram for Caplin.StreamLink.IDataEvent:
Caplin.StreamLink.IChatEvent Caplin.StreamLink.IContainerEvent Caplin.StreamLink.IDirectoryEvent Caplin.StreamLink.IJsonEvent Caplin.StreamLink.INewsEvent Caplin.StreamLink.IPageEvent Caplin.StreamLink.IPermissionEvent Caplin.StreamLink.IRecordType1Event Caplin.StreamLink.IRecordType2Event Caplin.StreamLink.IRecordType3Event Caplin.StreamLink.IStoryEvent

Properties

bool IsImage [get]
 Returns whether this was an image event or an update event. More...
 
string Subject [get]
 Returns the subject to which the event relates. More...
 

Detailed Description

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 com.caplin.streamlink.RecordType1Event interface is derived from IDataEvent; it provides information about changes to a subscribed subject of type record, including the fields that have changed and their new values.

See Also
IChatEvent, IContainerEvent, INewsEvent, IPermissionEvent, IRecordType1Event, IRecordType2Event, IRecordType3Event, IStoryEvent

Property Documentation

bool Caplin.StreamLink.IDataEvent.IsImage
get

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.
  • true if this event contains all data for the subject (an "image"), false if the event contains only some of the data (an "update").
string Caplin.StreamLink.IDataEvent.Subject
get

Returns the subject to which the event relates.

  • the subject

Generated on Tue Mar 24 2020 11:57:49 for StreamLink.NET