|
| 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.
|
| |
| 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.
|
| |
|
| string | Description [get, set] |
| | Description.
|
| |
| string | DiskPath [get, set] |
| | Path. Contains the path to the storage disk.
|
| |
| int | MaxSize [get, set] |
| | Max size (in MB). The maximum size of the recording storage in MB. The value have to be between 1 and 1099511627776 (1 exabyte). By default, the value is set to 1024, which is 1 GB.
|
| |
| string | Name [get, set] |
| | Name.
|
| |
| int | RetainMinutes [get, set] |
| | Retention time. The number of minutes that must elapse before data are deleted or archived. The value that specifies the retention period in minutes. The value have to be between 1 and 525600000 (365000 days). By default, the value is 1440, which is 1 day.
|
| |
| bool | Signing [get, set] |
| | Signing. Specifies if database should be signed.
|
| |
| 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.
|
| |
Public Member Functions inherited from VideoOS.Platform.ConfigurationItems.ServerTask