Device Web Page APIs

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



DeviceWebPage Entity

The DeviceWebPage entity has the following properties:

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

  • AccountId int:(read only) The identifier of the account that owns the DeviceWebPage instance.

  • Name string: The user-defined name of the DeviceWebPage 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 contents.

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

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

  • Presentations List<PresentationContent>:(read only) A list of PresentationContent entity-relations denoting parent Presentations.

Device Web Page Management Web Methods

PagedList<WebPage> GetDeviceWebPages(int marker, int pageSize)

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

Required Permissions

None

Parameters

  • marker int: The identifier of the last DeviceWebPage instance on the previous page. If this value is negative, 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> GetSpecifiedDeviceWebPages(int[] webPageIds)

Retrieves a list of DeviceWebPage instances matching the specified identifiers. The identifiers of nonexistent DeviceWebPage instances will be ignored.

Required Permissions

None

Parameters

  • deviceWebPageIds int[]: An array of Id int values for the DeviceWebPage instances being requested. The number of items is limited on the server side. 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> FindDeviceWebPages(string namePattern, int marker, int pageSize)

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

None

Parameters

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

  • marker int: The Id int of the last DeviceWebPage instance on the previous page. If the integer is not positive, 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.

DeviceWebPage GetDeviceWebPage(int webPageId, bool loadAssets)

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

Required Permissions

Web Page: View Web Pages

Parameters

  • deviceWebPageId int: The identifier and primary key of the DeviceWebPage 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.

DeviceWebPage GetDeviceWebPageByName(string name, bool loadContent)

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

Required Permissions

None

Parameters

  • name string: The user-defined Name of the DeviceWebPage 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 Device Web Page.

bool CheckDeviceWebPageName(string name)

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

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

Required Permissions

None

Parameters

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

bool CheckDeviceWebPageUsage(int liveTextFeedId)

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

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

Required Permissions

None

Parameters

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

bool CheckDeviceWebPageUsageByName(string name)

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

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

Required Permissions

None

Parameters

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

bool RenameDeviceWebPage(int webPageId, string newName)

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

Required Permissions

None

Parameters

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

bool DeleteDeviceWebPages(int[] webPageIds)

Deletes the specified DeviceWebPage 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

None

Parameters

  • deviceWebPageIds int[]: An array of Id int values for the DeviceWebPage instances to be deleted. The number of items is limited on the server side. Attempting to request more than the maximum allowed number of objects will cause an error. Passing an empty array or Device Web Page identifiers that don’t exist will lead to an immediate empty response without an error.

ON THIS PAGE