Inherits NSObject, and <RequestWorkerDelegate>.
The BugSenseBase base class.
- (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. |
Appends a LimitedExtraData instance list to the global extra data list.
- Parameters
-
- (void) clearBreadcrumbs |
|
|
|
Clears the global breadcrumb 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) 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. |
- (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) 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
-
- Returns
- A Boolean that indicates whether the instance was removed successfully. If NO, an ExtraData instance with the specified key does not exist.
- (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. |
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 interally 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.
Indicates whether the plugin is initialized and operating properly.
Indicates whether there is an active session. You can close the current session and start a new one as needed.
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: