Home | Class Index
Class
caplin.streamlink

RecordType3Event

Extends caplin.streamlink.DataEvent.

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

The RecordType3Event will be provided on a onRecordType3Update callback to a caplin.streamlink.SubscriptionListener.

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.

Constructor Summary

Attributes Name and Description
caplin.streamlink.RecordType3Event()

Method Summary

Attributes Name and Description
boolean deleteAllEntries()

Indicates whether all type 3 entries should be deleted.
Object getFields()

Returns the record fields relating to the event, as a collection of key-value pairs.
Methods inherited from class caplin.streamlink.DataEvent:
getSubject, isImage

Constructor Detail

► caplin.streamlink.RecordType3Event()

Method Detail

► boolean deleteAllEntries()

Indicates whether all type 3 entries should be deleted.

Returns
{boolean} true if all entries should be deleted, otherwise false.

► Object getFields()

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.

Returns
{Object} the fields