|
| | AlarmDefinition (FQID fqid) |
| | Construct the class from a MIP FQID - note that not all configuration items have a corresponding FQID.
|
| |
| | AlarmDefinition (ServerId serverId, ConfigurationItem alarmDefinition) |
| | Construct the class from serverId of the Management Server that owns the configuration, and the already returned ConfigurationItem.
|
| |
| | AlarmDefinition (ServerId serverId, string path) |
| | Construct the class from serverId of the Management Server that owns the configuration, and the path of the item.
|
| |
| void | ClearChildrenCache () |
| | Clear the internal cache of children. Can be used to force a new set of children to be fetched from the server at next access.
|
| |
| ServerTask | ExecuteMethod (string methodId) |
| | Execute the provided method. The method id must be one of the defined values in the Methods property.
|
| |
| void | FillChildren (string[] itemTypes) |
| | Fill all children and grand-children - as long as the itemtype is contained in itemType parameter.
|
| |
| void | FillChildren (string[] itemTypes, ItemFilter[] itemFilters) |
| | Fill all children and grand-children - as long as the itemtype is contained in itemType parameter and filters match. If multiple filters are defined for same itemtype, all must match for the item to be included ('and' operation).
If no filter is defined for an ItemType, then all items of that type is filled.
|
| |
| void | Save () |
| | Will save all updated values to server.
|
| |
| ValidateResult | ValidateItem () |
| | Validate the current content.
|
| |
| string | GetProperty (string key) |
| | Return a property value as string, if key is not found the return value will be null.
|
| |
| ICollection< string > | GetPropertyKeys () |
| | Get a collection of all available property keys.
|
| |
| List< ValueTypeInfo > | GetValueTypeInfoList (string propertyKey) |
| | Get 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)
|
| |
| override string | ToString () |
| | Display the 'DisplayName' is the default ToString()
|
| |
|
| bool | AssignableToAdmins [get, set] |
| | Alarm assignable to Administrators. Select this to include users with an administrator role in the Assigned to list.
|
| |
| bool | AutoClose [get, set] |
| | Auto-close alarm: . Defines if an alarm should be closed automatically upon reception of a specific message from save source.
|
| |
| String | Category [get, set] |
| | Alarm category. Sets the category of the alarm. Valid options are defined in the Management Client.. Valid values are available in the CategoryValues property dictionary.
|
| |
| Dictionary< string, string > | CategoryValues [get] |
| | A list of valid names/values for the Category property.
|
| |
| String | DisableEventList [get, set] |
| | Disabling events. When enable rule is 'by events', then this property contains the events that will disable the alarm.
|
| |
| bool | Enabled [get, set] |
| | Indicate if this item is active in the VMS system, e.g. enabled.
|
| |
| String | EnableEventList [get, set] |
| | Enabling events. When enable rule is 'by events', then this property contains the events that will enable the alarm (but does not create any alarm).
|
| |
| String | EnableRule [get, set] |
| | Enable rule. Defines when the alarm can be triggered. Options are: Always, by TimeProfile or by events. When TimeProfile is defined the TimeProfile property must contain a valid TimeProfile path, when enabled by events then both EnablingEvents and DisablingEvents must be defined.. Valid values are available in the EnableRuleValues property dictionary.
|
| |
| Dictionary< string, string > | EnableRuleValues [get] |
| | A list of valid names/values for the EnableRule property.
|
| |
| String | EventType [get, set] |
| | Triggering event type. Defines the type of event that should trigger an alarm, when received from the source defined.. Valid values are available in the EventTypeValues property dictionary.
|
| |
| String | EventTypeGroup [get, set] |
| | Triggering event group. Defines a group of events in the same area. Valid values are available in the EventTypeGroupValues property dictionary.
|
| |
| Dictionary< string, string > | EventTypeGroupValues [get] |
| | A list of valid names/values for the EventTypeGroup property.
|
| |
| Dictionary< string, string > | EventTypeValues [get] |
| | A list of valid names/values for the EventType property.
|
| |
| string | Id [get] |
| | ID.
|
| |
| String | ManagementTimeoutEventList [get, set] |
| | Operator timeout events triggered. If operator action is required within a specific time, this property defines what event to fire if no action was taken within the time specified in the ManagementTimeoutTime property.
|
| |
| string | ManagementTimeoutTime [get, set] |
| | Operator action time limit. If operator action is required within a specific time, the time is defined here. Format is like: HH:mm.ss. Valid values are the same as defined in the Management Client, e.g. 1 minute, 5 minutes etc. Default is 1 minute.
|
| |
| String | MapType [get, set] |
| | Alarm manager view. Valid values are available in the MapTypeValues property dictionary.
|
| |
| Dictionary< string, string > | MapTypeValues [get] |
| | A list of valid names/values for the MapType property.
|
| |
| string | Owner [get, set] |
| | Owner. Defines the initial owner. Should be formatted as Identity.ToString() does, like 'John Doe (Acme/JD)'.
|
| |
| String | Priority [get, set] |
| | Priority. Sets the priority. Can be High, Medium, Low. Valid values are available in the PriorityValues property dictionary.
|
| |
| Dictionary< string, string > | PriorityValues [get] |
| | A list of valid names/values for the Priority property.
|
| |
| String | RelatedCameraList [get, set] |
| | Related cameras. The list of additional cameras to associate with the alarm. The list is a comma separated set of Paths.
|
| |
| String | RelatedMap [get, set] |
| | Related map. Defines what map to show in the alarm manager, when alarm is selected.. Valid values are available in the RelatedMapValues property dictionary.
|
| |
| Dictionary< string, string > | RelatedMapValues [get] |
| | A list of valid names/values for the RelatedMap property.
|
| |
| bool | RequireCommentOnClose [get, set] |
| | Require comment on close. Specifies whether a comment must be given when closing an alarm.
|
| |
| bool | RequireReasonOnClose [get, set] |
| | Require reason on close. Specifies whether a reason must be given when closing an alarm.
|
| |
| String | SourceList [get, set] |
| | Sources. Defines the source(s) the event is coming from. To define that all sources of a given type will trigger the alarm, use the folder format like: '/CameraFolder'.
|
| |
| String | TimeProfile [get, set] |
| | Time profile. Defines what TimeProfile to be used when checking when the alarm is enabled. Property is only valid when EnableRule is set to TimeProfile.
|
| |
| String | TriggerEventlist [get, set] |
| | Events triggered by alarm. Defines a list of events to trigger when alarm is created. List is a comma separated set of Paths.
|
| |
| Guid | Guid [get] |
| | Returns the id property or part of the path, when available. When no id is available this will be Guid.Empty. This is relevant for some items of ItemCategory.ChildItem where no property with key = "Id" exists and path does not contains a guid.
|
| |
| Collection< string > | Methods [get] |
| | The available methods for this class.
|
| |
| string | Description [get, set] |
| | Description.
|
| |
| virtual string | DisplayName [get] |
| | Name of this ConfigurationItem in user readable format. Usually the same as property with key = "Name".
|
| |
| string | ItemCategory [get] |
| | Return the item category for this item. This can be used to understand how multiple items are fetched and saved together. Only ItemCategory == 'Item' can be saved.
|
| |
| string | Name [get, set] |
| | Name.
|
| |
| string | ParentItemPath [get] |
| | Get hold of the next real parent path, e.g. skip any 'Folder' type parent.
|
| |
| string | ParentPath [get] |
| | The path for the parent of this ConfigurationItem.
|
| |
| string | Path [get] |
| | The identification of this item.
|
| |
| ServerId | ServerId [get, set] |
| | Contains the ServerId of the Management Server holding this item.
|
| |
Public Member Functions inherited from VideoOS.Platform.ConfigurationItems.IConfigurationItem