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

The PreEmptive Analytics Client. More...

Inheritance diagram for PAClient:

Instance Methods

(id) - initWithConfiguration:
 Initializes the client with the configuration information. More...
 
(id) - initWithConfiguration:flowController:
 Initializes the client with the configuration information and a flow controller. More...
 
(void) - setOptIn:
 Enables or disables the optIn setting for the currently running Client. More...
 
(void) - setSendDisabled:
 Disables or enables the sending of messages for the currently running Client. More...
 
(BOOL) - applicationStart
 Starts the PreEmptive Analytics Client and sends the application start messages. More...
 
(BOOL) - applicationStartWithInfo:
 Starts the PreEmptive Analytics Client system and sends the application start messages. More...
 
(BOOL) - applicationStartWithKeys:
 Starts the PreEmptive Analytics Client and sends the application start messages. More...
 
(BOOL) - applicationStartWithInfo:keys:
 Starts the PreEmptive Analytics Client and sends the application and session start messages. More...
 
(void) - applicationStop
 Stops the PreEmptive Analytics Client and sends the application and session stop messages. More...
 
(void) - applicationStopWithInfo:
 Stops the PreEmptive Analytics Client and sends the application and session stop messages. More...
 
(void) - applicationStopWithKeys:
 Stops the PreEmptive Analytics Client and sends the application and session stop messages. More...
 
(void) - applicationStopWithInfo:keys:
 Stops the PreEmptive Analytics Client and sends the application and session stop messages. More...
 
(void) - featureTick:
 Sends a message representing the occurrence of a feature. More...
 
(void) - featureTick:info:
 Sends a message representing the occurrence of a feature. More...
 
(void) - featureTick:keys:
 Sends a message representing the occurrence of a feature. More...
 
(void) - featureTick:sessionID:
 Sends a message representing the occurrence of a feature. More...
 
(void) - featureTick:info:keys:
 Sends a message representing the occurrence of a feature. More...
 
(void) - featureTick:info:keys:sessionID:
 Sends a message representing the occurrence of a feature. More...
 
(void) - featureStart:
 Sends a message representing the start of a feature. More...
 
(void) - featureStart:info:
 Sends a message representing the start of a feature. More...
 
(void) - featureStart:keys:
 Sends a message representing the start of a feature. More...
 
(void) - featureStart:sessionID:
 Sends a message representing the start of a feature. More...
 
(void) - featureStart:info:keys:
 Sends a message representing the start of a feature. More...
 
(void) - featureStart:info:keys:sessionID:
 Sends a message representing the start of a feature. More...
 
(void) - featureStop:
 Sends a message representing the stop of a feature. More...
 
(void) - featureStop:info:
 Sends a message representing the stop of a feature. More...
 
(void) - featureStop:keys:
 Sends a message representing the stop of a feature. More...
 
(void) - featureStop:sessionID:
 Sends a message representing the stop of a feature. More...
 
(void) - featureStop:info:keys:
 Sends a message representing the stop of a feature. More...
 
(void) - featureStop:info:keys:sessionID:
 Sends a message representing the stop of a feature. More...
 
(void) - reportException:
 Sends a message representing an exception. More...
 
(void) - reportException:optInOverride:
 Sends a message representing an exception. More...
 
(void) - reportException:info:
 Sends a message representing an exception. More...
 
(void) - reportException:keys:
 Sends a message representing an exception. More...
 
(void) - reportException:sessionID:
 Sends a message representing an exception. More...
 
(void) - reportException:info:keys:
 Sends a message representing an exception. More...
 
(void) - reportException:info:keys:optInOverride:
 Sends a message representing an exception. More...
 
(void) - reportException:info:keys:sessionID:optInOverride:
 Sends a message representing an exception. More...
 
(void) - performanceProbe:
 Sends a message describing the performance of the device and the application. More...
 
(void) - performanceProbe:info:
 Sends a message describing the performance of the device and the application. More...
 
(void) - performanceProbe:keys:
 Sends a message describing the performance of the device and the application. More...
 
(void) - performanceProbe:sessionID:
 Sends a message describing the performance of the device and the application. More...
 
(void) - performanceProbe:info:keys:
 Sends a message describing the performance of the device and the application. More...
 
(void) - performanceProbe:info:keys:sessionID:
 Sends a message describing the performance of the device and the application. More...
 
(void) - systemProfile
 Sends a system profile message.
 
(void) - systemProfileWithInfo:
 Sends a system profile message. More...
 
(void) - systemProfileWithKeys:
 Sends a system profile message. More...
 
(void) - systemProfileWithSessionID:
 Sends a system profile message. More...
 
(void) - systemProfileWithInfo:keys:
 Sends a system profile message. More...
 
(void) - systemProfileWithInfo:keys:sessionID:
 Sends a system profile message. More...
 
(NSString *) - sessionID
 Retrives the Session GUID that is being used for the current API run. More...
 
(void) - sendMessages
 Signals the Client to send all of the messages that are currently in the queue and send one message from offline storage.
 

Detailed Description

The PreEmptive Analytics Client.

This object allows you to send the different messages to a PreEmptive Analytics server.

Definition at line 108 of file PAClient.h.

Method Documentation

- (BOOL) applicationStart

Starts the PreEmptive Analytics Client and sends the application start messages.

Changes to the configuration will no longer be honored.

Returns
YES if the client started correctly.
- (BOOL) applicationStartWithInfo: (PABinaryInfo *)  info

Starts the PreEmptive Analytics Client system and sends the application start messages.

Changes to the configuration will no longer be honored.

Parameters
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
Returns
YES if the client started correctly.
- (BOOL) applicationStartWithInfo: (PABinaryInfo *)  info
keys: (PAExtendedKeys *)  keys 

Starts the PreEmptive Analytics Client and sends the application and session start messages.

Changes to the configuration will no longer be honored.

Parameters
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
keysAn optional PAExtendedKeys instance used to send additional information to the server.
Returns
YES if the client started correctly.
- (BOOL) applicationStartWithKeys: (PAExtendedKeys *)  keys

Starts the PreEmptive Analytics Client and sends the application start messages.

Changes to the configuration will no longer be honored.

Parameters
keysAn optional PAExtendedKeys instance used to send additional information to the server.
Returns
YES if the client started correctly.
- (void) applicationStop

Stops the PreEmptive Analytics Client and sends the application and session stop messages.

Changes to the configuration will no longer be honored. 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.

- (void) applicationStopWithInfo: (PABinaryInfo *)  info

Stops the PreEmptive Analytics Client and sends the application and session stop messages.

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
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
- (void) applicationStopWithInfo: (PABinaryInfo *)  info
keys: (PAExtendedKeys *)  keys 

Stops the PreEmptive Analytics Client and sends the application and session stop messages.

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
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
keysAn optional PAExtendedKeys instance used to send additional information to the server.
- (void) applicationStopWithKeys: (PAExtendedKeys *)  keys

Stops the PreEmptive Analytics Client and sends the application and session stop messages.

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 PAExtendedKeys instance used to send additional information to the server.
- (void) featureStart: (NSString *)  feature

Sends a message representing the start of a feature.

Parameters
featureA unique name for the feature. It must not be nil or empty.
- (void) featureStart: (NSString *)  feature
info: (PABinaryInfo *)  info 

Sends a message representing the start of a feature.

Parameters
featureA unique name for the feature. It must not be nil or empty.
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
- (void) featureStart: (NSString *)  feature
info: (PABinaryInfo *)  info
keys: (PAExtendedKeys *)  keys 

Sends a message representing the start of a feature.

Parameters
featureA unique name for the feature. It must not be nil or empty.
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
keysAn optional PAExtendedKeys instance used to send additional information to the server.
- (void) featureStart: (NSString *)  feature
info: (PABinaryInfo *)  info
keys: (PAExtendedKeys *)  keys
sessionID: (NSString *)  sessionID 

Sends a message representing the start of a feature.

Parameters
featureA unique name for the feature. It must not be nil or empty.
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
keysAn optional PAExtendedKeys instance used to send additional information to the server.
sessionIDA optional GUID defining the session for the Client.
- (void) featureStart: (NSString *)  feature
keys: (PAExtendedKeys *)  keys 

Sends a message representing the start of a feature.

Parameters
featureA unique name for the feature. It must not be nil or empty.
keysAn optional PAExtendedKeys instance used to send additional information to the server.
- (void) featureStart: (NSString *)  feature
sessionID: (NSString *)  sessionID 

Sends a message representing the start of a feature.

Parameters
featureA unique name for the feature. It must not be nil or empty.
sessionIDA optional GUID defining the session for the Client.
- (void) featureStop: (NSString *)  feature

Sends a message representing the stop of a feature.

Parameters
featureA unique name for the feature. It must not be nil or empty.
- (void) featureStop: (NSString *)  feature
info: (PABinaryInfo *)  info 

Sends a message representing the stop of a feature.

Parameters
featureA unique name for the feature. It must not be nil or empty.
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
- (void) featureStop: (NSString *)  feature
info: (PABinaryInfo *)  info
keys: (PAExtendedKeys *)  keys 

Sends a message representing the stop of a feature.

Parameters
featureA unique name for the feature. It must not be nil or empty.
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
keysAn optional PAExtendedKeys instance used to send additional information to the server.
- (void) featureStop: (NSString *)  feature
info: (PABinaryInfo *)  info
keys: (PAExtendedKeys *)  keys
sessionID: (NSString *)  sessionID 

Sends a message representing the stop of a feature.

Parameters
featureA unique name for the feature. It must not be nil or empty.
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
keysAn optional PAExtendedKeys instance used to send additional information to the server.
sessionIDA optional GUID defining the session for the Client.
- (void) featureStop: (NSString *)  feature
keys: (PAExtendedKeys *)  keys 

Sends a message representing the stop of a feature.

Parameters
featureA unique name for the feature. It must not be nil or empty.
keysAn optional PAExtendedKeys instance used to send additional information to the server.
- (void) featureStop: (NSString *)  feature
sessionID: (NSString *)  sessionID 

Sends a message representing the stop of a feature.

Parameters
featureA unique name for the feature. It must not be nil or empty.
sessionIDA optional GUID defining the session for the Client.
- (void) featureTick: (NSString *)  feature

Sends a message representing the occurrence of a feature.

Parameters
featureA unique name for the feature. It must not be nil or empty.
- (void) featureTick: (NSString *)  feature
info: (PABinaryInfo *)  info 

Sends a message representing the occurrence of a feature.

Parameters
featureA unique name for the feature. It must not be nil or empty.
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
- (void) featureTick: (NSString *)  feature
info: (PABinaryInfo *)  info
keys: (PAExtendedKeys *)  keys 

Sends a message representing the occurrence of a feature.

Parameters
featureA unique name for the feature. It must not be nil or empty.
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
keysAn optional PAExtendedKeys instance used to send additional information to the server.
- (void) featureTick: (NSString *)  feature
info: (PABinaryInfo *)  info
keys: (PAExtendedKeys *)  keys
sessionID: (NSString *)  sessionID 

Sends a message representing the occurrence of a feature.

Parameters
featureA unique name for the feature. It must not be nil or empty.
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
keysAn optional PAExtendedKeys instance used to send additional information to the server.
sessionIDA optional GUID defining the session for the Client.
- (void) featureTick: (NSString *)  feature
keys: (PAExtendedKeys *)  keys 

Sends a message representing the occurrence of a feature.

Parameters
featureA unique name for the feature. It must not be nil or empty.
keysAn optional PAExtendedKeys instance used to send additional information to the server.
- (void) featureTick: (NSString *)  feature
sessionID: (NSString *)  sessionID 

Sends a message representing the occurrence of a feature.

Parameters
featureA unique name for the feature. It must not be nil or empty.
sessionIDA optional GUID defining the session for the Client.
- (id) initWithConfiguration: (PAConfiguration *)  initialConfig

Initializes the client with the configuration information.

The configuration is considered mutable until applicationStart is called. A default flow controller will be used.

Parameters
initialConfigThe initial configuration that defines the behavior of the Client.
Returns
The initalized client
- (id) initWithConfiguration: (PAConfiguration *)  initialConfig
flowController: (id< PAFlowController >)  flowController 

Initializes the client with the configuration information and a flow controller.

Parameters
initialConfigThe initial configuration that defines the behavior of the Client. The configuration is considered mutable until applicationStart is called.
flowControllerThe flow controller to be used.
Returns
The initalized client
- (void) performanceProbe: (NSString *)  name

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

Parameters
nameA name that describes the point at which the performance probe is performend. It must not be nil or empty.
- (void) performanceProbe: (NSString *)  name
info: (PABinaryInfo *)  info 

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

Parameters
nameA name that describes the point at which the performance probe is performend. It must not be nil or empty.
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
- (void) performanceProbe: (NSString *)  name
info: (PABinaryInfo *)  info
keys: (PAExtendedKeys *)  keys 

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

Parameters
nameA name that describes the point at which the performance probe is performend. It must not be nil or empty.
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
keysAn optional PAExtendedKeys instance used to send additional information to the server
- (void) performanceProbe: (NSString *)  name
info: (PABinaryInfo *)  info
keys: (PAExtendedKeys *)  keys
sessionID: (NSString *)  sessionID 

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

Parameters
nameA name that describes the point at which the performance probe is performend. It must not be nil or empty.
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
keysAn optional PAExtendedKeys instance used to send additional information to the server
sessionIDA optional GUID defining the session for the Client.
- (void) performanceProbe: (NSString *)  name
keys: (PAExtendedKeys *)  keys 

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

Parameters
nameA name that describes the point at which the performance probe is performend. It must not be nil or empty.
keysAn optional PAExtendedKeys instance used to send additional information to the server
- (void) performanceProbe: (NSString *)  name
sessionID: (NSString *)  sessionID 

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

Parameters
nameA name that describes the point at which the performance probe is performend. It must not be nil or empty.
sessionIDA optional GUID defining the session for the Client.
- (void) reportException: (PAExceptionInfo *)  exceptionInfo

Sends a message representing an exception.

Parameters
exceptionInfoAn PAExceptionInfo instance that holds information that populates the exception message.
- (void) reportException: (PAExceptionInfo *)  exceptionInfo
info: (PABinaryInfo *)  info 

Sends a message representing an exception.

Parameters
exceptionInfoAn PAExceptionInfo instance that holds information that populates the exception message.
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
- (void) reportException: (PAExceptionInfo *)  exceptionInfo
info: (PABinaryInfo *)  info
keys: (PAExtendedKeys *)  keys 

Sends a message representing an exception.

Parameters
exceptionInfoAn PAExceptionInfo instance that holds information that populates the exception message.
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
keysAn optional PAExtendedKeys instance used to send additional information to the server
- (void) reportException: (PAExceptionInfo *)  exceptionInfo
info: (PABinaryInfo *)  info
keys: (PAExtendedKeys *)  keys
optInOverride: (BOOL)  optInOverride 

Sends a message representing an exception.

Parameters
exceptionInfoAn PAExceptionInfo instance that holds information that populates the exception message.
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
keysAn optional PAExtendedKeys instance used to send additional information to the server
optInOverrideShould the optIn setting be overridden?
- (void) reportException: (PAExceptionInfo *)  exceptionInfo
info: (PABinaryInfo *)  info
keys: (PAExtendedKeys *)  keys
sessionID: (NSString *)  sessionID
optInOverride: (BOOL)  optInOverride 

Sends a message representing an exception.

Parameters
exceptionInfoAn PAExceptionInfo instance that holds information that populates the exception message.
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
keysAn optional PAExtendedKeys instance used to send additional information to the server
sessionIDA optional GUID defining the session for the Client.
optInOverrideShould the optIn setting be overridden?
- (void) reportException: (PAExceptionInfo *)  exceptionInfo
keys: (PAExtendedKeys *)  keys 

Sends a message representing an exception.

Parameters
exceptionInfoAn PAExceptionInfo instance that holds information that populates the exception message.
keysAn optional PAExtendedKeys instance used to send additional information to the server
- (void) reportException: (PAExceptionInfo *)  exceptionInfo
optInOverride: (BOOL)  optInOverride 

Sends a message representing an exception.

Parameters
exceptionInfoAn PAExceptionInfo instance that holds information that populates the exception message.
optInOverrideShould the optIn setting be overridden?
- (void) reportException: (PAExceptionInfo *)  exceptionInfo
sessionID: (NSString *)  sessionID 

Sends a message representing an exception.

Parameters
exceptionInfoAn PAExceptionInfo instance that holds information that populates the exception message.
sessionIDA optional GUID defining the session for the Client.
- (NSString*) sessionID

Retrives the Session GUID that is being used for the current API run.

This ID can be passed to other APIs to activate subordinate mode.

Returns
The current session GUID.
- (void) setOptIn: (BOOL)  optIn

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

If the user opts in messages will be sent. If the user opts out mesages will not be sent (except application stop).

Parameters
optInDoes the user want analytics data sent?
- (void) setSendDisabled: (BOOL)  sendDisabled

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

This setting toggles the setting used on the PAFlowController. When changing sendDisabled, the message queue will be cleared.

Parameters
sendDisabledShould messages be temporarily disabled from being sent?
See also
PAFlowController
- (void) systemProfileWithInfo: (PABinaryInfo *)  info

Sends a system profile message.

Parameters
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
- (void) systemProfileWithInfo: (PABinaryInfo *)  info
keys: (PAExtendedKeys *)  keys 

Sends a system profile message.

Parameters
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
keysAn optional PAExtendedKeys instance used to send additional information to the server
- (void) systemProfileWithInfo: (PABinaryInfo *)  info
keys: (PAExtendedKeys *)  keys
sessionID: (NSString *)  sessionID 

Sends a system profile message.

Parameters
infoAn optional PABinaryInfo instance used to send additional information about the caller of the method to the server.
keysAn optional PAExtendedKeys instance used to send additional information to the server
sessionIDA optional GUID defining the session for the Client.
- (void) systemProfileWithKeys: (PAExtendedKeys *)  keys

Sends a system profile message.

Parameters
keysAn optional PAExtendedKeys instance used to send additional information to the server
- (void) systemProfileWithSessionID: (NSString *)  sessionID

Sends a system profile message.

Parameters
sessionIDA optional GUID defining the session for the Client.

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