Live text feed, Livetextfeed entity, Livetextfeeditem entity-relation – BrightSign Network Web API Reference Manual v.3.8 User Manual
Page 56
44
LIVE TEXT FEED
LiveTextFeed Entity
The LiveTextFeed entity has the following properties:
•
[int] Id:(Read Only) The identifier and primary key of the LiveTextFeed instance.
•
[string] Name: The user-defined name of the LiveTextFeed instance. This alternate key must be unique in the
scope of the BSN account.
•
[string] PhysicalPath:(Read Only) The external URL of the associated RSS file in persistent storage.
•
[long] FileSize:(Read Only) The size of the associated RSS file in bytes.
•
[string] FileHash:(Read Only): A SHA1 hash of the associated RSS file contents.
•
[DateTime] CreationDate:(Read Only) A UTC timestamp indicating when the Live Text Feed was created in
the BrightSign Network.
•
[Dictionary<string,string>] Contents: A list of key-value pairs that make up the Live Text Feed. This
list is set to Null when not initialized by the server.
•
[PresentationInfo[]] Presentations:(Read Only) An array of
parent presentations.
•
[LiveTextFeedItem[]] Items: An array of LiveTextFeedItem entity-relations that reference individual items
within the Live Text Feed. This list is set to Null when not initialized by the server.
LiveTextFeedItem Entity-Relation
The LiveTextFeedItem entity-relation represents a single Live Text Feed item. It has the following properties:
•
[string] Title: The key (RSS item title) of the item in the associated Live Text Feed.
•
[string] Description: The value (RSS item description) of the item in the associated Live Text Feed.
•
[DateTime] ValidityStartDate: A value that determines the validity start date for the item (i.e. the point at
which the item will start being displayed in the Live Text Feed). A Null value determines that the item is valid from
the moment it is added to the Live Text Feed; this is the standard case for most items.