Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StoryEvent

name

StoryEvent

Hierarchy

Index

Methods

Methods

getSubject

  • getSubject(): string

  • Returns the subject to which the event relates.

    Returns string

    the subject

getText

  • getText(): string

  • Returns the story text relating to the event.

    Returns string

    The story text chunk for this event.

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