VideoOS.ConfigurationAPI Namespace Reference

Namespaces

namespace  ConfigurationFaultException
 

Classes

class  ConfigurationItem
 A class that contains information for one item. It may also contain a number of children that are filled or not filled initially depending on what type of item it is. Typically a ConfigurationItem contains enough information to be displayed in a list or treeview, identify it for further processing and the key properties own directly on this item. When getting a list of ConfigurtionItem’s, the list will most often not contain any children, indicated by property ChildrenFilled == false. If more detail information is required, a program should recursively iterate through the ConfigurationItems and get missing children. The ItemType field contains the type of Item, as defined in ItemTypes – for example ItemType.Camera for a camera device. If the ConfigurationItem is an item that can be disabled/enabled, the EnableProperty will contain a EnablePropertyInfo class with a few detailed fields. A ConfigurationItem can also be a grouping item. If so, the ItemCategory field will identify it as ItemCategories.Group. This is an internal group and not something you create, but a logical grouping of settings. One sample of this is how the detailed settings for a camera is divided into multiple groups, much like the tabs are constructed in the Corporate Management Client. More...
 
class  EnablePropertyInfo
 This property resides on a ConfigurationItem.EnableProperty to define if the entire ConfigurationItem is enabled or not. More...
 
class  ErrorResult
 Identifies one field that has errors and identifines the message to show. More...
 
interface  IConfigurationService
 
class  InvokeHandling
 
class  InvokeInfoProperty
 The property keys defined here are used on the ConfigurationItem returned on the Invoke call, when the ItemType is InvokeInfo, and InvokeResult. More...
 
class  InvokeInfoStates
 Define the valid values of the State property when a InvokeResult is returned from the server. More...
 
class  ItemCategories
 Defines possible categories of a ConfigurationItem. More...
 
class  ItemFilter
 Defines how to filter for a specific ItemType. More...
 
class  ItemTypes
 
class  MessageHeaderToken
 
class  MethodInfo
 Contains information for displaying a Method as a contextmenu item or a button.
The individual ConfigurationItems contains a list of MethodId's that refer to the MethodId on this class. More...
 
class  Property
 All properties are stored on the ConfigurationItem.Properties array in the format of this class. More...
 
class  PropertyFilter
 Defines how to filter for a specific ItemType. More...
 
class  TokenHelper
 Class to assist in providing a token to be inserted in the SOAP header - on client side, And a method to be called when the server side needs to validate the token. More...
 
class  TokenMessageInspector
 
class  TokenServiceBehavior
 A class to assist on inserting a token on the client side, and pick out the token on the server side. The application code must provide a TokenHelper class to perform the token handling. More...
 
class  ToolOptionIds
 Defines id's used for the tool options system settings. More...
 
class  UIHints
 Provide a hint of how a client with user interface should place a property in relation to the previous property. More...
 
class  UIImportance
 Defines relevant values for the Property.UIImportance field. More...
 
class  ValidateResult
 Is returned upon a Validation method. More...
 
class  ValueTypeInfo
 This class assist in defining what values are valid for a given property. More...
 
class  ValueTypeInfoNames
 Defines common know Names for the ValueTypeInfo class used by Property class. More...
 
class  ValueTypes
 Defines the base set of known types available in the Property Value field.
If a server decides to add new types, all clients need to be updated, not updated clients should tread unknown ValueType as StringType. More...
 

Enumerations

enum  EnableFilter { All = 0 , Enabled = 1 , Disabled = 2 }
 Used for defining how filter on the Enable setting. More...
 
enum  Operator {
  Equals = 0 , NotEquals = 1 , LessThan = 2 , GreaterThan = 3 ,
  Contains = 4 , BeginsWith = 5
}
 Used for defining how filter values are compared. More...
 

Enumeration Type Documentation

◆ EnableFilter

Used for defining how filter on the Enable setting.

Enumerator
All 

Get all items, regardless of Enabled setting.

Enabled 

Get all items that are enabled.

Disabled 

GEt all items that are disabled.

◆ Operator

Used for defining how filter values are compared.

Enumerator
Equals 
NotEquals 
LessThan 
GreaterThan 
Contains 
BeginsWith