StreamLink.NET  6.2.10-3513-c11dd52
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Pages
Public Member Functions | Properties | List of all members
Caplin.StreamLink.IRecordType3Event Interface Reference

Provides information about a change to type 3 data in a record. More...

Inheritance diagram for Caplin.StreamLink.IRecordType3Event:
Caplin.StreamLink.IDataEvent

Public Member Functions

bool DeleteAllEntries ()
 Indicates whether all type 3 entries should be deleted. More...
 

Properties

IDictionary< string, string > Fields [get]
 Returns the record fields relating to the event, as a collection of key-value pairs. More...
 

Detailed Description

Provides information about a change to type 3 data in a record.

The RecordType3Event will be provided on a onRecordType3Update callback to a ISubscriptionListener.

Type 3 data stores the history of updates to the record. Each historic update is an entry in the record. A common use for records of this type is holding and viewing daily trade activity for an instrument.

Member Function Documentation

bool Caplin.StreamLink.IRecordType3Event.DeleteAllEntries ( )

Indicates whether all type 3 entries should be deleted.

true if all entries should be deleted, otherwise false.

Property Documentation

IDictionary<string,string> Caplin.StreamLink.IRecordType3Event.Fields
get

Returns the record fields relating to the event, as a collection of key-value pairs.

When a call to isImage() returns true, the subscription data event contains an image of the data for the subscribed item. All the fields comprising the record are present in the collection. The application must discard any values previously received and replace them with the values contained within the collection.

When a call to isImage() returns false, the subscription data event contains new data for the subscribed record. The values in the collection returned are an update to any values previously received and any application caches should be updated appropriately.

the fields


Generated on Thu Apr 27 2017 14:05:45 for StreamLink.NET