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

The methods implemented by a Platform Specific Client, commonly called PAClient More...

Inherited by PreEmptive.Analytics.Common.PlatformClient.

Public Member Functions

bool ApplicationStart (ExtendedKeys keys=null, BinaryInfo binary=null, IFlowController flowController=null)
 Starts the client system if it has not yet been started and sends an application start message. More...
 
void ApplicationStop (ExtendedKeys keys=null, BinaryInfo binary=null, bool immediate=false)
 Stops the PreEmptive Analytics client. More...
 
void ApplicationStopSync (ExtendedKeys keys=null, BinaryInfo binary=null, bool immediate=false)
 Stops the PreEmptive Analytics client in a synchronous manner. More...
 
void ApplicationStopAsync (ExtendedKeys keys=null, BinaryInfo binary=null, bool immediate=false)
 Stops the PreEmptive Analytics client in an asynchronous manner. More...
 
void FeatureTick (string name, ExtendedKeys keys=null, Guid?session=null, BinaryInfo binary=null)
 Sends a message representing the occurrence of a feature. More...
 
void FeatureStart (string name, ExtendedKeys keys=null, Guid?session=null, BinaryInfo binary=null, Guid?group=null)
 Sends a message representing the start of a feature. More...
 
void FeatureStartWithGroup (string name, Guid group, ExtendedKeys keys=null, Guid?session=null, BinaryInfo binary=null)
 Sends a message representing the start of a feature. More...
 
void FeatureStopWithGroup (string name, Guid group, ExtendedKeys keys=null, Guid?session=null, BinaryInfo binary=null)
 Sends a message representing the stop of a feature. More...
 
void FeatureStop (string name, ExtendedKeys keys=null, Guid?session=null, BinaryInfo binary=null, Guid?group=null)
 Sends a message representing the stop of a feature. More...
 
void ReportException (ExceptionInfo exceptionInfo)
 Sends a message representing an exception. More...
 
void ReportException (ExceptionInfo exceptionInfo, ExtendedKeys keys, Guid?session=null, BinaryInfo binary=null)
 Sends a message representing an exception. More...
 
void ReportException (ExceptionInfo exceptionInfo, bool optInOverride, ExtendedKeys keys=null, Guid?session=null, BinaryInfo binary=null)
 Sends a message representing an exception. More...
 
void SystemProfile (ExtendedKeys keys=null, Guid?session=null, BinaryInfo binary=null)
 Sends a system profile message. More...
 
void PerformanceProbe (string name, ExtendedKeys keys=null, Guid?session=null, BinaryInfo info=null)
 Sends a message describing the performance of the device and the applicaion. More...
 
Guid NewFeatureGroup ()
 Used to get a new Guid for a feature group. More...
 
void SetSendDisabled (bool value)
 Disables or enables the sending of messages for the currently running Client. More...
 
void SendMessages ()
 Signals the Client to send all of the messages that are currently in the queue. More...
 
void SetSessionOptIn (bool value)
 Enables or disables the optIn setting for the currently running Client. More...
 
void ReportTamper (ExtendedKeys keys=null, Guid?session=null, BinaryInfo binary=null)
 Sends a message reporting that the application has been tampered with. More...
 
void ReportExpiration (Guid slid, ExtendedKeys keys=null, Guid?session=null, BinaryInfo binary=null)
 Sends a message reporting that the application's license has expired. More...
 
void ReportExpirationWarning (Guid slid, ExtendedKeys keys=null, Guid?session=null, BinaryInfo binary=null)
 Sends a message reporting that the user has been warned that the application's license is close to expiration More...
 

Properties

CoreClient Core [get]
 The underlying CoreClient instance used by the PlatformClient. More...
 

Detailed Description

The methods implemented by a Platform Specific Client, commonly called PAClient

Member Function Documentation

bool PreEmptive.Analytics.Common.IPlatformClient.ApplicationStart ( ExtendedKeys  keys = null,
BinaryInfo  binary = null,
IFlowController  flowController = null 
)

Starts the client system if it has not yet been started and sends an application start message.

Parameters
keysAn optional ExtendedKeys instance used to send additional information to the server.
binaryAn optional BinaryInfo instance used to send additional information about the caller of the method to the server.
flowControllerAn optional FlowController instance used to define the Client's interaction with the server.
Returns
Returns true if the request was accepted and the PA Client is now running.

Implemented in PreEmptive.Analytics.Common.PlatformClient.

void PreEmptive.Analytics.Common.IPlatformClient.ApplicationStop ( ExtendedKeys  keys = null,
BinaryInfo  binary = null,
bool  immediate = false 
)

Stops the PreEmptive Analytics client.

This method halts the client system and releases all connections and resources used by it. To continue interaction with the client system ApplicationStart() will need to be called again: all other requests to the Client will be ignored. If the client system is not currently running then the request is ignored.

Parameters
keysAn optional ExtendedKeys instance used to send additional information to the server.
binaryAn optional BinaryInfo instance used to send additional information about the caller of the method to the server.
immediateIf the API instance is configured for session extension, this can be used to immediately stop the API

Implemented in PreEmptive.Analytics.Common.PlatformClient.

void PreEmptive.Analytics.Common.IPlatformClient.ApplicationStopAsync ( ExtendedKeys  keys = null,
BinaryInfo  binary = null,
bool  immediate = false 
)

Stops the PreEmptive Analytics client in an asynchronous manner.

This method halts the client system and releases all connections and resources used by it. To continue interaction with the client system ApplicationStart() will need to be called again: all other requests to the Client will be ignored. If the client system is not currently running then the request is ignored.

Parameters
keysAn optional ExtendedKeys instance used to send additional information to the server.
binaryAn optional BinaryInfo instance used to send additional information about the caller of the method to the server.
immediateIf the API instance is configured for session extension, this can be used to immediately stop the API

Implemented in PreEmptive.Analytics.Common.PlatformClient.

void PreEmptive.Analytics.Common.IPlatformClient.ApplicationStopSync ( ExtendedKeys  keys = null,
BinaryInfo  binary = null,
bool  immediate = false 
)

Stops the PreEmptive Analytics client in a synchronous manner.

This method halts the client system and releases all connections and resources used by it. To continue interaction with the client system ApplicationStart() will need to be called again: all other requests to the Client will be ignored. If the client system is not currently running then the request is ignored.

Parameters
keysAn optional ExtendedKeys instance used to send additional information to the server.
binaryAn optional BinaryInfo instance used to send additional information about the caller of the method to the server.
immediateIf the API instance is configured for session extension, this can be used to immediately stop the API

Implemented in PreEmptive.Analytics.Common.PlatformClient.

void PreEmptive.Analytics.Common.IPlatformClient.FeatureStart ( string  name,
ExtendedKeys  keys = null,
Guid?  session = null,
BinaryInfo  binary = null,
Guid?  group = null 
)

Sends a message representing the start of a feature.

Parameters
nameA unique name for the feature.
keysAn optional ExtendedKeys instance used to send additional information to the server.
sessionA Guid defining the session for the Client.
binaryAn optional BinaryInfo instance used to send additional information about the caller of the method to the server.
groupA Guid representing the message group.

Implemented in PreEmptive.Analytics.Common.PlatformClient.

void PreEmptive.Analytics.Common.IPlatformClient.FeatureStartWithGroup ( string  name,
Guid  group,
ExtendedKeys  keys = null,
Guid?  session = null,
BinaryInfo  binary = null 
)

Sends a message representing the start of a feature.

Parameters
nameA unique name for the feature.
groupA Guid representing the message group.
keysAn optional ExtendedKeys instance used to send additional information to the server.
sessionA Guid defining the session for the Client.
binaryAn optional BinaryInfo instance used to send additional information about the caller of the method to the server.

Implemented in PreEmptive.Analytics.Common.PlatformClient.

void PreEmptive.Analytics.Common.IPlatformClient.FeatureStop ( string  name,
ExtendedKeys  keys = null,
Guid?  session = null,
BinaryInfo  binary = null,
Guid?  group = null 
)

Sends a message representing the stop of a feature.

Parameters
nameA unique name for the feature.
groupA Guid representing the message group.
keysAn optional ExtendedKeys instance used to send additional information to the server.
sessionA Guid defining the session for the Client.
binaryAn optional BinaryInfo instance used to send additional information about the caller of the method to the server.

Implemented in PreEmptive.Analytics.Common.PlatformClient.

void PreEmptive.Analytics.Common.IPlatformClient.FeatureStopWithGroup ( string  name,
Guid  group,
ExtendedKeys  keys = null,
Guid?  session = null,
BinaryInfo  binary = null 
)

Sends a message representing the stop of a feature.

Parameters
nameA unique name for the feature.
groupA Guid representing the message group.
keysAn optional ExtendedKeys instance used to send additional information to the server.
sessionA Guid defining the session for the Client.
binaryAn optional BinaryInfo instance used to send additional information about the caller of the method to the server.

Implemented in PreEmptive.Analytics.Common.PlatformClient.

void PreEmptive.Analytics.Common.IPlatformClient.FeatureTick ( string  name,
ExtendedKeys  keys = null,
Guid?  session = null,
BinaryInfo  binary = null 
)

Sends a message representing the occurrence of a feature.

Parameters
nameA unique name for the feature.
keysAn optional ExtendedKeys instance used to send additional information to the server.
sessionA Guid defining the session for the Client.
binaryAn optional BinaryInfo instance used to send additional information about the caller of the method to the server.

Implemented in PreEmptive.Analytics.Common.PlatformClient.

Guid PreEmptive.Analytics.Common.IPlatformClient.NewFeatureGroup ( )

Used to get a new Guid for a feature group.

Returns
Returns a new Guid.

Implemented in PreEmptive.Analytics.Common.PlatformClient.

void PreEmptive.Analytics.Common.IPlatformClient.PerformanceProbe ( string  name,
ExtendedKeys  keys = null,
Guid?  session = null,
BinaryInfo  info = null 
)

Sends a message describing the performance of the device and the applicaion.

Parameters
nameA name that describes the point at which the performance probe is performend. The name must not be null or empty.
keysAn ExtendedKeys instance used to send additional information to the server.
infoAn optional BinaryInfo instance used to send additional information about the caller of the method to the server.
sessionA Guid defining the session for the Client.

Implemented in PreEmptive.Analytics.Common.PlatformClient.

void PreEmptive.Analytics.Common.IPlatformClient.ReportException ( ExceptionInfo  exceptionInfo)

Sends a message representing an exception.

Parameters
exceptionInfoAn instance of ExceptionInfo that holds information that populates the exception message.

Implemented in PreEmptive.Analytics.Common.PlatformClient.

void PreEmptive.Analytics.Common.IPlatformClient.ReportException ( ExceptionInfo  exceptionInfo,
ExtendedKeys  keys,
Guid?  session = null,
BinaryInfo  binary = null 
)

Sends a message representing an exception.

Parameters
exceptionInfoAn instance of ExceptionInfo that holds information that populates the exception message.
keysAn ExtendedKeys instance used to send additional information to the server.
sessionA Guid defining the session for the Client.
binaryAn optional BinaryInfo instance used to send additional information about the caller of the method to the server.

Implemented in PreEmptive.Analytics.Common.PlatformClient.

void PreEmptive.Analytics.Common.IPlatformClient.ReportException ( ExceptionInfo  exceptionInfo,
bool  optInOverride,
ExtendedKeys  keys = null,
Guid?  session = null,
BinaryInfo  binary = null 
)

Sends a message representing an exception.

Parameters
exceptionInfoAn instance of ExceptionInfo that holds information that populates the exception message.
optInOverrideShould the optIn setting be overridden.
keysAn ExtendedKeys instance used to send additional information to the server.
sessionA Guid defining the session for the Client.
binaryAn optional BinaryInfo instance used to send additional information about the caller of the method to the server.

Implemented in PreEmptive.Analytics.Common.PlatformClient.

void PreEmptive.Analytics.Common.IPlatformClient.ReportExpiration ( Guid  slid,
ExtendedKeys  keys = null,
Guid?  session = null,
BinaryInfo  binary = null 
)

Sends a message reporting that the application's license has expired.

Parameters
slidThe shelflife ID of the application
sessionA Guid that identifies the current session.
keysExtended key information to be sent with the message.
binaryBinary info that describes the application where the request originated.

Implemented in PreEmptive.Analytics.Common.PlatformClient.

void PreEmptive.Analytics.Common.IPlatformClient.ReportExpirationWarning ( Guid  slid,
ExtendedKeys  keys = null,
Guid?  session = null,
BinaryInfo  binary = null 
)

Sends a message reporting that the user has been warned that the application's license is close to expiration

Parameters
slidThe shelflife ID of the application
sessionA Guid that identifies the current session.
keysExtended key information to be sent with the message.
binaryBinary info that describes the application where the request originated.

Implemented in PreEmptive.Analytics.Common.PlatformClient.

void PreEmptive.Analytics.Common.IPlatformClient.ReportTamper ( ExtendedKeys  keys = null,
Guid?  session = null,
BinaryInfo  binary = null 
)

Sends a message reporting that the application has been tampered with.

Parameters
keysAn optional ExtendedKeys instance used to send additional information to the server.
sessionA Guid defining the session for the Client.
binaryAn optional BinaryInfo instance used to send additional information about the caller of the method to the server.

Implemented in PreEmptive.Analytics.Common.PlatformClient.

void PreEmptive.Analytics.Common.IPlatformClient.SendMessages ( )

Signals the Client to send all of the messages that are currently in the queue.

Implemented in PreEmptive.Analytics.Common.PlatformClient.

void PreEmptive.Analytics.Common.IPlatformClient.SetSendDisabled ( bool  value)

Disables or enables the sending of messages for the currently running Client.

Parameters
valueWhether or not the sending of messages should be disabled.

Implemented in PreEmptive.Analytics.Common.PlatformClient.

void PreEmptive.Analytics.Common.IPlatformClient.SetSessionOptIn ( bool  value)

Enables or disables the optIn setting for the currently running Client.

Parameters
valueThe value to set optIn to.

Implemented in PreEmptive.Analytics.Common.PlatformClient.

void PreEmptive.Analytics.Common.IPlatformClient.SystemProfile ( ExtendedKeys  keys = null,
Guid?  session = null,
BinaryInfo  binary = null 
)

Sends a system profile message.

Parameters
keysAn ExtendedKeys instance used to send additional information to the server.
binaryAn optional BinaryInfo instance used to send additional information about the caller of the method to the server.
sessionA Guid defining the session for the Client.

Implemented in PreEmptive.Analytics.Common.PlatformClient.

Property Documentation

CoreClient PreEmptive.Analytics.Common.IPlatformClient.Core
get

The underlying CoreClient instance used by the PlatformClient.


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