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
void getDateTime()

*

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

*

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

*

Returns the headline for this update.
void 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

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

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

► void getHeadline()

*

Returns the headline for this update.

* @returns {String} The headline.

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