Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RecordType1Event

name

RecordType1Event

Hierarchy

Index

Methods

getFields

  • 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 {}

    the fields

    • [key: string]: string

getLatency

  • getLatency(timeStampField: string): number
  • Gets the latency of the record in milliseconds. StreamLink calculates the latency using the clock offset and the timestamp supplied in the timeStampField field of the record.

    The latency cannot be calculated if timeStampField is not present in the record or if the clock offset has not yet been established.

    Parameters

    • timeStampField: string

      The name of the field in the record containing the timestamp that StreamLink uses to calculate the latency of the record.

    Returns number

    The latency of the record in milliseconds, or -1 if the latency cannot be calculated.

getSubject

  • getSubject(): string
  • Returns the subject to which the event relates.

    Returns string

    the subject

getTimeReceived

  • getTimeReceived(): number
  • Returns the time that the record data in the event was received at the client.

    Returns number

    The time that the record data was received at the client in milliseconds since 1 January 1970 00:00:00 UTC.

isImage

  • isImage(): boolean
  • 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 boolean

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

Generated using TypeDoc