Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JsonEvent

name

JsonEvent

Hierarchy

Index

Methods

getJson

  • getJson(): any
  • Returns the complete JSON object (patches applied) as created by the user defined JsonHandler (specified in the configuration).

    Returns any

    the JSON object (the type of this object is platform specific and depends on the JsonHandler configured).

getJsonString

  • getJsonString(): string
  • Returns the JSON string (initial image or patch) relating to the event.

    Returns string

    the JSON 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