Caplin.DataSource.Messaging.News.INewsMessage Interface Reference

An instance of INewsMessage defines the headline text that provides a brief description of a news story (see Caplin.DataSource.Messaging.Story). More...

Inheritance diagram for Caplin.DataSource.Messaging.News.INewsMessage:

Properties
string	Headline [get]
	The headline of the news message. More...
string	NewsDateTime [get]
	The date and time that the headline was created. More...
string	Permission [get, set]
	Gets or sets a permission string relating to this news message. More...
string	StoryReference [get, set]
	A reference that identifies the story associated with the headline. More...
IList< string >	Tags [get]
	A set of keywords or terms that describe the news item. More...
string	this[string fieldName] [get, set]
	Gets or sets a specified field. More...
Properties inherited from Caplin.DataSource.Messaging.IMessage
bool	Image [get, set]
	Gets or sets a boolean value indicating whether this IMessage represents an image or an update. More...
string	Subject [get]
	Gets the subject of this message. More...

Detailed Description

An instance of INewsMessage defines the headline text that provides a brief description of a news story (see Caplin.DataSource.Messaging.Story).

An object implementing this interface cannot be instantiated directly, but can be constructed using the Caplin.DataSource.Messaging.IMessageFactory that is available on the Caplin.DataSource.Publisher.IPublisher interface

If this INewsMessage has a corresponding story for the headline, the Caplin.DataSource.Messaging.News.INewsMessage.StoryReference property should be set to uniquely identify that story. The Caplin.DataSource.Messaging.News.INewsMessage.NewsDateTime property should be set to indicate the date and time that the headline was created. Record in the Caplin.DataSource.Messaging.News.INewsMessage.Tags property any keywords that can be used to locate the story in a search result.

Property Documentation

string Caplin.DataSource.Messaging.News.INewsMessage.Headline

get

The headline of the news message.

string Caplin.DataSource.Messaging.News.INewsMessage.NewsDateTime

get

The date and time that the headline was created.

string Caplin.DataSource.Messaging.News.INewsMessage.Permission

getset

Gets or sets a permission string relating to this news message.

The permission string.

Liberator can use the contents of this property to determine whether this headline should be sent to a client.

string Caplin.DataSource.Messaging.News.INewsMessage.StoryReference

getset

A reference that identifies the story associated with the headline.

IList<string> Caplin.DataSource.Messaging.News.INewsMessage.Tags

get

A set of keywords or terms that describe the news item.

string Caplin.DataSource.Messaging.News.INewsMessage.this[string fieldName]

getset

Gets or sets a specified field.

Field value

If the field does not exist in the News headline message, this index operator adds it, otherwise using the index operator will update the value of the field.