Splunk MINT SDK for iOS  4.4
 All Classes Files Functions Enumerations Enumerator Properties Macros
Mint.h
Go to the documentation of this file.
1 //
2 // Mint.h
3 // Splunk-iOS
4 //
5 
6 #import <Foundation/Foundation.h>
7 #import <UIKit/UIKit.h>
8 
10 #import "MintEnums.h"
11 
21 #define MintLogException(exception, extradata) [[Mint sharedInstance] logExceptionAsync:exception limitedExtraDataList:extradata];
22 
30 @interface Mint : NSObject
31 
37 + (Mint*) sharedInstance;
38 
39 
43 - (BOOL) isInitialized;
44 
48 - (BOOL) isSessionActive;
49 
53 @property (nonatomic, strong) NSString* userIdentifier;
54 
59 @property (nonatomic, assign) BOOL handleWhileDebugging;
60 
64 @property (nonatomic, strong) LimitedExtraDataList* extraDataList;
65 
66 
71 - (void) disableCrashReporter;
72 
77 - (void) flushAsync;
78 
79 
80 #pragma mark *** Initialize Mint SDK ***
81 
87 - (void) initAndStartSession: (NSString*)apiKey DEPRECATED_ATTRIBUTE;
88 
96 - (void) initAndStartSessionWithAPIKey:(NSString*)apiKey;
97 
108 - (void) initAndStartSessionHECWithAPIKey:(NSString*)apiKey url:(NSString*)url token:(NSString*)token;
109 
110 
111 
117 - (void) addExtraData:(ExtraData*)extraData;
118 
119 
125 - (void) addExtraDataList:(LimitedExtraDataList*)limitedExtraDataList;
126 
134 - (BOOL) removeExtraDataWithKey: (NSString*)key;
135 
139 - (void) clearExtraData;
140 
146 - (void) leaveBreadcrumb: (NSString*)crumb;
147 
151 - (void) clearBreadcrumbs;
152 
158 - (void) logEventAsyncWithTag: (NSString*)tag;
159 
167 - (void) logEventAsyncWithTag: (NSString*)tag extraDataKey: (NSString*)key extraDataValue: (NSString*)value;
168 
175 - (void) logEventAsyncWithTag: (NSString*)tag limitedExtraDataList: (LimitedExtraDataList*)extraDataList;
176 
181 - (void) startSessionAsync;
182 
187 - (void) closeSessionAsync;
188 
196 - (void) logExceptionAsync: (NSException*)exception extraDataKey: (NSString*)key extraDataValue: (NSString*)value;
197 
204 - (void) logExceptionAsync: (NSException*)exception limitedExtraDataList: (LimitedExtraDataList*)extraDataList;
205 
209 - (void) disableNetworkMonitoring;
210 
216 - (NSDictionary*) getDevSettings;
217 
223 - (void) enableMintLoggingCache:(BOOL)enable;
224 
230 - (void) enableLogging:(BOOL)enable;
231 
236 - (void) enableFlushOnlyOverWiFi:(BOOL)enable;
237 
243 - (void) setLogging:(NSInteger)linesCount;
244 
250 - (void) transactionStart:(NSString*)transactionName;
251 
259 - (void) transactionStart:(NSString*)transactionName extraDataKey: (NSString*)key extraDataValue: (NSString*)value;
260 
267 - (void) transactionStart:(NSString*)transactionName limitedExtraDataList: (LimitedExtraDataList*)extraDataList;
268 
274 - (void) transactionStop:(NSString*)transactionName;
275 
283 - (void) transactionStop:(NSString*)transactionName extraDataKey: (NSString*)key extraDataValue: (NSString*)value;
284 
291 - (void) transactionStop:(NSString*)transactionName limitedExtraDataList: (LimitedExtraDataList*)extraDataList;
292 
299 - (void) transactionCancel:(NSString*)transactionName reason:(NSString*)aReason;
300 
309 - (void) transactionCancel:(NSString*)transactionName extraDataKey: (NSString*)key extraDataValue: (NSString*)value reason:(NSString*)aReason;
310 
318 - (void) transactionCancel:(NSString*)transactionName limitedExtraDataList: (LimitedExtraDataList*)extraDataList reason:(NSString*)aReason;
319 
325 - (void) addURLToBlackList:(NSString*)url;
326 
332 - (NSMutableArray*) blacklistUrls;
333 
340 - (void) logEventAsyncWithName:(NSString*)name logLevel:(MintLogLevel)logLevel;
341 
350 - (void) logEventAsyncWithName:(NSString *)name logLevel:(MintLogLevel)logLevel extraDataKey: (NSString*)key extraDataValue: (NSString*)value;
351 
359 - (void) logEventAsyncWithName:(NSString*)name logLevel:(MintLogLevel)logLevel limitedExtraDataList: (LimitedExtraDataList*)extraDataList;
360 
361 
369 - (NSString*) exceptionFixtureFrom:(NSException*)exception;
370 
376 - (void)setUserOptOut:(BOOL)setUserOptOut;
377 
383 - (NSString*)getMintUUID;
384 
390 - (NSString*)getSessionID;
391 
398 - (void)logViewWithCurrentViewName:(NSString*)currentViewName limitedExtraDataList:(LimitedExtraDataList*)extraDataList;
399 
404 - (void)setSessionInterval:(NSInteger)intervalInSeconds;
405 
410 
411 @end
NSString * userIdentifier
Definition: Mint.h:53
void clearExtraData()
Definition: Mint.h:30
Definition: ExtraData.h:15
void flushAsync()
BOOL handleWhileDebugging
Definition: Mint.h:59
LimitedExtraDataList * extraDataList
Definition: Mint.h:64
void clearBreadcrumbs()
void disableNetworkMonitoring()
BOOL isInitialized()
NSMutableArray * blacklistUrls()
BOOL isHTTPEventCollectorEnabled()
Mint * sharedInstance()
NSString * getMintUUID()
NSString * getSessionID()
BOOL isSessionActive()
MintLogLevel
Definition: MintEnums.h:155
NSDictionary * getDevSettings()
void startSessionAsync()
void closeSessionAsync()
void disableCrashReporter()
Definition: LimitedExtraDataList.h:17