MintBase Class Reference

Inherits NSObject, and <RequestWorkerDelegate>.

Inherited by Mint.

Instance Methods
(id)	- initWithRequestWorker:
(void)	- disableCrashReporter
(void)	- flushAsyncWithBlock:
(void)	- initAndStartSession:
(void)	- addExtraData:
(void)	- addExtraDataList:
(BOOL)	- removeExtraDataWithKey:
(void)	- clearExtraData
(void)	- leaveBreadcrumb:
(void)	- clearBreadcrumbs
(void)	- logEventAsyncWithTag:completionBlock:
(void)	- logEventAsyncWithTag:extraDataKey:extraDataValue:completionBlock:
(void)	- logEventAsyncWithTag:limitedExtraDataList:completionBlock:
(void)	- startSessionAsyncWithCompletionBlock:
(void)	- closeSessionAsyncWithCompletionBlock:
(void)	- logExceptionAsync:extraDataKey:extraDataValue:completionBlock:
(void)	- logExceptionAsync:limitedExtraDataList:completionBlock:
(id)	- initWithRequestJsonSerializer:contentTypeResolver:requestWorker:andServiceRepository:
(void)	- disableNetworkMonitoring
(NSDictionary *)	- getDevSettings
(void)	- enableMintLoggingCache:
(void)	- enableLogging:
(void)	- enableFlushOnlyOverWiFi:
(void)	- setLogging:
(void)	- transactionStart:andResultBlock:
(void)	- transactionStart:extraDataKey:extraDataValue:andResultBlock:
(void)	- transactionStart:limitedExtraDataList:andResultBlock:
(void)	- transactionStop:andResultBlock:
(void)	- transactionStop:extraDataKey:extraDataValue:andResultBlock:
(void)	- transactionStop:limitedExtraDataList:andResultBlock:
(void)	- transactionCancel:reason:andResultBlock:
(void)	- transactionCancel:extraDataKey:extraDataValue:reason:andResultBlock:
(void)	- transactionCancel:limitedExtraDataList:reason:andResultBlock:
(void)	- addURLToBlackList:
(NSMutableArray *)	- blacklistUrls
(void)	- logEventAsyncWithName:logLevel:andCompletionBlock:
(void)	- logEventAsyncWithName:logLevel:extraDataKey:extraDataValue:andCompletionBlock:
(void)	- logEventAsyncWithName:logLevel:limitedExtraDataList:andCompletionBlock:
(void)	- xamarinLogException:andCompletionBlock:
(MintLogResult *)	- xamarinLogException:
(NSString *)	- exceptionFixtureFrom:

Properties
id< RequestWorkerFacadeDelegate >	splunkRequestWorker
BOOL	isInitialized
BOOL	isSessionActive
NSString *	userIdentifier
BOOL	handleWhileDebugging
LimitedExtraDataList *	extraDataList
id< MintNotificationDelegate >	notificationDelegate

Detailed Description

The MintBase base class.

Method Documentation

- (void) addExtraData:

(ExtraData *)

extraData

Deprecated for Splunk MINT. This method is used only by the BugSense plugin.

Parameters

success	A block that is invoked when the request finishes successfully, providing the last crash ID of the server.
failure	A failure block that is invoked when something goes wrong with the request. Deprecated for Splunk MINT. This method is used only by the BugSense plugin.
success	A block that is invoked when the request finishes with successfully, providing the total number of crashes of the app since the last reset.
failure	A failure block that is invoked when something goes wrong with the request. Deprecated for Splunk MINT. This method is used only by the BugSense plugin.
success	A Boolean value indicating whether the request was successful.
failure	A failure block that is invoked when something goes wrong with the request. Adds an ExtraData instance to the global extra data list.
extraData	The ExtraData instance.

- (void) addExtraDataList:

(LimitedExtraDataList *)

limitedExtraDataList

Appends a LimitedExtraData instance list to the global extra data list.

Parameters

limitedExtraDataList

The LimitedExtraDataList instance.

- (void) addURLToBlackList:

(NSString *)

url

Adds a URL to the network monitoring blacklist.

Parameters

url	The URL to ignore. This can be a partial URL.

- (NSMutableArray*) blacklistUrls

The URLs blacklisted from network interception.

Returns

NSMutableArray of NSString

- (void) clearBreadcrumbs

Clears the global breadcrumb list.

- (void) clearExtraData

Clears the LimitedExtraDataList instances from the global extra data list.

- (void) closeSessionAsyncWithCompletionBlock:

(LogResultBlock)

completed

Closes a session. All requests and crash reporting will continue to work properly, but the session is no longer logically active.

Parameters

completed

A block that is invoked upon completion with additional information.

- (void) disableNetworkMonitoring

Disables network monitoring. Call this method before calling initAndStartSession.

- (void) enableFlushOnlyOverWiFi:

(BOOL)

enable

Indicates whether to only send data over a WiFi connection.

Parameters

enable

YES to send data only over WiFi.

- (void) enableLogging:

(BOOL)

enable

Indicates whether to attach device logs to the crash.

Parameters

enable

YES to attach device logs.

- (void) enableMintLoggingCache:

(BOOL)

enable

Indicates whether to enable logging. When YES, NSLog console messages are cached and sent with the exception.

Parameters

enable

Indicates whether to enable logging.

- (NSString*) exceptionFixtureFrom:

(NSException *)

exception

Gets an ExceptionDataFixture from an NSException.

Parameters

exception

The NSException.

Returns

The ExceptionDataFixture JSON string model.

- (void) flushAsyncWithBlock:

(ResponseResultBlock)

resultBlock

Sends all cached requests to the server.

Parameters

resultBlock

A block that you get from a MintResponseResult instance to examine related information.

- (NSDictionary*) getDevSettings

Gets the developer's remote settings as key-value pairs.

Returns

A dictionary of key-value pairs.

- (void) initAndStartSession:

(NSString *)

apiKey

Initializes the plugin and starts a session.

Parameters

apiKey

Your Splunk MINT API key.

- (id) initWithRequestWorker:

(id< RequestWorkerFacadeDelegate >)

requestWorker

Deprecated for Splunk MINT. This method is used only by the BugSense plugin. Deprecated for Splunk MINT. This method is used only by the BugSense plugin. This method is for internal SDK initialization and should never used by the developer.

Parameters

requestWorker

A RequestWorkerFacadeDelegate instance.

Returns

A MintBase instance.

- (void) leaveBreadcrumb:

(NSString *)

crumb

Adds a breadcrumb description to the global breadcrumb list.

Parameters

crumb

The breadcrumb description.

- (void) logEventAsyncWithName:		(NSString *)	name
logLevel:		(MintLogLevel)	logLevel
andCompletionBlock:		(LogResultBlock)	completed

Logs an event with a log level, sends the log entry to the console window, and caches a request to send to the server.

Parameters

name	The name of the event (up to 256 characters).
logLevel	The MintLogLevel enumeration value for the log level.
completed	The block to invoke with additional information when complete.

- (void) logEventAsyncWithTag:		(NSString *)	tag
completionBlock:		(LogResultBlock)	completed

Logs an event request with a tag description.

Parameters

tag	The tag description.
completed	A block that is invoked upon completion with additional information.

- (void) logExceptionAsync:		(NSException *)	exception
extraDataKey:		(NSString *)	key
extraDataValue:		(NSString *)	value
completionBlock:		(LogResultBlock)	completed

Logs a handled exception in your try/catch block.

Parameters

exception	The NSException instance.
key	The key for the additional extra data to attach to the request.
value	The value of the additional extra data to attach to the request.
completed	A block that is invoked upon completion with additional information.

- (void) logExceptionAsync:		(NSException *)	exception
limitedExtraDataList:		(LimitedExtraDataList *)	extraDataList
completionBlock:		(LogResultBlock)	completed

Logs a handled exception in your try/catch block.

Parameters

exception	The NSException instance.
limitedExtraDataList	A LimitedExtraDataList instance to attach to the request.
completed	A block that is invoked upon completion with additional information.

- (BOOL) removeExtraDataWithKey:

(NSString *)

key

Removes an ExtraData instance from the global extra data list.

Parameters

key	The key of the ExtraData instance.

Returns

A Boolean that indicates whether the instance was removed successfully. If NO, an ExtraData instance with the specified key does not exist.

- (void) setLogging:

(NSInteger)

linesCount

Sets the maximum number of lines to cache from the console log.

Parameters

lines

The number of lines.

- (void) startSessionAsyncWithCompletionBlock:

(ResponseResultBlock)

completed

Starts a new session. If a previous session was initialized less than one minute earlier, this call is ignored.

Parameters

completed

A block that is invoked upon completion with additional information.

- (void) transactionCancel:		(NSString *)	transactionName
reason:		(NSString *)	aReason
andResultBlock:		(TransactionStopResultBlock)	resultBlock

Cancels a transaction.

Parameters

transactionName	The name of the transaction.
aReason	The reason for cancelling the transaction.
resultBlock	The block to invoke with additional information when complete.

- (void) transactionStart:		(NSString *)	transactionName
andResultBlock:		(TransactionStartResultBlock)	resultBlock

Starts a transaction with a unique name.

Parameters

transactionName	The unique transaction name.
resultBlock	The block to invoke with additional information when complete.

- (void) transactionStop:		(NSString *)	transactionName
andResultBlock:		(TransactionStopResultBlock)	resultBlock

Stops a transaction.

Parameters

transactionName	The name of the transaction.
resultBlock	The block to invoke with additional information when complete.

- (MintLogResult*) xamarinLogException:

(NSException *)

exception

Helper Xamarin method for logging exceptions as unhandled.

Parameters

exception

The NSException thrown.

- (void) xamarinLogException:		(NSException *)	exception
andCompletionBlock:		(LogResultBlock)	completed

Helper Xamarin method for logging exceptions as unhandled.

Parameters

exception

The NSException thrown.

Property Documentation

- (LimitedExtraDataList*) extraDataList

readwritenonatomicstrong

Deprecated for Splunk MINT. This value is used only by the BugSense plugin. A LimitedExtraDataList instance where you can set global extra data (ExtraData instances) and attach them to the handled exception requests.

- (BOOL) handleWhileDebugging

readwritenonatomicassign

A value that is set internally and used only by the SDK plugin. Set this value to NO when you don't want requests to be logged and sent to the server. The default value is YES.

- (BOOL) isInitialized

readwritenonatomicassign

Indicates whether the plugin is initialized and operating properly.

- (BOOL) isSessionActive

readwritenonatomicassign

Indicates whether there is an active session. You can close the current session and start a new one as needed.

- (id<MintNotificationDelegate>) notificationDelegate

readwritenonatomicweak

Sends messages to the delegate and notifies you when any actions are taken by the plugin. This value is not set by the developer.

- (id<RequestWorkerFacadeDelegate>) splunkRequestWorker

readwritenonatomicstrong

Used internally for derived classes.

- (NSString*) userIdentifier

readwritenonatomicstrong

Sets a user identifier such as a random ID, an email address, or a username for the current user.

---

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

• MintBase.h