Classes | |
| class | AlarmCommandTokenClient |
| The alarm command token client is a WCF client used against XProtect Enterprice to handle alarms. VideoOS.Platform.Proxy.AlarmClient.IAlarmClient for a description of the available methods. Use VideoOS.Platform.Proxy.AlarmClient.AlarmClientManager whenever possible, to make sure the correct AlarmCommand version is constructed. More... | |
| class | AlarmFilter |
| The Alarm Filter is used to filter alarm lines. Alarm filter has conditions to filter by and order in which to return the alarm list. Ordering priority is done by position in the array. First position in the array has highest priority. The filter should use '[]' to wrap up special characters, otherwise special characters are treated as wildcard characters and will be removed from the database. More... | |
| class | AlarmHistory |
| Alarm history contains data reflecting a alarm change. The history contains the data fields that was changed, the time of the change and the user how did the change. The changes made to an alarm is normally done on alarm updates, and the data fields in the alarm histry object reflects this. More... | |
| class | AlarmLine |
| The alarm line is a subset of the alarm. The fields contained in the alarm line are also the fields which are searchable using the alarm filter VideoOS.Platform.Proxy.Alarm.AlarmFilter. More... | |
| class | AlarmSearchCriteria |
| class | AlarmServiceFault |
| The alarm service fault is thrown when a alarm action either is rejected or fails for some reason. More... | |
| class | AlarmUpdate |
| Alarm history update contains data reflecting a alarm change. The update contains the data key and value that was changed, the time of the change and the user how did the change. The changes made to an alarm is normally done on alarm updates. More... | |
| class | AlarmUpdateData |
| The alarm line is a subset of the alarm. The fields contained in the alarm line are also the fields which are searchable using the alarm filter VideoOS.Platform.Proxy.Alarm.AlarmFilter. More... | |
| class | Condition |
| The condition is used in the alarm filter to define the filter constains. Note: The value has to match the target object type. More... | |
| class | EventFilter |
| The Event Filter is used to filter event lines. Event filter has conditions to filter by and order in which to return the event list. Ordering priority is done by position in the array. First position in the array has highest priority. The filter should use '[]' to wrap up special characters, otherwise special characters are treated as wildcard characters and will be removed from the database. More... | |
| class | EventLine |
| The event line is a subset of the event. The fields contained in the event line are also the fields which are searchable using the event filter VideoOS.Platform.Proxy.Alarm.EventFilter. More... | |
| class | EventUpdateData |
| The event line is a subset of the alarm. The fields contained in the event line are also the fields which are searchable using the alarm filter VideoOS.Platform.Proxy.Alarm.AlarmFilter. More... | |
| interface | IAlarmCommandToken |
| interface | IAlarmCommandTokenChannel |
| class | NameNumberPairValue |
| class | OrderBy |
| Order by is used when defining a order of the filter result. More... | |
| class | Statistic |
| This class contains a alarm statistic. The statistic has a type VideoOS.Platform.Proxy.Alarm.StatisticType, a number which categorize the specific type and a value. An example could be a statistic containing StatisticType.State number = 4 has value = 100. which means that there is 100 alarms of state = 4. More... | |
Enumerations | |
| enum | AlarmFaultType : int { Unknown = 0 , DbRead = 1 , Read = 2 , DbConnection = 3 , Serialization = 4 , DbWrite = 5 , DbUpdate = 6 , InvalidAuthentication = 7 , UnknownSession = 8 } |
| The alarm fault type defines the reason of the alarm fault. More... | |
| enum | Operator : int { Equals = 0 , NotEquals = 1 , LessThan = 2 , GreaterThan = 3 , Contains = 4 , BeginsWith = 5 } |
| The operator is used in the filter conditions. More... | |
| enum | Order : int { Ascending = 0 , Descending = 1 } |
| Filter order defines in on which data field the resulting data is ordered. More... | |
| enum | StatisticType : int { Total = 0 , Priority = 1 , State = 2 , Unknown = 3 } |
| Enumerator defining the statistic type. More... | |
| enum | Target : int { LocalId = 0 , Id = 1 , State = 2 , Priority = 3 , Timestamp = 4 , SourceName = 5 , Name = 6 , AssignedTo = 7 , Type = 8 , RuleType = 9 , Location = 10 , Message = 11 , CustomTag = 12 , VendorName = 13 , ObjectValue = 14 , Description = 15 , ObjectId = 16 , Modified = 17 , PriorityName = 18 , Category = 19 , CategoryName = 20 , StateName = 21 , CameraId = 22 } |
| The target is the data field on which both the filter conditions and order by statements are constructed. More... | |
| enum VideoOS.Platform.Proxy.Alarm.AlarmFaultType : int |
| enum VideoOS.Platform.Proxy.Alarm.Operator : int |
| enum VideoOS.Platform.Proxy.Alarm.Order : int |
| enum VideoOS.Platform.Proxy.Alarm.StatisticType : int |
| enum VideoOS.Platform.Proxy.Alarm.Target : int |
The target is the data field on which both the filter conditions and order by statements are constructed.