BrightSign Network Web API Reference Manual v.3.8 User Manual

Page 59

Advertising
background image

47

Required Permissions
Live Text Feed: View Live Text Feeds

Parameters

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

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

[int] pageSize: The maximum number of objects returned by the method. If the list of objects that match the
search criteria exceeds the

[int] pageSize 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)

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

Required Permissions
Live Text Feed: View Live Text Feed, View Contents

Parameters

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

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

Advertising