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

The configuration for a PAClient to use More...

Classes

class  ApplicationStopBehavior
 The class which controls the behavior of ApplicationStop for the PAClient More...
 

Public Member Functions

 Configuration ()
 Constuctor for a Configuration object. More...
 
 Configuration (Guid companyID, Guid applicationID)
 Constuctor for a Configuration object. More...
 
 Configuration (string companyID, string applicationID)
 Constuctor for a Configuration object. More...
 
string GetFullEndpointURI ()
 Returns the endpoing URI based on the UseSSL setting. More...
 
Configuration Copy ()
 Returns a deep copy of the Configuration object. More...
 

Public Attributes

Guid CompanyID
 A Guid that uniquely identifies the company. More...
 
string CompanyName
 The name of the company. More...
 
Guid ApplicationID
 A Guid that uniquely identifies the application. More...
 
string ApplicationType
 A user defined application type. More...
 
string ApplicationName
 The name of the application. More...
 
string ApplicationVersion
 The version of the application. More...
 
string InstanceID
 An identifier for the instance of the application. More...
 
bool OptIn = true
 A boolean that determines if the Client is permitted to send any information. More...
 
Guid DefaultSession
 A Guid representing the session that is used if the user has not provided one. More...
 
Guid MessageGroup
 A Guid that uniquely defines a group that the messages belong to. More...
 
string Endpoint = "so-s.info/PreEmptive.Web.Services.Messaging/MessagingServiceV3.svc/Publish"
 The endpoint to send the messages to. More...
 
bool UseSSL = true
 Should SSL encryption be used when sending messages. More...
 
bool SupportOfflineStorage = true
 Should messages be saved offline when they cannot be sent. More...
 
int MinimumFailureCount = 150
 The minimum amount of times a message should fail to be transmitted before becoming eligible for deletion from offline storage This is used to populate the default flow controller More...
 
int MinimumTimeToLive = 60 * 60 * 24 * 3
 The minimum age(in seconds) a message must be before it becomes eligible for deletion from offline storage This is used to populate the default flow controller More...
 
bool Offline = false
 Is the transmission of messages prohibited. More...
 
bool OmitPersonalInfo = false
 If set to true will scrub all personally identifiable information Includes things like: Username, host IP, host name, etc More...
 
bool FullData = true
 This controls how "deep" Platform.GetSystemInfo is allowed to go. If true, it may take longer to read some information. If set to false, it'll skip getting information that is considered slow More...
 
int MaximumBatchSize = (4 * 1024 * 1024) - (4096)
 The maximum size a message batch can be, in bytes. If a batch exceeds this size, it is split into multiple batches If a single message exceeds this size, it will be discarded if transmission fails at any time More...
 
IAttributeLimiter AttributeLimiter = EndpointAttributeLimits.Common
 The field size limits of the server pointed to by Endpoint More...
 

Properties

bool InstanceIdUserSet [get, set]
 Indicates if InstanceID was set by the user. More...
 
string GeneratedUserName [get, set]
 Stores the generated user name. More...
 
ApplicationStopBehavior StopBehavior [get, set]
 Defines the behavior when an ApplicationStop is called More...
 

Detailed Description

The configuration for a PAClient to use

Constructor & Destructor Documentation

PreEmptive.Analytics.Common.Configuration.Configuration ( )

Constuctor for a Configuration object.

PreEmptive.Analytics.Common.Configuration.Configuration ( Guid  companyID,
Guid  applicationID 
)

Constuctor for a Configuration object.

Parameters
companyIDA Guid that uniquely identifies the company.
applicationIDA Guid tht uniquely identifies the application.
PreEmptive.Analytics.Common.Configuration.Configuration ( string  companyID,
string  applicationID 
)

Constuctor for a Configuration object.

Parameters
companyIDA Guid in string form that uniquely identifies the company.
applicationIDA Guid in string form that uniquely identifies the application.

Member Function Documentation

Configuration PreEmptive.Analytics.Common.Configuration.Copy ( )

Returns a deep copy of the Configuration object.

Returns
The new Configuration object.
string PreEmptive.Analytics.Common.Configuration.GetFullEndpointURI ( )

Returns the endpoing URI based on the UseSSL setting.

Returns
The endpoint URI.

Member Data Documentation

Guid PreEmptive.Analytics.Common.Configuration.ApplicationID

A Guid that uniquely identifies the application.

string PreEmptive.Analytics.Common.Configuration.ApplicationName

The name of the application.

string PreEmptive.Analytics.Common.Configuration.ApplicationType

A user defined application type.

string PreEmptive.Analytics.Common.Configuration.ApplicationVersion

The version of the application.

IAttributeLimiter PreEmptive.Analytics.Common.Configuration.AttributeLimiter = EndpointAttributeLimits.Common

The field size limits of the server pointed to by Endpoint

Guid PreEmptive.Analytics.Common.Configuration.CompanyID

A Guid that uniquely identifies the company.

string PreEmptive.Analytics.Common.Configuration.CompanyName

The name of the company.

Guid PreEmptive.Analytics.Common.Configuration.DefaultSession

A Guid representing the session that is used if the user has not provided one.

string PreEmptive.Analytics.Common.Configuration.Endpoint = "so-s.info/PreEmptive.Web.Services.Messaging/MessagingServiceV3.svc/Publish"

The endpoint to send the messages to.

bool PreEmptive.Analytics.Common.Configuration.FullData = true

This controls how "deep" Platform.GetSystemInfo is allowed to go. If true, it may take longer to read some information. If set to false, it'll skip getting information that is considered slow

string PreEmptive.Analytics.Common.Configuration.InstanceID

An identifier for the instance of the application.

int PreEmptive.Analytics.Common.Configuration.MaximumBatchSize = (4 * 1024 * 1024) - (4096)

The maximum size a message batch can be, in bytes. If a batch exceeds this size, it is split into multiple batches If a single message exceeds this size, it will be discarded if transmission fails at any time

Guid PreEmptive.Analytics.Common.Configuration.MessageGroup

A Guid that uniquely defines a group that the messages belong to.

int PreEmptive.Analytics.Common.Configuration.MinimumFailureCount = 150

The minimum amount of times a message should fail to be transmitted before becoming eligible for deletion from offline storage This is used to populate the default flow controller

int PreEmptive.Analytics.Common.Configuration.MinimumTimeToLive = 60 * 60 * 24 * 3

The minimum age(in seconds) a message must be before it becomes eligible for deletion from offline storage This is used to populate the default flow controller

bool PreEmptive.Analytics.Common.Configuration.Offline = false

Is the transmission of messages prohibited.

bool PreEmptive.Analytics.Common.Configuration.OmitPersonalInfo = false

If set to true will scrub all personally identifiable information Includes things like: Username, host IP, host name, etc

bool PreEmptive.Analytics.Common.Configuration.OptIn = true

A boolean that determines if the Client is permitted to send any information.

bool PreEmptive.Analytics.Common.Configuration.SupportOfflineStorage = true

Should messages be saved offline when they cannot be sent.

bool PreEmptive.Analytics.Common.Configuration.UseSSL = true

Should SSL encryption be used when sending messages.

Property Documentation

string PreEmptive.Analytics.Common.Configuration.GeneratedUserName
getset

Stores the generated user name.

bool PreEmptive.Analytics.Common.Configuration.InstanceIdUserSet
getset

Indicates if InstanceID was set by the user.

ApplicationStopBehavior PreEmptive.Analytics.Common.Configuration.StopBehavior
getset

Defines the behavior when an ApplicationStop is called


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