Swiftgram/Classes/BITCrashManagerDelegate.h

101 lines
3.7 KiB
Objective-C

/*
* Author: Andreas Linde <mail@andreaslinde.de>
*
* Copyright (c) 2012 HockeyApp, Bit Stadium GmbH.
* All rights reserved.
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/
#import <Foundation/Foundation.h>
/**
The `BITCrashManagerDelegate` formal protocol defines methods further configuring
the behaviour of `BITCrashManager`.
*/
@protocol BITCrashManagerDelegate <NSObject>
@optional
///-----------------------------------------------------------------------------
/// @name Additional meta data
///-----------------------------------------------------------------------------
/** Return any log string based data the crash report being processed should contain
@param crashReporter The `BITCrashManager` instance invoking this delegate
*/
-(NSString *)applicationLogForCrashReporter:(BITCrashManager *)crashReporter;
///-----------------------------------------------------------------------------
/// @name Alert
///-----------------------------------------------------------------------------
/** Invoked before the user is asked to send a crash report, so you can do additional actions.
E.g. to make sure not to ask the user for an app rating :)
@param crashReporter The `BITCrashManager` instance invoking this delegate
*/
-(void)crashReporterWillShowSubmitCrashReportAlert:(BITCrashManager *)crashReporter;
/** Invoked after the user did choose _NOT_ to send a crash in the alert
@param crashReporter The `BITCrashManager` instance invoking this delegate
*/
-(void)crashReporterWillCancelSendingCrashReport:(BITCrashManager *)crashReporter;
/** Invoked after the user did choose to send crashes always in the alert
@param crashReporter The `BITCrashManager` instance invoking this delegate
*/
-(void)crashReporterWillSendCrashReportsAlways:(BITCrashManager *)crashReporter;
///-----------------------------------------------------------------------------
/// @name Networking
///-----------------------------------------------------------------------------
/** Invoked right before sending crash reports will start
@param crashReporter The `BITCrashManager` instance invoking this delegate
*/
- (void)crashReporterWillSendCrashReport:(BITCrashManager *)crashReporter;
/** Invoked after sending crash reports failed
@param crashReporter The `BITCrashManager` instance invoking this delegate
@param error The error returned from the NSURLConnection call or `kBITCrashErrorDomain`
with reason of type `BITCrashErrorReason`.
*/
- (void)crashReporter:(BITCrashManager *)crashReporter didFailWithError:(NSError *)error;
/** Invoked after sending crash reports succeeded
@param crashReporter The `BITCrashManager` instance invoking this delegate
*/
- (void)crashReporterDidFinishSendingCrashReport:(BITCrashManager *)crashReporter;
@end