Mint.h

Go to the documentation of this file.

//
//  Mint.h
//  SplunkMint
//
//  Copyright (c) 2016 Splunk. All rights reserved.

#import <Foundation/Foundation.h>
#import "MintLimitedExtraData.h"
#import "MintEnums.h"


#define MintLogException(exception, extradata) [[Mint sharedInstance] logException:exception extraData:extradata];

extern NSString * const SPLAppEnvRelease;
extern NSString * const SPLAppEnvStaging;
extern NSString * const SPLAppEnvUserAcceptanceTesting;
extern NSString * const SPLAppEnvTesting;
extern NSString * const SPLAppEnvDevelopment;


@interface Mint : NSObject

+ (Mint*) sharedInstance;


- (BOOL) isInitialized;

- (BOOL) isSessionActive;

- (void)enableDebugLog:(BOOL) enable;

@property (nonatomic, strong) NSString* userIdentifier;


@property (nonatomic, strong) NSString* applicationEnvironment;

- (void) disableCrashReporter;

- (void) flush;


#pragma mark *** Initialize Mint SDK ***

- (void) initAndStartSessionWithAPIKey:(NSString*)apiKey;

- (void) initAndStartSessionWithHECUrl:(NSString*)url token:(NSString*)token;

- (void) leaveBreadcrumb: (NSString*)crumb;

- (void) clearBreadcrumbs;


- (void) startSession;

- (void) closeSession;


- (void) logException: (NSException*)exception;

- (void) logException: (NSException*)exception extraDataKey: (NSString*)key extraDataValue: (NSString*)value;

- (void) logException: (NSException*)exception extraData: (MintLimitedExtraData*)extraDataDictionary;

- (void) disableNetworkMonitoring;

- (NSDictionary*) getDevSettings;

- (void) enableMintLoggingCache:(BOOL)enable;

- (void) enableLogging:(BOOL)enable;

- (void) enableFlushOnlyOverWiFi:(BOOL)enable;

- (void) setLogging:(NSInteger)linesCount;

- (void) transactionStart:(NSString*)transactionName;

- (void) transactionStart:(NSString*)transactionName extraDataKey: (NSString*)key extraDataValue: (NSString*)value;

- (void) transactionStart:(NSString*)transactionName extraData: (MintLimitedExtraData*)extraDataDictionary;

- (void) transactionStop:(NSString*)transactionName;

- (void) transactionStop:(NSString*)transactionName extraDataKey: (NSString*)key extraDataValue: (NSString*)value;

- (void) transactionStop:(NSString*)transactionName extraData: (MintLimitedExtraData*)extraDataDictionary;

- (void) transactionCancel:(NSString*)transactionName reason:(NSString*)aReason;

- (void) transactionCancel:(NSString*)transactionName reason:(NSString*)aReason extraDataKey: (NSString*)key extraDataValue: (NSString*)value;

- (void) transactionCancel:(NSString*)transactionName reason:(NSString*)aReason extraData: (MintLimitedExtraData*)extraDataDictionary;

- (void) addURLToBlackList:(NSString*)url;

- (NSMutableArray*) blacklistUrls;


- (void) logEventWithName: (NSString*)name;

- (void) logEventWithName:(NSString*)name logLevel:(MintLogLevel)logLevel;

- (void) logEventWithName:(NSString *)name logLevel:(MintLogLevel)logLevel extraDataKey: (NSString*)key extraDataValue: (NSString*)value;

- (void) logEventWithName:(NSString*)name logLevel:(MintLogLevel)logLevel extraData: (MintLimitedExtraData*)extraDataDictionary;

- (void)enableUserOptOut:(BOOL)userOptOut;

- (NSString*)getMintUUID;

- (NSString*)getSessionID;

- (void)logViewWithCurrentViewName:(NSString*)currentViewName;

- (void)logViewWithCurrentViewName:(NSString*)currentViewName extraDataKey: (NSString*)key extraDataValue: (NSString*)value;

- (void)logViewWithCurrentViewName:(NSString*)currentViewName extraData: (MintLimitedExtraData*)extraDataDictionary;

- (void)setSessionInterval:(NSInteger)intervalInSeconds;

- (BOOL) isHTTPEventCollectorEnabled;

void MintLog(MintLogLevel logLevel, NSString* message, ...) NS_FORMAT_FUNCTION(2,3);

- (void)addExtraData:(NSString*)value forKey:(NSString *)key;

- (void)addExtraData:(MintLimitedExtraData*)extraDataDictionary;

- (NSString*)extraDataForKey:(NSString *)key;

- (void)removeExtraDataForKey:(NSString*)key;

- (void)removeAllExtraData;

- (NSDictionary*)extraData;

@end