Inherits from NSObject
Declared in EQATECAnalyticsMonitor.h

Overview

Class containing the settings used for constructing the EQATECAnalyticsMonitor instance. Instances are preloaded with default settings which can be adjusted before the instance is being passed to the [EQATECAnalyticsMonitor monitorWithSettings:] convenience method.

Properties

dailyNetworkUtilizationInKB

Explicitly set a limit on the daily network utilization of the monitor. The utilization is accumulated based on the size of the payload for both upstream and downstream data and is enforce on a daily basis.

@property (nonatomic) int dailyNetworkUtilizationInKB

Discussion

The monitor will not honor a limit lower than 10 kb since the monitor must be able to contact the server with at least a mimimum of payload. If you do not want the monitor to contact the server you should not call [EQATECAnalyticsMonitor start] on the monitor instance.

Declared In

EQATECAnalyticsMonitor.h

isTestMode

Use this flag to enable the test mode for this installation. This might for example allow you to test version announcements before relasing it to customers.

@property (nonatomic) BOOL isTestMode

Discussion

The precise behavior for the isTestMode property may change over time but is provided to explicitly enable certain test scenarios for developers.

Declared In

EQATECAnalyticsMonitor.h

location

The location of the monitor as GPS coordinates. Use this property if you have access to GPS coordinates for the location of the application. If provided, these coordinates will be delivered to the servers as part of the data payload.

@property (nonatomic) CLLocationCoordinate2D location

Declared In

EQATECAnalyticsMonitor.h

loggingDelegate

The logging interface used for exposing internal messages.

@property (retain, nonatomic) id<EQATECLogAnalyticsMonitor> loggingDelegate

Discussion

You can provide your own implementation of the EQATECLogAnalyticsMonitor interface in order to receive the internal logging messages from constructed monitors, or you can create a convenient default logger by using [EQATECTraceLogger traceLogger].

Declared In

EQATECAnalyticsMonitor.h

maxStorageSizeInKB

Explicitly set a size limit on the data save to persistent storage by the monitor. The size is calculated each time the monitor persists to storage and if the size limit is exceeded it will attempt to persist less data.

@property (nonatomic) int maxStorageSizeInKB

Discussion

The monitor will not honor a limit lower than 1 kb since the monitor requires to store at least a minimal amount of metadata.

Declared In

EQATECAnalyticsMonitor.h

productId

Specifies the ID of the product.

@property (readonly) NSString *productId

Declared In

EQATECAnalyticsMonitor.h

proxyConfig

Used to specify configuration of proxy. The default value is “proxy disabled”.

@property (readonly, nonatomic) EQATECProxyConfiguration *proxyConfig

Declared In

EQATECAnalyticsMonitor.h

serverUri

Override the default uri for the server. For most standard purposes there is no need to provide your own uri for the server as the monitor provides a default uri which will contact the server correctly.

@property (copy, nonatomic) NSString *serverUri

Discussion

You may require to specify this server uri if the network setup for your end users are non-standard. Also be aware that the usesSSL property is is ignored when explicitly specifying the server uri.

Declared In

EQATECAnalyticsMonitor.h

storageDelegate

The storage interface used internally in the analytics monitor for saving and loading state.

@property (retain, nonatomic) id<EQATECStorage> storageDelegate

Discussion

Consider providing your own implementation of the EQATECStorage interface if your application requires special handling when storing data.

Declared In

EQATECAnalyticsMonitor.h

storageSaveInterval

The interval with which we autosave the internal statistics. The default is one minute. If set to 0, no autosave is performed.

@property (nonatomic) NSTimeInterval storageSaveInterval

Declared In

EQATECAnalyticsMonitor.h

synchronizesAutomatically

Use this flag to specify if the monitor automatically should synchronize data to the server or it should only synchronize manually on explicit calls to [EQATECAnalyticsMonitor forceSync]. The default value is YES as the monitor will automatically synchronize data to the server without the clients have to call [EQATECAnalyticsMonitor forceSync].

@property (nonatomic) BOOL synchronizesAutomatically

Declared In

EQATECAnalyticsMonitor.h

usesSSL

Uses https traffic against the servers unless the serverUri has been explicitly specified to non-https. By default this property is NO.

@property (nonatomic) BOOL usesSSL

Discussion

If the serverUri property has has been specified explicitly this property is ignored. The validation of the certificate from the servers are handled by the underlying operating system. For some platforms this may present a problem since they have limited support for wild-card certificates.

Declared In

EQATECAnalyticsMonitor.h

version

Specifies the version of the software, that should be used for version checking.

@property (copy, nonatomic) NSString *version

Declared In

EQATECAnalyticsMonitor.h

Class Methods

settingsWithProductId:version:

Construct the default settings corresponding to a given productId and version.

+ (EQATECAnalyticsMonitorSettings *)settingsWithProductId:(NSString *)productId version:(NSString *)version

Parameters

productId

The product ID in Guid-form, eg “XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX”

version

The product version in numeric form, eg “3.4” or “2.7.332.3451”

Return Value

an instance of the EQATECAnalyticsMonitorSettings, or nil if productId or version is invalid

Declared In

EQATECAnalyticsMonitor.h