Live Text Feed APIs

Owned by BrightSign TechDocs
Last updated: Jun 28, 2023
7 min read

 

LiveTextFeed Entity

The LiveTextFeed entity has the following properties:

  • Id int:(read only) The identifier and primary key of the LiveTextFeed instance.

  • Name string: The user-defined name of the LiveTextFeed instance. This alternate key must be unique in the scope of the BSN account.

  • PhysicalPath string:(read only) The external URL of the associated RSS file in persistent storage.

  • FileSize long:(read only) The size of the associated RSS file in bytes.

  • FileHash string:(read only): A SHA1 hash of the associated RSS file contents.

  • CreationDate DateTime:(read only) A UTC timestamp indicating when the Live Text Feed was created in the BrightSign Network.

  • Contents Dictionary<string,string>: 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.

  • Presentations PresentationInfo[]:(read only) An array of PresentationInfo structures that denote parent presentations.

  • Items LiveTextFeedItem[]: 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:

  • Title string: The key (RSS item title) of the item in the associated Live Text Feed.

  • Description string: The value (RSS item description) of the item in the associated Live Text Feed.

  • ValidityStartDate DateTime: 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.

  • ValidityEndDate DateTime: A value that determines the validity end date for the associated item (i.e. the point at which the item will no longer be displayed in the Live Text Feed). A Null value determines that the item will be valid until it is removed from the Live Text Feed manually by the user; this is the standard case for most items.

Live Text Feed Management Web Methods

PagedList<LiveTextFeed> GetLiveTextFeeds(string marker, int pageSize)

Retrieves the next page of the LiveTextFeed list, sorted by Name string. The returned list will contain no more items than the defined page size.

Required Permissions

Live Text Feed: View Live Text Feeds

Parameters

  • marker string: The Name  string of the last LiveTextFeed instance on the previous page. If the value is Null, then the method will retrieve the first page.

  • pageSize int: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds the pageSize int limit, the returned list will indicate that it is truncated. If the integer is not positive, then the method will return the maximum allowed number of objects. Attempting to request more objects than is allowed will lead to the same result, but without an error.

List<LiveTextFeed> GetSpecifiedLiveTextFeeds(int[] liveTextFeedIds)

Retrieves a list of LiveTextFeed instances matching the specified identifiers, sorted by Name string. The identifiers of nonexistent LiveTextFeed instances will be ignored.

Required Permissions

Live Text Feed: View Live Text Feeds

Parameters

  • liveTextFeedIds int[]: An array of Id int values for the LiveTextFeed instances being requested. The number of returned items is limited to 100 by the server. Attempting to request more than the maximum allowed number of objects will cause an error, while passing an empty array will lead to an immediate empty response without an error.

PagedList<LiveTextFeed> FindLiveTextFeeds(string namePattern, string marker, int pageSize)

Retrieves the next page of a LiveTextFeed list containing names matched with the specified pattern. The returned list is organized by Name string and may not contain more items than the defined page size.

Required Permissions

Live Text Feed: View Live Text Feeds

Parameters

  • namePattern string: The exact Name string of the LiveTextFeed instance (or its wildcard-based pattern). Supported wildcards currently include “*”, “?”, and “[‘and’]”.

  • marker string: The Name string of the last LiveTextFeed instance on the previous page. If the value is Null, then the method will retrieve the first page.

  • pageSize int: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds the pageSize int limit, the returned list will indicate that it is truncated. If the integer is not positive, then the method will return the maximum allowed number of objects. Attempting to request more objects than is allowed will lead to the same result, but without an error.

LiveTextFeed GetLiveTextFeed(int liveTextFeedId, bool loadContent)

Retrieves a single LiveTextFeed instance with the specified Id int. This method returns Null if the LiveTextFeed instance with the specified identifier does not exist.

Required Permissions

Live Text Feed: View Live Text Feed, View Contents

Parameters

  • liveTextFeedId int: The identifier and primary key of the LiveTextFeed instance to be retrieved.

  • loadContent bool: A flag specifying whether the method should also initialize and return the items (i.e. key value pairs) of the Live Text Feed.

LiveTextFeed GetLiveTextFeedByName(string name, bool loadContent)

Retrieves the LiveTextFeed instance with the specified Name string. This method returns Null if the LiveTextFeed instance with the specified name does not exist.

Required Permissions

Live Text Feed: View Live Text Feed, View Contents

Parameters

  • name string: The user-defined Name of the LiveTextFeed instance to be retrieved

  • loadContent bool: A flag specifying whether the method should also initialize and return the items (i.e. key value pairs) of the Live Text Feed.

bool CheckLiveTextFeedName(string name)

Determines whether the specified Live Text Feed Name string is currently in use. This method returns True if a Live Text Feed with the specified name currently exists.

Note that when using this method to check whether a LiveTextFeed instance can be created, a False status may change in the time between calling this method and calling CreateLiveTextFeed().

Required Permissions

None

Parameters

  • name string: The Live Text Feed Name value to be evaluated.

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

Parameters

  • liveTextFeedId int: The identifier and primary key of the LiveTextFeed instance to evaluate. If a LiveTextFeed instance with the specified Id int does not exist, this method will return False without an error.

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

Parameters

  • name string: The user-defined name of the LiveTextFeed instance to evaluate. If a LiveTextFeed instance with the specified Name string does not exist, this method will return False without an error.

LiveTextFeed CreateLiveTextFeed(LiveTextFeed entity)

Creates a new LiveTextFeed instance and related RSS file with the specified Name string and Items  LiveTextFeedItem[] 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.

A descriptive error will be returned if the key strings in the key-value pairs are not unique or if the number of key-value pairs in the object instance surpasses the limit defined on the server.

Required Permissions

Live Text Feed: Create Live Text Feed

Parameters

  • entity LiveTextFeed: A LiveTextFeed object instance with initialized Name and Items  parameters. All other properties will be ignored during object creation. If this parameter is set to Null, then the method will immediately return Null without an error. A descriptive error will be returned to the client if the LiveTextFeed name is more than 50 characters or if another LiveTextFeed instance has the same name.

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.

A descriptive error will be returned if the key strings in the key-value pairs are not unique or if the number of key-value pairs in the new object instance surpasses the limit defined on the server.

Required Permissions

Live Text Feed: Create Live Text Feed

Parameters

  • feedUrl string: An external URL of a publicly available RSS feed. The RSS Title will be used as the LiveTextFeed instance name and the RSS title-description pairs will converted to key-value pairs. If this parameter is Null or invalid, then the method will immediately return Null without an error. This method will return a descriptive error if the string length of the RSS channel title, plus the “Copy ({index}) of” prefix, exceeds 50 characters.

bool UpdateLiveTextFeed(LiveTextFeed entity)

Updates the Name string and Items LiveTextFeedItem[] parameters of the specified LiveTextFeed instance and related RSS file. This method returns True only if completely successful. Otherwise, it returns False.

A descriptive error will be returned if the key strings in the key-value pairs are not unique or if the number of key-value pairs in the object instance surpasses the limit defined on the server.

Required Permissions

Live Text Feed: View Live Text Feed

Parameters

  • entity LiveTextFeed: A LiveTextFeed object instance containing the Id int of the instance to update, as well as the new Name string and Items LiveTextFeedItem[] parameters for the updated instance. If this parameter is Null or invalid, then the method will immediately return Null without an error. A descriptive error will be returned if any of the following conditions occur:

    • The Id int does not correspond to an existing LiveTextFeed instance.

    • The length of the specified LiveTextFeed instance Name string exceeds 50 characters.

    • The specified Name string is currently in use by another LiveTextFeed instance.

    • The key strings in the key-value pairs are not unique.

    • The number of key-value pairs in the object instance surpasses the limit defined on the server.

bool RenameLiveTextFeed(int liveTextFeedId, string newName)

Updates the Name string of the specified LiveTextFeed instance. This method returns True upon success and False upon failure.

Required Permissions

Live Text Feed: Update Live Text Feed, Rename Live Text Feed

Parameters

  • LiveTextFeedId int: The identifier and primary key of the LiveTextFeed instance. If a LiveTextFeed instance with the specified identifier does not exist, the method will return False without an error.

  • newName string: A new Name parameter for the specified LiveTextFeed instance. A descriptive error will be returned if the new Name string is greater than 50 characters.

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.

Required Permissions

Live Text Feed: Delete Live Text Feed

Parameters

  • liveTextFeedIds int[]: An array of Id int values for the LiveTextFeed instances to be deleted. The number of requested items is limited to 100 by the server. Attempting to request more than the maximum allowed number of objects will cause an error. An error will also be returned if an Id int parameter does not correspond to an existing LiveTextFeed instance. Passing an empty array or Live Text Feed identifiers that don't exist will lead to an immediate empty response without an error.

ON THIS PAGE