VideoOS.Platform.ConfigurationItems.ServerTask Class Reference

Represent a task that is running on the server. More...

Inheritance diagram for VideoOS.Platform.ConfigurationItems.ServerTask:

Public Member Functions
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
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

Represent a task that is running on the server.

Member Function Documentation

ExecuteDefault()

ServerTask VideoOS.Platform.ConfigurationItems.ServerTask.ExecuteDefault ( )

inline

Will execute the first available method. Can be called when multiple steps are involved in changing values in the properties.

ExecuteMethod()

ServerTask VideoOS.Platform.ConfigurationItems.ServerTask.ExecuteMethod ( string methodId )

inline

Execute the provided method. The method id must be one of the defined values in the Methods property.

Parameters

methodId

Returns

GetProperty()

string VideoOS.Platform.ConfigurationItems.ServerTask.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.ServerTask.GetPropertyKeys ( )

inline

Gets a collection of all available property keys.

Returns

GetTask()

void VideoOS.Platform.ConfigurationItems.ServerTask.GetTask ( string path )

inline

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

Parameters

path

GetValueTypeInfoList()

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

inline

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

Parameters

propertyKey

Returns

SetProperty()

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

inline

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

Parameters

key
content

UpdateState()

void VideoOS.Platform.ConfigurationItems.ServerTask.UpdateState ( )

inline

Calls the server to get the fields updated, when the progress is < 100.

ValidateItem()

ValidateResult VideoOS.Platform.ConfigurationItems.ServerTask.ValidateItem ( )

inline

Validate the current content.

Returns

Property Documentation

ErrorCode

String VideoOS.Platform.ConfigurationItems.ServerTask.ErrorCode

get

If state is Error the ErrorCode explains what went wrong.

ErrorText

String VideoOS.Platform.ConfigurationItems.ServerTask.ErrorText

get

When state is Error the ErrorState TBD.

ItemType

string VideoOS.Platform.ConfigurationItems.ServerTask.ItemType

get

Returns the ItemType of the underlayng ConfigurationItem, usually InvokeResult or InvokeInfo.

Methods

Collection<string> VideoOS.Platform.ConfigurationItems.ServerTask.Methods

get

The available methods for this task.

Path

string VideoOS.Platform.ConfigurationItems.ServerTask.Path

get

The path of an item, when relevant. Usually available after adding a ConfigurationItem.

Progress

int VideoOS.Platform.ConfigurationItems.ServerTask.Progress

get

Defines the progress of the server task. When Progress is 100, or state is Success or Error - the task is complete.

To get this field updated, call the Update method, and recheck the fields.

State

StateEnum VideoOS.Platform.ConfigurationItems.ServerTask.State

get

Defines the current state of this task.