VideoOS.Platform.ConfigurationItems.RemoveClientProfileServerTask Class Reference

Remove client profile. More...

Inheritance diagram for VideoOS.Platform.ConfigurationItems.RemoveClientProfileServerTask:
VideoOS.Platform.ConfigurationItems.ServerTask

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< ValueTypeInfoGetValueTypeInfoList (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 ItemSelection [get, set]
 Select profile to remove. Valid values are available in the ItemSelectionValues property dictionary.
 
Dictionary< string, string > ItemSelectionValues [get]
 A list of valid names/values for the ItemSelection property.
 
- 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

Remove client profile.

Member Function Documentation

◆ Execute()

ServerTask VideoOS.Platform.ConfigurationItems.RemoveClientProfileServerTask.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

◆ ItemSelection

String VideoOS.Platform.ConfigurationItems.RemoveClientProfileServerTask.ItemSelection
getset

Select profile to remove. Valid values are available in the ItemSelectionValues property dictionary.

◆ ItemSelectionValues

Dictionary<string, string> VideoOS.Platform.ConfigurationItems.RemoveClientProfileServerTask.ItemSelectionValues
get

A list of valid names/values for the ItemSelection property.