Nextrek
@ 585
Nextrek / iOS / SafariArte / trunk / Pods / Crashlytics / Crashlytics.framework / Headers / Crashlytics.h
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 |
// // Crashlytics.h // Crashlytics // // Copyright (c) 2015 Crashlytics, Inc. All rights reserved. // #import <Foundation/Foundation.h> #import <Fabric/FABAttributes.h> #import "CLSLogging.h" #import "CLSReport.h" #import "CLSStackFrame.h" #import "Answers.h" #define CLS_DEPRECATED(x) __attribute__ ((deprecated(x))) FAB_START_NONNULL @protocol CrashlyticsDelegate; /** * Crashlytics. Handles configuration and initialization of Crashlytics. */ @interface Crashlytics : NSObject @property (nonatomic, readonly, copy) NSString *APIKey; @property (nonatomic, readonly, copy) NSString *version; @property (nonatomic, assign) BOOL debugMode; /** * * The delegate can be used to influence decisions on reporting and behavior, as well as reacting * to previous crashes. * * Make certain that the delegate is setup before starting Crashlytics with startWithAPIKey:... or * via +[Fabric with:...]. Failure to do will result in missing any delegate callbacks that occur * synchronously during start. * **/ @property (nonatomic, assign) id <CrashlyticsDelegate> FAB_NULLABLE delegate; /** * The recommended way to install Crashlytics into your application is to place a call to +startWithAPIKey: * in your -application:didFinishLaunchingWithOptions: or -applicationDidFinishLaunching: * method. * * Note: Starting with 3.0, the submission process has been significantly improved. The delay parameter * is no longer required to throttle submissions on launch, performance will be great without it. * * @param apiKey The Crashlytics API Key for this app * * @return The singleton Crashlytics instance */ + (Crashlytics *)startWithAPIKey:(NSString *)apiKey; + (Crashlytics *)startWithAPIKey:(NSString *)apiKey afterDelay:(NSTimeInterval)delay CLS_DEPRECATED("Crashlytics no longer needs or uses the delay parameter. Please use +startWithAPIKey: instead."); /** * If you need the functionality provided by the CrashlyticsDelegate protocol, you can use * these convenience methods to activate the framework and set the delegate in one call. * * @param apiKey The Crashlytics API Key for this app * @param delegate A delegate object which conforms to CrashlyticsDelegate. * * @return The singleton Crashlytics instance */ + (Crashlytics *)startWithAPIKey:(NSString *)apiKey delegate:(id<CrashlyticsDelegate> FAB_NULLABLE)delegate; + (Crashlytics *)startWithAPIKey:(NSString *)apiKey delegate:(id<CrashlyticsDelegate> FAB_NULLABLE)delegate afterDelay:(NSTimeInterval)delay CLS_DEPRECATED("Crashlytics no longer needs or uses the delay parameter. Please use +startWithAPIKey:delegate: instead."); /** * Access the singleton Crashlytics instance. * * @return The singleton Crashlytics instance */ + (Crashlytics *)sharedInstance; /** * The easiest way to cause a crash - great for testing! */ - (void)crash; /** * The easiest way to cause a crash with an exception - great for testing. */ - (void)throwException; /** * Specify a user identifier which will be visible in the Crashlytics UI. * * Many of our customers have requested the ability to tie crashes to specific end-users of their * application in order to facilitate responses to support requests or permit the ability to reach * out for more information. We allow you to specify up to three separate values for display within * the Crashlytics UI - but please be mindful of your end-user's privacy. * * We recommend specifying a user identifier - an arbitrary string that ties an end-user to a record * in your system. This could be a database id, hash, or other value that is meaningless to a * third-party observer but can be indexed and queried by you. * * Optionally, you may also specify the end-user's name or username, as well as email address if you * do not have a system that works well with obscured identifiers. * * Pursuant to our EULA, this data is transferred securely throughout our system and we will not * disseminate end-user data unless required to by law. That said, if you choose to provide end-user * contact information, we strongly recommend that you disclose this in your application's privacy * policy. Data privacy is of our utmost concern. * * @param identifier An arbitrary user identifier string which ties an end-user to a record in your system. */ - (void)setUserIdentifier:(NSString * FAB_NULLABLE)identifier; /** * Specify a user name which will be visible in the Crashlytics UI. * Please be mindful of your end-user's privacy and see if setUserIdentifier: can fulfil your needs. * @see setUserIdentifier: * * @param name An end user's name. */ - (void)setUserName:(NSString * FAB_NULLABLE)name; /** * Specify a user email which will be visible in the Crashlytics UI. * Please be mindful of your end-user's privacy and see if setUserIdentifier: can fulfil your needs. * * @see setUserIdentifier: * * @param email An end user's email address. */ - (void)setUserEmail:(NSString * FAB_NULLABLE)email; + (void)setUserIdentifier:(NSString * FAB_NULLABLE)identifier CLS_DEPRECATED("Please access this method via +sharedInstance"); + (void)setUserName:(NSString * FAB_NULLABLE)name CLS_DEPRECATED("Please access this method via +sharedInstance"); + (void)setUserEmail:(NSString * FAB_NULLABLE)email CLS_DEPRECATED("Please access this method via +sharedInstance"); /** * Set a value for a for a key to be associated with your crash data which will be visible in the Crashlytics UI. * When setting an object value, the object is converted to a string. This is typically done by calling * -[NSObject description]. * * @param value The object to be associated with the key * @param key The key with which to associate the value */ - (void)setObjectValue:(id FAB_NULLABLE)value forKey:(NSString *)key; /** * Set an int value for a key to be associated with your crash data which will be visible in the Crashlytics UI. * * @param value The integer value to be set * @param key The key with which to associate the value */ - (void)setIntValue:(int)value forKey:(NSString *)key; /** * Set an BOOL value for a key to be associated with your crash data which will be visible in the Crashlytics UI. * * @param value The BOOL value to be set * @param key The key with which to associate the value */ - (void)setBoolValue:(BOOL)value forKey:(NSString *)key; /** * Set an float value for a key to be associated with your crash data which will be visible in the Crashlytics UI. * * @param value The float value to be set * @param key The key with which to associate the value */ - (void)setFloatValue:(float)value forKey:(NSString *)key; + (void)setObjectValue:(id FAB_NULLABLE)value forKey:(NSString *)key CLS_DEPRECATED("Please access this method via +sharedInstance"); + (void)setIntValue:(int)value forKey:(NSString *)key CLS_DEPRECATED("Please access this method via +sharedInstance"); + (void)setBoolValue:(BOOL)value forKey:(NSString *)key CLS_DEPRECATED("Please access this method via +sharedInstance"); + (void)setFloatValue:(float)value forKey:(NSString *)key CLS_DEPRECATED("Please access this method via +sharedInstance"); /** * This method can be used to record a single exception structure in a report. This is particularly useful * when your code interacts with non-native languages like Lua, C#, or Javascript. This call can be * expensive and should only be used shortly before process termination. This API is not intended be to used * to log NSException objects. All safely-reportable NSExceptions are automatically captured by * Crashlytics. * * @param name The name of the custom exception * @param reason The reason this exception occured * @param frameArray An array of CLSStackFrame objects */ - (void)recordCustomExceptionName:(NSString *)name reason:(NSString * FAB_NULLABLE)reason frameArray:(NSArray *)frameArray; - (void)logEvent:(NSString *)eventName CLS_DEPRECATED("Please refer to Answers +logCustomEventWithName:"); - (void)logEvent:(NSString *)eventName attributes:(NSDictionary * FAB_NULLABLE) attributes CLS_DEPRECATED("Please refer to Answers +logCustomEventWithName:"); + (void)logEvent:(NSString *)eventName CLS_DEPRECATED("Please refer to Answers +logCustomEventWithName:"); + (void)logEvent:(NSString *)eventName attributes:(NSDictionary * FAB_NULLABLE) attributes CLS_DEPRECATED("Please refer to Answers +logCustomEventWithName:"); @end /** * * The CrashlyticsDelegate protocol provides a mechanism for your application to take * action on events that occur in the Crashlytics crash reporting system. You can make * use of these calls by assigning an object to the Crashlytics' delegate property directly, * or through the convenience +startWithAPIKey:delegate: method. * */ @protocol CrashlyticsDelegate <NSObject> @optional - (void)crashlyticsDidDetectCrashDuringPreviousExecution:(Crashlytics *)crashlytics CLS_DEPRECATED("Please refer to -crashlyticsDidDetectReportForLastExecution:"); - (void)crashlytics:(Crashlytics *)crashlytics didDetectCrashDuringPreviousExecution:(id <CLSCrashReport>)crash CLS_DEPRECATED("Please refer to -crashlyticsDidDetectReportForLastExecution:"); /** * * Called when a Crashlytics instance has determined that the last execution of the * application ended in a crash. This is called synchronously on Crashlytics * initialization. Your delegate must invoke the completionHandler, but does not need to do so * synchronously, or even on the main thread. Invoking completionHandler with NO will cause the * detected report to be deleted and not submitted to Crashlytics. This is useful for * implementing permission prompts, or other more-complex forms of logic around submitting crashes. * * @warning Failure to invoke the completionHandler will prevent submissions from being reported. Watch out. * * @warning Just implementing this delegate method will disable all forms of synchronous report submission. This can * impact the reliability of reporting crashes very early in application launch. * * @param report The CLSReport object representing the last detected crash * @param completionHandler The completion handler to call when your logic has completed. * */ - (void)crashlyticsDidDetectReportForLastExecution:(CLSReport *)report completionHandler:(void (^)(BOOL submit))completionHandler; /** * If your app is running on an OS that supports it (OS X 10.9+, iOS 7.0+), Crashlytics will submit * most reports using out-of-process background networking operations. This results in a significant * improvement in reliability of reporting, as well as power and performance wins for your users. * If you don't want this functionality, you can disable by returning NO from this method. * * @warning Background submission is not supported for extensions on iOS or OS X. * * @param crashlytics The Crashlytics singleton instance * * @return Return NO if you don't want out-of-process background network operations. * */ - (BOOL)crashlyticsCanUseBackgroundSessions:(Crashlytics *)crashlytics; @end /** * `CrashlyticsKit` can be used as a parameter to `[Fabric with:@[CrashlyticsKit]];` in Objective-C. In Swift, use Crashlytics.sharedInstance() */ #define CrashlyticsKit [Crashlytics sharedInstance] FAB_END_NONNULL |
Commits for Nextrek/iOS/SafariArte/trunk/Pods/Crashlytics/Crashlytics.framework/Headers/Crashlytics.h
Revision | Author | Commited | Message |
---|---|---|---|
585 | FAquili | Thu 27 Aug, 2015 09:30:10 +0000 | FOLDER UPDATE AFTER CRASHLYTHICS UPDATE |