Bool updatelivetextfeed(livetextfeed entity) – BrightSign Network Web API Reference Manual v.3.8 User Manual

Page 63

Advertising
background image

51

Parameters

[string] feedUrl: 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)

Description
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.

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

[LiveTextFeed] entity: A LiveTextFeed object instance containing the [int] Id of the instance to update,
as well as the new

[string] Name and LiveTextFeedItem[]] Items 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:

o The [int] Id does not correspond to an existing LiveTextFeed instance.
o The length of the specified LiveTextFeed instance [string] Name exceeds 50 characters.
o The specified [string] Name is currently in use by another LiveTextFeed instance.
o The key strings in the key-value pairs are not unique.
o The number of key-value pairs in the object instance surpasses the limit defined on the server.

Advertising