PreEmptive Analytics iOS API  2.0
The official iOS API for sending PreEmptive Analytics data.
PAConfiguration Class Reference

The configuration for the client. More...

Inheritance diagram for PAConfiguration:

Instance Methods

(id) - init
 Initializes the configuration with the defaults set. More...
 
(id) - initWithCompanyID:appID:
 Initializes the configuration with the default settings and the company and application IDs. More...
 
(void) - setLimiterType:
 Sets the time of limiter to use. More...
 

Protected Types

enum  PALoggerLevel : NSUInteger {
  NO_LOGGING =0, ERROR_LEVEL =1, WARN_LEVEL =1 << 1, INFO_LEVEL =1 << 2,
  DEBUG_LEVEL =1 << 3, TRACE_LEVEL =1 << 4
}
 Used to specify the level of logging that should be done. More...
 
enum  PASizeLimiter : NSUInteger {
  COMMON =0, PA_TFS =1, WORKBENCH = 1 << 3, RUNTIME_INTELLIGENCE =1 << 1,
  NONE =1 << 2
}
 The type of size limiter to use. More...
 

Properties

BOOL useSSL
 Should SSL encryption be used when sending messages? Default: YES.
 
BOOL optIn
 Is the Client is permitted to send any information? Default: YES. More...
 
BOOL omitPII
 Should personally identifiable information (PII) be stripped? This includes things like: device name, host IP, host name, etc. More...
 
BOOL fullData
 This controls how system and performance profilling is allowed to go. More...
 
BOOL offline
 Is the transmission of messages prohibited? If offline, analytics data will be cached to be sent later. More...
 
BOOL sendDisabled
 Is sending data temporarily disabled? Default: NO. More...
 
BOOL supportOfflineStorage
 Should messages be saved offline when they cannot be sent? Default: YES.
 
enum PALoggerLevel logLevel
 What logging level should be used? More...
 
NSUInteger timeout
 The maximum number of milliseconds the sytstem should wait while transmitting information.
 
NSUInteger maximumBatchSize
 The maximum size (in bytes) of a message batch. More...
 
NSUInteger minimumTimeToLive
 The minimum age (in seconds) a message must be before it becomes eligible for deletion from offline storage. More...
 
NSUInteger minimumFailureCount
 The minimum amount of times a message should fail to be transmitted before becoming eligible for deletion from offline storage. More...
 
NSString * appID
 A GUID that uniquely identifies the application.
 
NSString * appType
 The user-defined application type. More...
 
NSString * appName
 The name of the application. More...
 
NSString * appVersion
 The version of the application. More...
 
NSString * appInstanceID
 An unique identifier for the instance of the application. More...
 
NSString * companyID
 A GUID that uniquely identifies the company. More...
 
NSString * companyName
 The name of the company. More...
 
NSString * defaultSessionID
 The session GUID to be used. More...
 
NSString * endpoint
 The location where messages will be sent. More...
 
enum PASizeLimiter limiterType
 The type of attribute limiter being used. More...
 
id< PAAttributeSizeLimiterattributeSizeLimiter
 The field size limiter being used. More...
 

Detailed Description

The configuration for the client.

Definition at line 12 of file PAConfiguration.h.

Member Enumeration Documentation

- (enum PALoggerLevel) :
protected

Used to specify the level of logging that should be done.

Enumerator
NO_LOGGING 

No logging.

ERROR_LEVEL 

Only log errors and failures.

WARN_LEVEL 

Log the above plus situations where the API may not perform as expected.

INFO_LEVEL 

Log the above plus informational message such as life cycle events.

DEBUG_LEVEL 

Log the above plus debug information such as the raw messages being transmitted.

TRACE_LEVEL 

Log everything.

Definition at line 17 of file PAConfiguration.h.

- (enum PASizeLimiter) :
protected

The type of size limiter to use.

Enumerator
COMMON 

The Common limiter (default) which uses the lowest limits of the built-in limiters, now and in the future.

(Currently just PA_TFS and WORKBENCH)

PA_TFS 

The limits for PreEmptive Analytics for TFS.

WORKBENCH 

The limits for the PreEmptive Analytics Workbench.

RUNTIME_INTELLIGENCE 

The limits for Runtime Intelligence.

Deprecated:
This service no longer exists
NONE 

No limits.

Definition at line 29 of file PAConfiguration.h.

Method Documentation

- (id) init

Initializes the configuration with the defaults set.

Application and Company ID must still be set before it should be used.

Returns
An initialized configuration.
- (id) initWithCompanyID: (NSString *)  cID
appID: (NSString *)  aID 

Initializes the configuration with the default settings and the company and application IDs.

Parameters
cIDThe company ID (GUID)
aIDThe application ID (GUID)
Returns
An initialized configuration.
- (void) setLimiterType: (enum PASizeLimiter type

Sets the time of limiter to use.

Parameters
typeThe type.
See also
PASizeLmiter

Property Documentation

- (NSString*) appInstanceID
readwriteatomicstrong

An unique identifier for the instance of the application.

(optional) This should be unique for every installation of the application.

Definition at line 145 of file PAConfiguration.h.

- (NSString*) appName
readwriteatomicstrong

The name of the application.

(optional)

Definition at line 135 of file PAConfiguration.h.

- (NSString*) appType
readwriteatomicstrong

The user-defined application type.

(optional)

Definition at line 130 of file PAConfiguration.h.

- (NSString*) appVersion
readwriteatomicstrong

The version of the application.

(optional)

Definition at line 140 of file PAConfiguration.h.

- (id<PAAttributeSizeLimiter>) attributeSizeLimiter
readatomicstrong

The field size limiter being used.

See also
PAAttributeSizeLimiter

Definition at line 176 of file PAConfiguration.h.

- (NSString*) companyID
readwriteatomicstrong

A GUID that uniquely identifies the company.

This would be provided by PreEmptive Solutions.

Definition at line 150 of file PAConfiguration.h.

- (NSString*) companyName
readwriteatomicstrong

The name of the company.

(optional)

Definition at line 155 of file PAConfiguration.h.

- (NSString*) defaultSessionID
readwriteatomicstrong

The session GUID to be used.

If set, the client will behave in subordinate mode. (optional)

Definition at line 160 of file PAConfiguration.h.

- (NSString*) endpoint
readwriteatomicstrong

The location where messages will be sent.

Default: so-s.info/endpoint

Definition at line 165 of file PAConfiguration.h.

- (BOOL) fullData
readwriteatomic

This controls how system and performance profilling 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. Default: YES

Definition at line 78 of file PAConfiguration.h.

- (enum PASizeLimiter) limiterType
readatomicassign

The type of attribute limiter being used.

Default: Common

Definition at line 170 of file PAConfiguration.h.

- (enum PALoggerLevel) logLevel
readwriteatomic

What logging level should be used?

See also
PALoggerLevel

Definition at line 100 of file PAConfiguration.h.

- (NSUInteger) maximumBatchSize
readwriteatomic

The maximum size (in bytes) of a message batch.

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. Default: 4194304u (4MB)

Definition at line 110 of file PAConfiguration.h.

- (NSUInteger) minimumFailureCount
readwriteatomic

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.

Definition at line 120 of file PAConfiguration.h.

- (NSUInteger) minimumTimeToLive
readwriteatomic

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. Default: 259200u (3 days)

Definition at line 115 of file PAConfiguration.h.

- (BOOL) offline
readwriteatomic

Is the transmission of messages prohibited? If offline, analytics data will be cached to be sent later.

Default: NO

Definition at line 83 of file PAConfiguration.h.

- (BOOL) omitPII
readwriteatomic

Should personally identifiable information (PII) be stripped? This includes things like: device name, host IP, host name, etc.

Default: NO

Definition at line 73 of file PAConfiguration.h.

- (BOOL) optIn
readwriteatomic

Is the Client is permitted to send any information? Default: YES.

See also
PAClient::setOptIn

Definition at line 68 of file PAConfiguration.h.

- (BOOL) sendDisabled
readwriteatomic

Is sending data temporarily disabled? Default: NO.

See also
PAClient::setSendDisabled

Definition at line 89 of file PAConfiguration.h.


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