PreEmptive Analytics .NET API  1.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | List of all members
PreEmptive.Analytics.Common.IPlatform Interface Reference

Interface to define platform specific methods. More...

Inherits PreEmptive.Analytics.Common.IAsyncProvider.

Public Member Functions

IXMLTransmitter CreateXMLTransmitter ()
 Creates a platform specific IXMLTransmitter. More...
 
AgentInfo GetAgentInfo ()
 Populates an AgentInfo object with platform specific data. More...
 
HostInfo GetHostInfo ()
 Populates an HostInfo object with platform specific data. More...
 
OSInfo GetOSInfo ()
 Gets information about the operating system the application is running on. More...
 
UserInfo GetUserInfo ()
 Gets information about the user running the application. More...
 
string GetDefaultEndpoint ()
 Retrieves the endpoint string. More...
 
IList< StackInfoGetStackInfo (Exception exception)
 Parses the stack information from the provided exception. More...
 
IList< ComponentInfoGetComponentInfo ()
 Retrieves information about the components that make up the application. More...
 
ISettingsStore GetSettingsStore ()
 Retrieves the interface describing a mechanism for persisting string values tied to string keys. More...
 
SystemInfo GetSystemInfo (bool fulldata)
 Retrieves information about they system the application is running on. More...
 
PerformanceInfo GetPerformanceInfo (bool fulldata)
 Retrieves performance information about the application. More...
 
IOfflineDataStore GetOfflineDataStore ()
 Retrieves the OfflineDataStore that defines how offline messages should be handled on the given platform. More...
 
Configuration.ApplicationStopBehavior GetStopBehaviorDefaults ()
 Gets the default ApplicationStopBehavior values appropriate for the platform Implementors can just forward this to PlatformClient.CoreDefaultStopBehavior() if no particular stop behavior is needed. More...
 
- Public Member Functions inherited from PreEmptive.Analytics.Common.IAsyncProvider
void ExecuteAsyncIfSupported (Action action, bool highPriority=false)
 Execute action asynchronously on another thread. This should create a new thread, not use the ThreadPool unless there are no other options. The API makes use of both ThreadPool and this method. This method is used when a long-running thread will be started, or the thread needs to be started as quickly as possible and/or with higher priority More...
 

Detailed Description

Interface to define platform specific methods.

Member Function Documentation

IXMLTransmitter PreEmptive.Analytics.Common.IPlatform.CreateXMLTransmitter ( )

Creates a platform specific IXMLTransmitter.

Returns
A platform specific IXMLTransmitter
AgentInfo PreEmptive.Analytics.Common.IPlatform.GetAgentInfo ( )

Populates an AgentInfo object with platform specific data.

Returns
The new AgentInfo object.
IList<ComponentInfo> PreEmptive.Analytics.Common.IPlatform.GetComponentInfo ( )

Retrieves information about the components that make up the application.

Returns
A list of information about the components.
string PreEmptive.Analytics.Common.IPlatform.GetDefaultEndpoint ( )

Retrieves the endpoint string.

Returns
The endpoint string.
HostInfo PreEmptive.Analytics.Common.IPlatform.GetHostInfo ( )

Populates an HostInfo object with platform specific data.

Returns
The new HostInfo object.
IOfflineDataStore PreEmptive.Analytics.Common.IPlatform.GetOfflineDataStore ( )

Retrieves the OfflineDataStore that defines how offline messages should be handled on the given platform.

Returns
The object defining how to handle offline data.
OSInfo PreEmptive.Analytics.Common.IPlatform.GetOSInfo ( )

Gets information about the operating system the application is running on.

Returns
A new OSInfo object.
PerformanceInfo PreEmptive.Analytics.Common.IPlatform.GetPerformanceInfo ( bool  fulldata)

Retrieves performance information about the application.

Parameters
fulldataDetermines if information that takes significant time to gather should be included.
Returns
The retrieved information about the application.
ISettingsStore PreEmptive.Analytics.Common.IPlatform.GetSettingsStore ( )

Retrieves the interface describing a mechanism for persisting string values tied to string keys.

Returns
The interface describing a mechanism for persisting string values tied to string keys.
IList<StackInfo> PreEmptive.Analytics.Common.IPlatform.GetStackInfo ( Exception  exception)

Parses the stack information from the provided exception.

Parameters
exceptionThe Exception object.
Returns
The parsed stack information.
Configuration.ApplicationStopBehavior PreEmptive.Analytics.Common.IPlatform.GetStopBehaviorDefaults ( )

Gets the default ApplicationStopBehavior values appropriate for the platform Implementors can just forward this to PlatformClient.CoreDefaultStopBehavior() if no particular stop behavior is needed.

Returns
The stop behavior defaults for this platform
SystemInfo PreEmptive.Analytics.Common.IPlatform.GetSystemInfo ( bool  fulldata)

Retrieves information about they system the application is running on.

Parameters
fulldataDetermines if information that takes significant time to gather should be included.
Returns
The retrieved information about the system.
UserInfo PreEmptive.Analytics.Common.IPlatform.GetUserInfo ( )

Gets information about the user running the application.

Returns
A new UserInfo object.

The documentation for this interface was generated from the following file: