VideoOS.Platform.ConfigurationItems.ClientSettings Class Reference

More...

Inheritance diagram for VideoOS.Platform.ConfigurationItems.ClientSettings:
VideoOS.Platform.ConfigurationItems.IConfigurationItem VideoOS.Platform.ConfigurationItems.IConfigurationChildItem

Public Member Functions

 ClientSettings (FQID fqid)
 Construct the class from a MIP FQID - note that not all configuration items have a corresponding FQID.
 
 ClientSettings (ServerId serverId, ConfigurationItem clientSettings)
 Construct the class from serverId of the Management Server that owns the configuration, and the already returned ConfigurationItem.
 
 ClientSettings (ServerId serverId, string path)
 Construct the class from serverId of the Management Server that owns the configuration, and the path of the item.
 
- Public Member Functions inherited from VideoOS.Platform.ConfigurationItems.IConfigurationItem
void ClearChildrenCache ()
 Clear the internal cache of children. Can be used to force a new set of children to be fetched from the server at next access.
 
ServerTask ExecuteMethod (string methodId)
 Execute the provided method. The method id must be one of the defined values in the Methods property.
 
void FillChildren (string[] itemTypes)
 Fill all children and grand-children - as long as the itemtype is contained in itemType parameter.
 
void FillChildren (string[] itemTypes, ItemFilter[] itemFilters)
 Fill all children and grand-children - as long as the itemtype is contained in itemType parameter and filters match. If multiple filters are defined for same itemtype, all must match for the item to be included ('and' operation).
If no filter is defined for an ItemType, then all items of that type is filled.
 
void Save ()
 Will save all updated values to server.
 
ValidateResult ValidateItem ()
 Validate the current content.
 
- Public Member Functions inherited from VideoOS.Platform.ConfigurationItems.IConfigurationChildItem
string GetProperty (string key)
 Return a property value as string, if key is not found the return value will be null.
 
ICollection< string > GetPropertyKeys ()
 Get a collection of all available property keys.
 
List< ValueTypeInfoGetValueTypeInfoList (string propertyKey)
 Get defined ValueTypeInfo for a given property. If no ValueTypeInfo is available, an empty list is returned.
 
void SetProperty (string key, string content)
 Sets the value of a property (all is string format here)
 
override string ToString ()
 Display the 'DisplayName' is the default ToString()
 

Properties

bool MulticastEnabled [get, set]
 Multicast enabled.
 
String Related [get, set]
 Related device paths. Comma separated list of device paths.
 
int Shortcut [get, set]
 Shortcut. Shortcut number to be used in clients. A number of 0 and higher to be used for keypad activation, and value of blank when not used - also represented as -1 in integer fields when not used.
 
bool ShortcutDefined [get, set]
 Indicate if a shortcut is defined, retruns true when value is 0 or above, and false when value is not defined.
 
- Properties inherited from VideoOS.Platform.ConfigurationItems.IConfigurationItem
Guid Guid [get]
 Returns the id property or part of the path, when available. When no id is available this will be Guid.Empty. This is relevant for some items of ItemCategory.ChildItem where no property with key = "Id" exists and path does not contains a guid.
 
Collection< string > Methods [get]
 The available methods for this class.
 
- Properties inherited from VideoOS.Platform.ConfigurationItems.IConfigurationChildItem
string Description [get, set]
 Description.
 
virtual string DisplayName [get]
 Name of this ConfigurationItem in user readable format. Usually the same as property with key = "Name".
 
string ItemCategory [get]
 Return the item category for this item. This can be used to understand how multiple items are fetched and saved together. Only ItemCategory == 'Item' can be saved.
 
string Name [get, set]
 Name.
 
string ParentItemPath [get]
 Get hold of the next real parent path, e.g. skip any 'Folder' type parent.
 
string ParentPath [get]
 The path for the parent of this ConfigurationItem.
 
string Path [get]
 The identification of this item.

 
ServerId ServerId [get, set]
 Contains the ServerId of the Management Server holding this item.
 

Detailed Description

Constructor & Destructor Documentation

◆ ClientSettings() [1/3]

VideoOS.Platform.ConfigurationItems.ClientSettings.ClientSettings ( ServerId serverId,
ConfigurationItem clientSettings )
inline

Construct the class from serverId of the Management Server that owns the configuration, and the already returned ConfigurationItem.

Parameters
serverIdIdentify the Management Server that owns the configuration
clientSettingsThe ConfigurationItem returned from elsewhere
Exceptions
ArgumentMIPExceptionWhen LoginSettings not found for serverId

◆ ClientSettings() [2/3]

VideoOS.Platform.ConfigurationItems.ClientSettings.ClientSettings ( ServerId serverId,
string path )
inline

Construct the class from serverId of the Management Server that owns the configuration, and the path of the item.

This construction will contact the server and read the specified item.

Parameters
serverIdIdentify the Management Server that owns the configuration
pathThe path of a specific item
Exceptions
MIPExceptionRepresents a number of possible exceptions. Possible exceptions can be found via the inherited exceptions - like PathNotFoundMIPException

◆ ClientSettings() [3/3]

VideoOS.Platform.ConfigurationItems.ClientSettings.ClientSettings ( FQID fqid)
inline

Construct the class from a MIP FQID - note that not all configuration items have a corresponding FQID.

This construction will contact the server and read the specified item.

Parameters
fqidIdentify the MIP item
Exceptions
MIPExceptionRepresents a number of possible exceptions. Possible exceptions can be found via the inherited exceptions - like PathNotFoundMIPException

Property Documentation

◆ MulticastEnabled

bool VideoOS.Platform.ConfigurationItems.ClientSettings.MulticastEnabled
getset

Multicast enabled.

◆ Related

String VideoOS.Platform.ConfigurationItems.ClientSettings.Related
getset

Related device paths. Comma separated list of device paths.

◆ Shortcut

int VideoOS.Platform.ConfigurationItems.ClientSettings.Shortcut
getset

Shortcut. Shortcut number to be used in clients. A number of 0 and higher to be used for keypad activation, and value of blank when not used - also represented as -1 in integer fields when not used.

◆ ShortcutDefined

bool VideoOS.Platform.ConfigurationItems.ClientSettings.ShortcutDefined
getset

Indicate if a shortcut is defined, retruns true when value is 0 or above, and false when value is not defined.