...
- [int] Id:(read only) The identifier and primary key of the Group instance.
- [string] Name: The user-defined name of the Group instance. This is an alternate key and must be unique within the scope of the account.
- [DateTime] CreationDate:(read only) A UTC timestamp indicating when the Group instance was created within the BrightSign Network.
- [string] MinAutorunVersion:(read only) The minimum version of device autorun required to play presentations scheduled for the Group instance.
- string] HD9XXFirmware: The minimum version of device firmware required to play presentations for the HD970 model.
- [string] HDx10Firmware: The minimum version of device firmware required to play presentations for the following player models: HD210w, HD1010, HD1010w.
- [string] HDx20Firmware: The minimum version of device firmware required to play presentations for the following player models: AU320, HD220, HD1020.
- [string] HDx22Firmware: The minimum version of device firmware required to play presentations for the following player models: HD222, HD1022.
- [string] XDx30Firmware: The minimum version of device firmware required to play presentations for the following player models: XD230, XD1030, XD1230.
- [string] XDx32Firmware: The minimum version of device firmware required to play presentations for the following player models: XD232, XD1032, XD1132.
- [string] 4Kx42Firmware: The minimum version of device firmware required to play presentations for the following player models: 4K242, 4K1042, 4K1142.
- [bool] EnableSerialDebugging: A flag specifying whether serial debugging should be enabled for all players assigned to the Group instance.
- [bool] EnableSystemLogDebugging: A flag specifying whether system log debugging should be enabled for all players assigned to the Group instance.
- [int] DevicesCount:(read only) An integer indicating the number of players assigned to the Group instance.
- [bool] EnableStorageSpaceLimit: A flag specifying whether the player storage will be divided into different segments. This allows the user to allot maximum sizes to different segments to ensure that a certain type of data does not take up too much space on the storage device.
- [StorageSpaceLimitUnit] StorageSpaceLimitUnits: A StorageSpaceLimitUnit enumeration specifying whether the following limits are measured in percentages or megabytes.
- [ushort] PublishedDataSizeLimit: The maximum size allotted to all presentation and content files that are written to the storage device during the publish process. This includes audio, video, images, text, and HTML content files.
- [ushort] DynamicDataSizeLimit: The maximum size of all dynamic content, including Dynamic Playlists and MRSS feeds. When this segment runs out of space, dynamic content files will be deleted to create space, starting with the oldest files first.
- [ushort] HtmlDataSizeLimit: The maximum size of the HTML application cache.
- [ushort] HtmlLocalStorageSizeLimit: The maximum size of all JavaScript variables and data.
- [List<Device>] Devices:(read only) A list of Device entities that are assigned to the current group.
- [PresentationInfo[]]Presentations:(read only) An array of PresentationInfo structures denoting presentations that are currently scheduled for the Group instance.
...
Description
Retrieves a list of Group instances matching the specified identifiers. The list is sorted by the [string] Name of the Group instances. The identifiers of nonexistent Group instances will be ignored.
...
Retrieves the next page of a Group 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.
...
Group GetGroup (int groupId, bool loadDevices)
Retrieves a single Group instance with the specified [int] Id. This method returns Null if he Group instance with the specified identifier does not exist.
...
- [int] groupId: The identifier and primary key of the Group instance to be retrieved.
- [bool] loadDevices: A flag specifying whether the method should also initialize and return a list of all Device instances that are assigned to the specified Group.
Group GetGroupByName(string name, bool loadContent)
Retrieves the Group instance with the specified [string] Name. This method returns Null if the Group instance with the specified name does not exist.
...
- [string] name: The user-defined Name of the Group instance to be retrieved.
- [bool] loadDevices: A flag specifying whether the method should also initialize and return a list of all Device instances that are assigned to the specified Group.
Group CreateGroup(Group entity)
Creates a new Group instance with the specified name and settings. If successful, this method will return a Group instance with all initialized properties. If an error occurs, the method will return Null.
...
bool UpdateGroup(Group entity)
Updates the specified Group instance using the values passed in the Group entity. This method returns True only if completely successful; otherwise, it will return False.
...
Updates one or more model firmware versions for devices associated with the specified Group instances. This method returns True upon success and False upon failure.
...
bool DeleteGroup(int groupId, int reassignmentGroupId)
Deletes the specified Group instance and assigns all devices within it to another specified Group instance. This method only returns True if completely successful. Otherwise, it returns False.
...