VideoOS.Platform.ConfigurationItems.IConfigurationChildItem Class Reference

Contains fields relevant for a ConfiguratonItem with category = "ChildItem". More...

Inheritance diagram for VideoOS.Platform.ConfigurationItems.IConfigurationChildItem:

Public Member Functions
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< ValueTypeInfo >	GetValueTypeInfoList (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
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

Contains fields relevant for a ConfiguratonItem with category = "ChildItem".

Member Function Documentation

GetProperty()

string VideoOS.Platform.ConfigurationItems.IConfigurationChildItem.GetProperty ( string key )

inline

Return a property value as string, if key is not found the return value will be null.

Parameters

key

Returns

value or null

GetPropertyKeys()

ICollection< string > VideoOS.Platform.ConfigurationItems.IConfigurationChildItem.GetPropertyKeys ( )

inline

Get a collection of all available property keys.

Returns

GetValueTypeInfoList()

List< ValueTypeInfo > VideoOS.Platform.ConfigurationItems.IConfigurationChildItem.GetValueTypeInfoList ( string propertyKey )

inline

Get defined ValueTypeInfo for a given property. If no ValueTypeInfo is available, an empty list is returned.

Parameters

propertyKey

Returns

SetProperty()

void VideoOS.Platform.ConfigurationItems.IConfigurationChildItem.SetProperty ( string key, string content )

inline

Sets the value of a property (all is string format here)

Parameters

key
content

ToString()

override string VideoOS.Platform.ConfigurationItems.IConfigurationChildItem.ToString ( )

inline

Display the 'DisplayName' is the default ToString()

Returns

Property Documentation

Description

string VideoOS.Platform.ConfigurationItems.IConfigurationChildItem.Description

getset

Description.

DisplayName

virtual string VideoOS.Platform.ConfigurationItems.IConfigurationChildItem.DisplayName

get

Name of this ConfigurationItem in user readable format. Usually the same as property with key = "Name".

ItemCategory

string VideoOS.Platform.ConfigurationItems.IConfigurationChildItem.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.

Name

string VideoOS.Platform.ConfigurationItems.IConfigurationChildItem.Name

getset

Name.

ParentItemPath

string VideoOS.Platform.ConfigurationItems.IConfigurationChildItem.ParentItemPath

get

Get hold of the next real parent path, e.g. skip any 'Folder' type parent.

When called on a Camera, this method will return the path for the Hardware that contains the camera.

Returns

ParentPath

string VideoOS.Platform.ConfigurationItems.IConfigurationChildItem.ParentPath

get

The path for the parent of this ConfigurationItem.

Path

string VideoOS.Platform.ConfigurationItems.IConfigurationChildItem.Path

get

The identification of this item.

ServerId

ServerId VideoOS.Platform.ConfigurationItems.IConfigurationChildItem.ServerId

getset

Contains the ServerId of the Management Server holding this item.