...
- [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 PresentationInfo structures that denote 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.
...
Retrieves the next page of the LiveTextFeed list, sorted by [string] Name. The returned list will contain no more items than the defined page size.
...
List<LiveTextFeed> GetSpecifiedLiveTextFeeds(int[] liveTextFeedIds)
Retrieves a list of LiveTextFeed instances matching the specified identifiers, sorted by [string] Name. The identifiers of nonexistent LiveTextFeed instances will be ignored.
...
Retrieves the next page of a LiveTextFeed list containing names matched with the specified pattern. The returned list is organized by [string] Name and may not contain more items than the defined page size.
...
LiveTextFeed GetLiveTextFeed(int liveTextFeedId, bool loadContent)
Retrieves a single LiveTextFeed instance with the specified [int] Id. This method returns Null if the LiveTextFeed instance with the specified identifier does not exist.
...
LiveTextFeed GetLiveTextFeedByName(string name, bool loadContent)
Retrieves the LiveTextFeed instance with the specified [string] Name. This method returns Null if the LiveTextFeed instance with the specified name does not exist.
...
bool CheckLiveTextFeedUsage(int liveTextFeedId)
Determines whether the LiveTextFeed instance (specified by its primary key) is referenced by one or more presentations. This method returns True if the LiveTextFeed instance has parent dependencies.
Note that when using this method to check whether a LiveTextFeed instance can be deleted, a False status may change in the time between calling this method and calling DeleteLiveTextFeed().
Required Permissions
Live Text Feed: View Live Text Feed
...
bool CheckLiveTextFeedUsageByName(string name)
Determines whether a LiveTextFeed instance (specified with its alternate, user-defined key) is referenced by one or more presentations. This method returns True if the LiveTextFeed instance has parent dependencies.
Note that when using this method to check whether a LiveTextFeed instance can be deleted, a False status may change in the time between calling this method and calling DeleteLiveTextFeed().
Required Permissions
Live Text Feed: View Live Text Feed
...
LiveTextFeed CreateLiveTextFeed(LiveTextFeed entity)
Creates a new LiveTextFeed instance and related RSS file with the specified [string] Name and LiveTextFeedItem[]] Items parameters. This method returns the created object with all initialized properties if successful. If an error occurs during the creation process, the method will return Null.
...
LiveTextFeed CloneLiveTextFeed(string feedUrl)
Creates a new LiveTextFeed instance and related RSS file using the name and key-value pairs copied from the specified external RSS URL. If successful, this method returns the newly created object with all initialized properties. If an error occurs during object creation, this method returns Null.
...
Updates the [string] Name and LiveTextFeedItem[]] Items parameters of the specified LiveTextFeed instance and related RSS file. This method returns True only if completely successful. Otherwise, it returns False.
...
Updates the [string] Name of the specified LiveTextFeed instance. This method returns True upon success and False upon failure.
...
bool DeleteLiveTextFeeds(int[] liveTextFeedIds)
Deletes the specified LiveTextFeed instance(s) and related RSS file(s) in both the database and persistent storage. This method returns True only if completely successful. Otherwise, it returns False.
...