The ININ.IceLib.Statistics namespace contains classes for watching and listening to Interaction Center statistics.
There are a number of classes within the ININ.IceLib.Statistics namespace that provide support to the classes mentioned in the preceding summary. Examples of the supporting classes are enumerations, event argument classes, and delegates used by events within classes.
The StatisticCatalog can be used to watch statistics. This watch will provide the details about the definition of the statistic, such as units, precision, name, and description. The StatisticListener can be used to listen to statistic values. This will retrieve the current value of the statistic of interest and send out events when that value changes.
 Note |
|---|
| For more information on getting started with statistics see Getting Started With Statistics. |
| Note |
|---|
| For for the list of available statistics see Statistics Catalog. |
Examples
The IceLib SDK includes example application references to the ININ.IceLib.Statistics namespace. Some examples are listed below.
| Project | Location |
|---|---|
| TutorialExample | SystemStatisticsViewModel.cs, line 102, in SystemStatisticsViewModel.StartWatchingCatalogCompleted |
| SystemStatisticsViewModel.cs, line 64, in SystemStatisticsViewModel.SessionConnectionStateChanged | |
| SystemStatisticsViewModel.cs, line 130, in SystemStatisticsViewModel.StatisticListenerStatisticValueUpdated | |
| SystemStatisticsViewModel.cs, line 30, in SystemStatisticsViewModel.#ctor | |
| SystemStatisticsViewModel._StatisticsManager | |
| SystemStatisticsViewModel._StatisticCatalog | |
| SystemStatisticsViewModel._StatisticListener | |
| SystemStatisticsViewModel._SystemStatistics | |
| StatisticCatalogViewModel.cs, line 153, in StatisticCatalogViewModel.SessionConnectionStateChanged | |
| StatisticCatalogViewModel.cs, line 61, in StatisticCatalogViewModel.set_SelectedStatisticCategory | |
| StatisticCatalogViewModel.cs, line 30, in StatisticCatalogViewModel.#ctor | |
| StatisticCatalogViewModel.cs, line 236, in StatisticCatalogViewModel.StartWatchingCompleted | |
| StatisticCatalogViewModel.cs, line 46, in StatisticCatalogViewModel.set_AvailableStatisticCategories | |
| StatisticCatalogViewModel.cs, line 134, in StatisticCatalogViewModel.set_StatisticDefinitions | |
| StatisticViewModel.cs, line 26, in StatisticViewModel.SetStatisticValue | |
| StatisticViewModel.cs, line 9, in StatisticViewModel.#ctor | |
| StatisticViewModel._StatisticValue | |
| StatisticViewModel._StatisticKey |
Classes
| Class | Description | |
|---|---|---|
 | AssociatedParameterSetDefinition |
A collection of associated parameter types that define a valid parameter set for querying or watching a
statistic value.
|
| AssociatedParameterSetQuery |
Defines a query for AssociatedParameterSetValues that match a AssociatedParameterSetDefinition.
|
| AssociatedParameterSetQueryEventArgs |
Details for an event notifying of a change to the results for a watched AssociatedParameterSetQuery.
|
| AssociatedParameterSetValue |
Values for a set of associated parameter types.
|
| DetailedParameterValue | ParameterValue with additional display string and description.
|
| DrillDown |
Represents a drill down lookup. If this data is present, additional
drill down data is present and can be queried with GetDrillDownData(Session, String).
|
| DrillDownData |
Represents additional statistical information that can be retrieved via
the drill down process. See DrillDown for how to access
this data.
|
| DrillDownDataEntry |
Represents a collection of data for a specified drill down.
|
| FilteredParameterQuery |
Represents a query to retrieve a filtered list of the available values for a given parameter type.
|
| ParameterQuery |
Represents a query to list the available values for a given parameter type.
ParameterQuery is used in ExecuteQuery(ParameterQuery) to define
what is being queried.
|
| ParameterQueryCompletedEventArgs |
Provides data for asynchronous completed events of ParameterValuesDepot.
|
| ParameterQueryResult |
Represents the results from ExecuteQuery(ParameterQuery).
|
| ParameterType |
Defines the type of a parameter.
|
| ParameterTypeDefinition |
Represents additional details for a ParameterType object.
|
| ParameterTypeId |
The ID value of a ParameterType.
|
| ParameterValue |
Represents a parameter type and its value.
A statistic parameter helps define which specific statistic is being dealt with. For example,
an alert can be setup to trigger for a queue. Using a parameter, that alert can be defined
to only apply to specific members of a workgroup.
|
| ParameterValueEventArgs |
Provides data for the ParameterValuesDepot changed, added and removed events.
|
| ParameterValueKeyedCollection |
Represents an ordered keyed collection of parameter types and their values.
|
| ParameterValuesDepot |
Represents a watched object used to query the valid parameters when making statistic values requests.
|
| RequiredParametersDefinition |
Details information about the required parameter types that define a valid parameter set for a statistic value.
|
| StatisticBoolValue |
The StatisticValue for statistics with data type.
|
| StatisticCatalog |
Gateway to the definitions of available IC statistics.
|
| StatisticCatalogChangedEventArgs |
Provides data for for the StatisticCatalogChanged event.
This contains a list of objects that have been added or removed and a list of all
objects that have changed.
|
| StatisticCategory |
Specific constants identifying a grouping of statistic definitions.
|
| StatisticDefinition |
Represents information about an IC statistic.
|
| StatisticDoubleValue |
The StatisticValue for statistics with data type.
|
| StatisticDurationValue |
The StatisticValue for statistics with data type.
|
| StatisticFiniteDurationValue |
The StatisticValue for statistics with a data type that can be fixed or actively increasing.
|
| StatisticFutureDurationValue |
The StatisticValue for statistics with data type that is duration until something will happen.
|
| StatisticIdentifier |
Identifies a statistic.
|
| StatisticIntValue |
The StatisticValue for statistics with data type.
|
| StatisticKey |
Identifies a specific statistic value of interest.
|
| StatisticKeyTemplate |
Represents a class to manipulate the contents of a StatisticKey.
|
| StatisticListener |
Represents a watched object to query for IC statistics and listen for updates to those statistics.
|
| StatisticPercentValue |
The StatisticValue for statistics with percentage values represented as a data type.
|
| StatisticsManager |
Provides access to statistics.
|
| StatisticStatusMessageKeyValue |
The StatisticValue for statistics with a time in status data type. Defines the length of time
in status.
|
| StatisticStringValue |
The StatisticValue for statistics with data type.
|
| StatisticTimeDurationValue |
The StatisticValue for statistics with data type that is duration since something happened.
|
| StatisticTimeStampValue |
The StatisticValue for statistics with data type.
|
| StatisticValue |
Represents an abstract class statistic values are based on.
|
| StatisticValueUpdatedEventArgs |
Provides data for StatisticValueUpdated event.
|
| ValidateAssociatedParameterSetCompletedEventArgs | |
| ValidatedAssociatedParameterSetValue |
Represents an ordered set of ValidatedDetailedParameterValue.
|
| ValidatedDetailedParameterValue |
Represents the details for a ParameterValue from a request to validate a set of
associated parameter values.
|
Delegates
| Delegate | Description | |
|---|---|---|
 | ParameterValuesDepot..::..ParameterQueryCompletedEventHandler |
Represents the method that will handle the completed callback for an ExecuteQueryAsync(ParameterQuery, EventHandler<(Of <<'(ParameterQueryCompletedEventArgs>)>>), Object) operation.
|
Enumerations
| Enumeration | Description | |
|---|---|---|
 | BoundValueType |
Represents the type of boundary conditions a statistic may have.
|
| ParameterQueryResultStatus |
Represents the status of a ParameterQueryResult.
|
| StatisticDefinitionFlags |
Additional flags that may be set to modify a statistic definition.
|
| StatisticErrorValueType |
Represents the error type of a statistic.
|
| StatisticUnits |
Defines the measurement units of a StatisticValue.
|
| StatisticValueType |
Represents the value type of a statistic.
|
Version Information
Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
