Web Page APIs

Owned by BrightSign TechDocs
Last updated: Jun 29, 2023
6 min read

 

WebPage Entity

The WebPage entity has the following properties:

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

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

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

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

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

  • UploadDate DateTime:(read only) A UTC timestamp indicating when the Web Page was uploaded to the BrightSign Network.

  • Assets WebPageAsset[]: A list of WebPageAsset entity-relations that reference Content instances that are in use by the WebPage entity. The list is set to Null when not initialized by the server.

  • Presentations PresentationInfo[]:(read only) An array of PresentationInfo structures denoting presentations that are currently utilizing the WebPage instance.

WebPageAsset Entity-Relation

The WebPageAsset entity-relation represents the association between a WebPage instance and a Content instance. It has the following properties:

  • FileName string: The virtual name of the file represented by the associated Content instance.

  • RelativePath string:(read only) The relative path of the associated asset file in relation to the Web Page HTML file.

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

  • FileHash string:(read only) The SHA-1 hash of the associated asset file contents. The string is provided in the following format: "SHA1:{FileHash}".

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

PresentationContent Entity-Relation

The PresentationContent entity-relation represents the association between a Presentation instance and a Content instance. It has the following properties:

  • ContentId int:(read only) The identifier and primary key of the associated Content instance.

  • FileName string: The virtual name of the file represented by the current Content instance.

  • PresentationId int:(read only) The identifier and primary key of the associated Presentation instance.

  • PresentationName string:(read only) The user-defined name of the associated Presentation instance.

  • StateName string: The name of the presentation state that corresponds to the associated Content instance.

  • DisplayDuration TimeSpan: The amount of time that the device displays an associated image.

  • ContentTransition string: The screen effect that is shown during the transition between the previous presentation state and the current content state (i.e. the associated content state).

Web Page Management Web Methods

PagedList<WebPage> GetWebPages(string marker, int pageSize)

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

Required Permissions

Web Page: View Web Pages

Parameters

  • marker string: The Name string of the last WebPage 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<WebPage> GetSpecifiedWebPages(int[] webPageIds)

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

Required Permissions

Web Page: View WebPages

Parameters

  • webPageIds int[]: An array of Id int values for the WebPage 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<WebPage> FindWebPages(string namePattern, string marker, int pageSize)

Retrieves the next page of a WebPage 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

Web Page: View Web Pages

Parameters

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

  • marker string: The Name string of the last WebPage 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.

WebPage GetWebPage(int webPageId, bool loadAssets)

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

Required Permissions

Web Page: View Web Pages

Parameters

  • webPageId int: The identifier and primary key of the WebPage instance to be retrieved.

  • loadAssets bool: A flag specifying whether the method should also initialize and return a list of all assets currently being used by the Web Page.

WebPage GetWebPageByName(string name, bool loadContent)

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

Required Permissions

Web Page: View Web Pages

Parameters

  • name string: The user-defined Name of the WebPage instance to be retrieved. The length of the string is limited to 50 characters.

  • loadAssets bool: A flag specifying whether the method should also initialize and return a list of all assets currently being used by the Web Page.

bool CheckWebPageName(string name)

Determines whether the specified WebPage entity Name string is currently in use. This method returns True if a Web Page with the specified name currently exists.

Note that when using this method to check whether a Web Page can be uploaded, a False status may change after this method is called.

Required Permissions

None

Parameters

  • name string: The Web Page Name value to be evaluated.

bool CheckWebPageUsage(int liveTextFeedId)

Determines whether the WebPage instance (specified by its primary key) is referenced by one or more presentations. This method returns True if the WebPage instance has parent dependencies.

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

Required Permissions

Web Page: View Web Pages

Parameters

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

bool CheckWebPageUsageByName(string name)

Determines whether a WebPage instance (specified with its alternate, user-defined key) is referenced by one or more presentations. This method returns True if the WebPage instance has parent dependencies.

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

Required Permissions

Web Page: View Web Pages

Parameters

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

bool RenameWebPage(int webPageId, string newName)

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

Required Permissions

Web Page: Update Web Page, Rename Web Page

Parameters

  • webPageId int: The identifier and primary key of the WebPage instance. If a WebPage 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 WebPage instance. A descriptive error will be returned if the new Name string is greater than 50 characters.

bool DeleteWebPages(int[] webPageIds)

Deletes the specified WebPage instance(s) and related files in both the database and persistent storage. This method returns True only if the operation is completely successful. Otherwise, it returns False.

Required Permissions

Web Page: Delete Web Page

Parameters

  • webPageIds int[]: An array of Id int values for the WebPage instances to be deleted. The number of items is limited to 100 by the server. Attempting to request more than the maximum allowed number of objects will cause an error. Passing Web Page identifiers that don’t exist will also result in an error return. Passing an empty array will lead to an immediate empty response without an error.

ON THIS PAGE