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.
Attributes | Name and Description |
---|---|
|
caplin.streamlink.RecordType3Event()
|
Attributes | Name and Description |
---|---|
|
void
deleteAllEntries()
* Indicates whether all type 3 entries should be deleted. |
|
void
getFields()
* Returns the record fields relating to the event, as a collection of key-value pairs. |
►
caplin.streamlink.RecordType3Event()
►
void
deleteAllEntries()
*
Indicates whether all type 3 entries should be deleted.
* @returns {boolean} true if all entries should be deleted, otherwise false.
►
void
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