Home | Class Index
Class
caplin.streamlink

NewsEvent

Extends caplin.streamlink.DataEvent.

Provides information about a news headline update.

Constructor Summary

Attributes Name and Description
caplin.streamlink.NewsEvent()

Method Summary

Attributes Name and Description
String getDateTime()

Returns the date/time associated with this headline update.
Object getFields()

Returns all field/value pairs that were updated in this update.
String getHeadline()

Returns the headline for this update.
String getStoryCode()

Returns the story code associated with this update.
Methods inherited from class caplin.streamlink.DataEvent:
getSubject, isImage

Constructor Detail

► caplin.streamlink.NewsEvent()

Method Detail

► String 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.

► Object 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
{Object} A collection of field/value pairs.

► String getHeadline()

Returns the headline for this update.

Returns
{String} The headline.

► String 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.