Contains the result from a Hardware.UpdateHardware() call. More...

Inheritance diagram for VideoOS.Platform.ConfigurationItems.UpdateHardwareServerTask:

Public Member Functions
ServerTask	Execute ()
	Call this method to let the server execute when the properties have been updated. The returned ServerTask can be used to inspect the result.

Public Member Functions inherited from VideoOS.Platform.ConfigurationItems.ServerTask
ServerTask	ExecuteDefault ()
	Will execute the first available method. Can be called when multiple steps are involved in changing values in the properties.

ServerTask	ExecuteMethod (string methodId)
	Execute the provided method. The method id must be one of the defined values in the Methods property.

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

ICollection< string >	GetPropertyKeys ()
	Gets a collection of all available property keys.

void	GetTask (string path)
	Use this method once, when the InvokeResult has placed the task path in a property with another name than 'Path'.

List< ValueTypeInfo >	GetValueTypeInfoList (string propertyKey)
	Gets a list of 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)

void	UpdateState ()
	Calls the server to get the fields updated, when the progress is < 100.

ValidateResult	ValidateItem ()
	Validate the current content.

Properties
bool	AnyEventsUpdated `[get]`
	Indicate if any events on the hardware has changed.

string	HardwareName `[get]`
	Name of hardware being updated.

string	HardwarePath `[get]`
	Path of hardware beging updated.

long	SessionDataId `[get, set]`
	The ID is returned as result for 1. time call, and need to be used for 2. time call (The apply step)

ReadOnlyCollection< UpdateHardwareDetail >	UpdateHardwareDetails `[get]`
	Contains details for each device/item on the hardware.

Properties inherited from VideoOS.Platform.ConfigurationItems.ServerTask
String	ErrorCode `[get]`
	If state is Error the ErrorCode explains what went wrong.

String	ErrorText `[get]`
	When state is Error the ErrorState TBD.

string	ItemType `[get]`
	Returns the ItemType of the underlayng ConfigurationItem, usually InvokeResult or InvokeInfo.

Collection< string >	Methods `[get]`
	The available methods for this task.

string	Path `[get]`
	The path of an item, when relevant. Usually available after adding a ConfigurationItem.

int	Progress `[get]`
	Defines the progress of the server task. When Progress is 100, or state is Success or Error - the task is complete.

StateEnum	State `[get]`
	Defines the current state of this task.

Detailed Description

Contains the result from a Hardware.UpdateHardware() call.

Return value from the detection step will be a dataSessionId and a list of devices with detected changes Notice that Path value is incorrect for ADDED devices in this step. (Contains Guid.Empty)

Return value from the apply step will be a list of the changed devices/items

Member Function Documentation

◆ Execute()

ServerTask VideoOS.Platform.ConfigurationItems.UpdateHardwareServerTask.Execute ( )

inline

Call this method to let the server execute when the properties have been updated.
The returned ServerTask can be used to inspect the result.

Property Documentation

◆ AnyEventsUpdated

bool VideoOS.Platform.ConfigurationItems.UpdateHardwareServerTask.AnyEventsUpdated

get

Indicate if any events on the hardware has changed.

◆ HardwareName

string VideoOS.Platform.ConfigurationItems.UpdateHardwareServerTask.HardwareName

get

Name of hardware being updated.

◆ HardwarePath

string VideoOS.Platform.ConfigurationItems.UpdateHardwareServerTask.HardwarePath

get

Path of hardware beging updated.

◆ SessionDataId

long VideoOS.Platform.ConfigurationItems.UpdateHardwareServerTask.SessionDataId

getset

The ID is returned as result for 1. time call, and need to be used for 2. time call (The apply step)

◆ UpdateHardwareDetails

ReadOnlyCollection<UpdateHardwareDetail> VideoOS.Platform.ConfigurationItems.UpdateHardwareServerTask.UpdateHardwareDetails

get

Contains details for each device/item on the hardware.

Public Member Functions

Properties