...
- [int] Id:(read only) The identifier and primary key of the WebPage instance.
- [string] Name: The user-defined name of the WebPage instance. This alternate key must be unique in the scope of the BrightSign Network account.
- [string] PhysicalPath:(read only) The external URL of the HTML file in persistent storage.
- [long] FileSize:(read only) The size of the associated HTML file in bytes.
- [string] FileHash:(read only) A SHA1 hash of the associated HTML file content.
- [DateTime] UploadDate:(read only) A UTC timestamp indicating when the Web Page was uploaded to the BrightSign Network.
- [WebPageAsset[]] Assets: 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.
- [PresentationInfo[]] Presentations:(read only) An array of PresentationInfo structures denoting presentations that are currently utilizing the WebPage instance.
...
The WebPageAsset entity-relation represents the association between a WebPage instance and a Content instance. It has the following properties:
...
The PresentationContent entity-relation represents the association between a Presentation instance and a Content instance. It has the following properties:
...
Retrieves the next page of the WebPage list, sorted by [string] Name. The returned list will contain no more items than the defined page size.
...
List<WebPage> GetSpecifiedWebPages(int[] webPageIds)
Retrieves a list of WebPage instances matching the specified identifiers, sorted by [string] Name. The identifiers of nonexistent WebPage instances will be ignored.
...
Retrieves the next page of a WebPage 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.
...
WebPage GetWebPage(int webPageId, bool loadAssets)
Retrieves a single WebPage instance with the specified [int] Id. This method returns Null if the WebPage instance with the specified identifier does not exist.
...
WebPage GetWebPageByName(string name, bool loadContent)
Retrieves the WebPage instance with the specified [string] Name. This method returns Null if the WebPage instance with the specified name does not exist.
...
Determines whether the specified WebPage entity [string] Name is currently in use. This method returns True if a Web Page with the specified name currently exists.
...
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
...
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
...
Updates the [string] Name of the specified WebPage instance. This method returns True upon success and False upon failure.
...
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.
...