AnalyticsMonitorFacade Class
Click or drag to resize
AnalyticsMonitorFacade Class

Note: This API is now obsolete.

Represents a simple facade for interacting with the Analytics Monitor. Use this facade interface instead of interacting more directly with the AnalyticsMonitorFactory and IAnalyticsMonitor interfaces for a slightly higher level interaction model.
Inheritance Hierarchy
SystemObject
  EQATEC.Analytics.MonitorAnalyticsMonitorFacade

Namespace: EQATEC.Analytics.Monitor
Assembly: EQATEC.Analytics.Monitor (in EQATEC.Analytics.Monitor.dll) Version: 3.2.1.0 (3.2.1)
Syntax
[ObsoleteAttribute("This static class is no longer support and will be removed in future versions. Please use the IAnalyticsMonitor directly by creating instances with the AnalyticsMonitorFactory methods")]
public static class AnalyticsMonitorFacade

The AnalyticsMonitorFacade type exposes the following members.

Methods
  NameDescription
Public methodStatic memberCreate(String)
Initializes the facade by creating a monitor with the given product id and the standard settings
Public methodStatic memberCreate(IAnalyticsMonitorSettings)
Initializes the facade by creating a monitor with the specified settings
Public methodStatic memberForceSync
Force a sync for manual synchronization. Mirrors the ForceSync call.
Public methodStatic memberSetInstallationInfo(String)
Sets the installation id for the current monitor. Mirrors the SetInstallationInfo(String) call
Public methodStatic memberSetInstallationInfo(String, IDictionaryString, String)
Public methodStatic memberStart
Public methodStatic memberStop
Public methodStatic memberStop(TimeSpan)
Stop the monitor. Mirrors the Stop(TimeSpan) method
Public methodStatic memberTrackException(Exception)
Track an exception. Mirrors the TrackException(Exception) method
Public methodStatic memberTrackException(Exception, String)
Track an exception along with a context message. Mirrors the TrackException(Exception, String) method
Public methodStatic memberTrackException(Exception, String, Object)
Public methodStatic memberTrackFeature
Register a feature usage. Mirrors the TrackFeature(String) method
Public methodStatic memberTrackFeatureCancel
Cancels an ongoing feature timing tracking. Mirrors the TrackFeatureCancel(String) method
Public methodStatic memberTrackFeatures
Public methodStatic memberTrackFeatureStart
Register the start of a feature usage. Mirrors the TrackFeatureStart(String) method
Public methodStatic memberTrackFeatureStop
Register the end of a feature usage stared by TrackFeatureStart(String).Mirrors the TrackFeatureStop(String) method
Public methodStatic memberTrackFeatureValue
Tracks a value on a named feature. Mirrors the TrackFeatureValue(String, Int64) method
Top
Properties
  NameDescription
Public propertyStatic memberStatus
Get the current capabilities of the wrapped monitor
Top
Remarks
The facade will instantiate a single IAnalyticsMonitor instance on the Create call and the remaining methods on this class mirror the methods found on the IAnalyticsMonitor interface. The facade can be used by consumers as a simple way of calling the API without worrying about passing the IAnalyticsMonitor instance around and about the timing issues of when the methods can be called. The facade will encapsulate the created instance, raise an exception for multiple calls to the Create(String) methods and will forward the methods on to the instance when it is available. If the facade represent too high level control or you would like to control the IAnalyticsMonitor instance yourself you should look at using the AnalyticsMonitorFactory methods. Repeated calls to the Create methods will raise exceptions as the intended use of the facade is for simple integration scenarios
Examples
This sample shows how to use AnalyticsMonitorFacade.
class MyClass 
{
  static void Main()
  {
    //Creating Analytics Monitor
    AnalyticsMonitorFacade.Create("YOUR_PRODUCT_KEY_HERE");

    //Start Analytics monitor
    AnalyticsMonitorFacade.Start();

    /*Your program here....*/

    //Stop Analytics monitor
    AnalyticsMonitorFacade.Stop();
  }
}
See Also