Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RecordType3Event

name

RecordType3Event

Hierarchy

Index

Methods

deleteAllEntries

  • deleteAllEntries(): boolean
  • Indicates whether all type 3 entries should be deleted.

    Returns boolean

    true if all entries should be deleted, otherwise false.

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

getSubject

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

    Returns string

    the subject

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