Class NewsEvent

Name

NewsEvent

Hierarchy

Constructors

constructor

Methods

getDateTime getFields getHeadline getStoryCode getSubject isImage

Constructors

constructor

Methods

getDateTime

  • Returns the date/time associated with this headline update.

    The format of the date/time string is dependent on the implementation of the Integration Adapter that supplied the new headline. Generally it will be in a displayable format.

    Returns string

    The date/time stamp.

getFields

  • Returns all field/value pairs that were updated in this update.

    This data structure allows access to any additional information associated with the news headline update which aren't available directly.

    Returns {
        [key: string]: string;
    }

    A collection of field/value pairs.

    • [key: string]: string

getHeadline

  • Returns the headline for this update.

    Returns string

    The headline.

getStoryCode

  • Returns the story code associated with this update.

    The value of the code can be used to construct a news story subject to obtain the full text of the news item.

    Returns string

    The story code.

getSubject

  • Returns the subject to which the event relates.

    Returns string

    the subject

isImage

  • 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").

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc