PreEmptive Analytics iOS API  2.0
The official iOS API for sending PreEmptive Analytics data.
PAClient.h
1 //
2 // PAClient.h
3 // PreEmptiveAnalyticsClient
4 //
5 // Copyright (c) 2013 PreEmptive Solutions. All rights reserved.
6 //
7 
97 #import <Foundation/Foundation.h>
98 #import "PAConfiguration.h"
99 #import "PABinaryInfo.h"
100 #import "PAExtendedKeys.h"
101 #import "PAFlowController.h"
102 #import "PAExceptionInfo.h"
103 
104 
108 @interface PAClient : NSObject
109 
115 -(id) initWithConfiguration:(PAConfiguration *)initialConfig;
116 
123 -(id) initWithConfiguration:(PAConfiguration *)initialConfig flowController:(id<PAFlowController>)flowController;
124 
129 -(void)setOptIn:(BOOL)optIn;
130 
136 -(void)setSendDisabled:(BOOL)sendDisabled;
137 
142 -(BOOL) applicationStart;
143 
149 -(BOOL) applicationStartWithInfo:(PABinaryInfo*)info;
150 
156 -(BOOL) applicationStartWithKeys:(PAExtendedKeys*)keys;
157 
164 -(BOOL) applicationStartWithInfo:(PABinaryInfo*)info keys:(PAExtendedKeys*)keys;
165 
170 -(void) applicationStop;
171 
177 -(void) applicationStopWithInfo:(PABinaryInfo*)info;
178 
184 -(void) applicationStopWithKeys:(PAExtendedKeys*)keys;
185 
193 -(void) applicationStopWithInfo:(PABinaryInfo*)info keys:(PAExtendedKeys*)keys;
194 
199 -(void) featureTick:(NSString *) feature;
200 
206 -(void) featureTick:(NSString *) feature info:(PABinaryInfo*)info;
207 
213 -(void) featureTick:(NSString *) feature keys:(PAExtendedKeys*)keys;
214 
220 -(void) featureTick:(NSString *) feature sessionID:(NSString*)sessionID;
221 
228 -(void) featureTick:(NSString *) feature info:(PABinaryInfo*)info keys:(PAExtendedKeys*)keys;
229 
237 -(void) featureTick:(NSString *) feature info:(PABinaryInfo*)info keys:(PAExtendedKeys*)keys sessionID:(NSString*)sessionID;
238 
243 -(void) featureStart:(NSString *) feature;
244 
250 -(void) featureStart:(NSString *) feature info:(PABinaryInfo*)info;
251 
257 -(void) featureStart:(NSString *) feature keys:(PAExtendedKeys*)keys;
258 
264 -(void) featureStart:(NSString *) feature sessionID:(NSString*)sessionID;
265 
272 -(void) featureStart:(NSString *) feature info:(PABinaryInfo*)info keys:(PAExtendedKeys*)keys;
273 
281 -(void) featureStart:(NSString *) feature info:(PABinaryInfo*)info keys:(PAExtendedKeys*)keys sessionID:(NSString*)sessionID;
282 
283 
288 -(void) featureStop:(NSString *) feature;
289 
295 -(void) featureStop:(NSString *) feature info:(PABinaryInfo*)info;
296 
302 -(void) featureStop:(NSString *) feature keys:(PAExtendedKeys*)keys;
303 
309 -(void) featureStop:(NSString *) feature sessionID:(NSString*)sessionID;
310 
317 -(void) featureStop:(NSString *) feature info:(PABinaryInfo*)info keys:(PAExtendedKeys*)keys;
318 
326 -(void) featureStop:(NSString *) feature info:(PABinaryInfo*)info keys:(PAExtendedKeys*)keys sessionID:(NSString*)sessionID;
327 
332 -(void) reportException:(PAExceptionInfo*)exceptionInfo;
333 
339 -(void) reportException:(PAExceptionInfo*)exceptionInfo optInOverride:(BOOL)optInOverride;
340 
346 -(void) reportException:(PAExceptionInfo*)exceptionInfo info:(PABinaryInfo*)info;
347 
353 -(void) reportException:(PAExceptionInfo*)exceptionInfo keys:(PAExtendedKeys*)keys;
354 
360 -(void) reportException:(PAExceptionInfo*)exceptionInfo sessionID:(NSString*)sessionID;
361 
368 -(void) reportException:(PAExceptionInfo*)exceptionInfo info:(PABinaryInfo*)info keys:(PAExtendedKeys*)keys;
369 
377 -(void) reportException:(PAExceptionInfo*)exceptionInfo info:(PABinaryInfo*)info keys:(PAExtendedKeys*)keys optInOverride:(BOOL)optInOverride;
378 
387 -(void) reportException:(PAExceptionInfo*)exceptionInfo info:(PABinaryInfo*)info keys:(PAExtendedKeys*)keys sessionID:(NSString*)sessionID optInOverride:(BOOL)optInOverride;
388 
393 -(void) performanceProbe:(NSString*)name;
394 
400 -(void) performanceProbe:(NSString*)name info:(PABinaryInfo*)info;
401 
407 -(void) performanceProbe:(NSString*)name keys:(PAExtendedKeys*)keys;
408 
414 -(void) performanceProbe:(NSString*)name sessionID:(NSString*)sessionID;
415 
422 -(void) performanceProbe:(NSString*)name info:(PABinaryInfo*)info keys:(PAExtendedKeys*)keys;
423 
431 -(void) performanceProbe:(NSString*)name info:(PABinaryInfo*)info keys:(PAExtendedKeys*)keys sessionID:(NSString*)sessionID;
432 
433 
437 -(void) systemProfile;
438 
443 -(void) systemProfileWithInfo:(PABinaryInfo*)info;
444 
449 -(void) systemProfileWithKeys:(PAExtendedKeys*)keys;
450 
455 -(void) systemProfileWithSessionID:(NSString*) sessionID;
456 
462 -(void) systemProfileWithInfo:(PABinaryInfo*)info keys:(PAExtendedKeys*)keys;
463 
470 -(void) systemProfileWithInfo:(PABinaryInfo*)info keys:(PAExtendedKeys*)keys sessionID:(NSString*)sessionID;
471 
476 -(NSString*)sessionID;
477 
481 -(void)sendMessages;
482 
483 @end
484 
485 
void systemProfile()
Sends a system profile message.
void applicationStop()
Stops the PreEmptive Analytics Client and sends the application and session stop messages.
void sendMessages()
Signals the Client to send all of the messages that are currently in the queue and send one message f...
NSString * sessionID()
Retrives the Session GUID that is being used for the current API run.
The PreEmptive Analytics Client.
Definition: PAClient.h:108
Class that handles extended key data used for sending additional information with messages...
BOOL applicationStart()
Starts the PreEmptive Analytics Client and sends the application start messages.
Protocol for defining a flow controller.
Class for handling exception information.
The configuration for the client.
Describes the binary file (executable) which is sending the message.
Definition: PABinaryInfo.h:13