-
Notifications
You must be signed in to change notification settings - Fork 0
/
TestFairy.h
774 lines (673 loc) · 25.3 KB
/
TestFairy.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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>
#define TF_DEPRECATED(x) __attribute__ ((deprecated(x)))
@protocol TestFairySessionStateDelegate <NSObject>
@optional
/**
* Callback when a session has successfully started on TestFairy.
*/
- (void)sessionStarted;
/**
* Callback when a session failed to started. Could be because the recording
* is set to off, session limit has reached, request rejected or other reasons.
*/
- (void)sessionFailed;
/**
* Callback when session length has reached. For example, if your session
* is set to maximum of 10 minutes, you will get a callback if such a limit
* was reached. You can start a new session if you wish to do so.
*/
- (void)sessionLengthReached:(float)secondsFromStartSession;
/**
* Callback when session recording stopped. Could be because session length
* reached the limit, stop() was called, app moved to background for too long,
* or similar reason.
*/
- (void)sessionStopped;
/**
* Callback when there is an update available. Either this method is called,
* or noAutoUpdateAvailable() is called.
*/
- (void)autoUpdateAvailable:(NSString *)url;
/**
* Callback when a user was presented for a request of an auto-update, and
* then clicked "Yes".
*/
- (void)autoUpdateDownloadStarted;
/**
* Callback when a user was displayed with a dialog asking if they would like to upgrade,
* and they clicked "No".
*/
- (void)autoUpdateDismissed;
/**
* Callback when session start was requested and there was no auto update
* available. In this case, the user will not be displayed with a dialog box. Note
* that sessionFailed() could still be called.
*/
- (void)noAutoUpdateAvailable;
@end
@interface TestFairyFeedbackContent: NSObject
- (instancetype)initWith:(NSString *)text email:(NSString *)email timestamp:(long)timestamp;
- (instancetype)initWith:(NSString *)text email:(NSString *)email timestamp:(long)timestamp bitmap:(UIImage *)bitmap;
- (instancetype)initWith:(NSString *)text email:(NSString *)email timestamp:(long)timestamp bitmap:(UIImage *)bitmap attributes:(NSDictionary *)attributes;
@property(nonatomic, strong, readonly) NSString* text;
@property(nonatomic, strong, readonly) NSString* email;
@property(nonatomic, strong, readonly) UIImage* bitmap;
@property(nonatomic, strong, readonly) NSDictionary* attributes;
@property(nonatomic, readonly) long timestamp;
@end
/**
* Common interface for all custom feedback form fields
*/
@protocol TestFairyFeedbackFormField <NSObject>
/**
* Implement this to return a custom view for the form element
*/
- (UIView *)onCreateView;
/**
* Return the key name for the attribute represented by this form field
*/
- (NSString *)getAttribute;
/**
* Return the value for the attribute respressented by this form field
*/
- (NSString *)getValue;
@end
/**
* A simple form element for editable string inputs
*/
@interface TestFairyStringFeedbackFormField : NSObject<TestFairyFeedbackFormField>
- (instancetype)initWithAttribute:(NSString *)attribute
label:(NSString *)label
placeholder:(NSString *)placeholder
defaultValue:(NSString *)value;
@end
/**
* A simple form element for editable text area.
*/
@interface TestFairyTextAreaFeedbackFormField : NSObject<TestFairyFeedbackFormField>
- (instancetype)initWithAttribute:(NSString *)attribute
placeholder:(NSString *)placeholder
defaultValue:(NSString *)value;
@end
/**
* A dropdown element to represent single choice options, like an HTML select node.
*/
@interface TestFairySelectFeedbackFormField : NSObject<TestFairyFeedbackFormField>
- (instancetype)initWithAttribute:(NSString *)attribute
label:(NSString *)label
values:(NSDictionary *)values
defaultValue:(NSString *)value;
@end
@class TestFairyFeedbackOptionsBuilder;
/**
* Block for reviewing and modify feedback content before it is sent to the server
*/
typedef TestFairyFeedbackContent * (^TestFairyFeedbackInterceptor)(TestFairyFeedbackContent *);
@protocol TestFairyFeedbackVerifier <NSObject>
/**
* A callback from the feedback form to verify the contents that the user
* has inputed. Use this to verify the email address, specific address of the
* content, or any other information available in FeedbackContent.
*
* @param content TestFairyFeedbackContent
* @return YES if verification passed
*/
- (BOOL)verifyFeedback:(TestFairyFeedbackContent *)content;
/**
* A callback to get the error message after a failure from verifyFeedback
* method. This will only be called after verifyFeedback returned NO.
*
* @return Error message to be displayed on screen
*/
- (NSString *)getVerificationFailedMessage;
@end
@interface TestFairyFeedbackOptions: NSObject
/**
* Convenience method for creating TestFairyFeedbackOptions.
*
* TestFairyFeedbackOptions *options = [TestFairyFeedbackOptions createWithBlock:^(TestFairyFeedbackOptionsBuilder * builder) {
* builder.defaultText = @"Some default text";
* builder.isEmailMandatory = NO;
* }];
*
* Note: Developers do not need to call "build" on the TestFairyFeedbackOptionsBuilder. This will be called internally
*/
+ (instancetype)createWithBlock:(void (^)(TestFairyFeedbackOptionsBuilder *))block;
/**
* By setting a default text, you will override the initial content of the text area
* inside the feedback form. This way, you can standardize the way you receive feedbacks
* by specifying guidelines to your users.
*/
@property(readonly, nonatomic, strong) NSString* defaultText;
/**
* Determines whether the user has to add his email address to the feedback. Default is true
*/
@property(readonly, nonatomic) BOOL isEmailMandatory;
/**
* Determines whether the email field is displayed in the feedback form. Default is true
* Note: If set to false, isEmailMandatory will also be set to false.
*/
@property(readonly, nonatomic) BOOL isEmailVisible;
/**
* An optional callback before a feedback is sent. This allows the developer to review
* and modify the contents of the feedback (email, feedback body, attributes, and so on.)
*/
@property(readonly, nonatomic, copy) TestFairyFeedbackInterceptor interceptor;
/**
* By setting this list, feedback forms can be customized with extra input fields.
* Calling with a nil or empty list will enable the default fields, namely email and feedback message.
*/
@property(readonly, nonatomic) NSArray *feedbackFormFields;
/**
* Provide a custom verification class for feedbacks. This allows you
* to control the checks that are done against the feedback's content
* and email address. If not provided, TestFairy will check for valid
* email (if mandatory) and feedback text. By providing your own class,
* you can, for example, add checks for email addresses ending with
* your own company domain.
*/
@property(readonly, nonatomic) id<TestFairyFeedbackVerifier> verifier;
@end
@interface TestFairyFeedbackOptionsBuilder: NSObject
/**
* Create TestFairyFeedbackOptions.
*
* Alternatively, See TestFairyFeedbackOptions#createWithBlock
*/
- (TestFairyFeedbackOptions *)build;
@property(nonatomic, strong) NSString* defaultText;
@property(nonatomic) BOOL isEmailMandatory;
@property(nonatomic) BOOL isEmailVisible;
@property(nonatomic, copy) TestFairyFeedbackInterceptor interceptor;
@property(nonatomic, strong) NSArray *feedbackFormFields;
@property(nonatomic, strong) id<TestFairyFeedbackVerifier> verifier;
@end
@interface TestFairy: NSObject
/**
* Initialize a TestFairy session.
*
* @param appToken Your key as given to you in your TestFairy account
*/
+ (void)begin:(NSString *)appToken;
/**
* Initialize a TestFairy session with options.
*
* @param appToken Your key as given to you in your TestFairy account
* @param options A dictionary of options controlling the current session
* Options include
* - metrics: comma separated string of default metric options such as
* "cpu,memory,network-requests,shake,video,logs"
* - enableCrashReporter: @YES / @NO to enable crash handling. Default is @YES
*/
+ (void)begin:(NSString *)appToken withOptions:(NSDictionary *)options;
/**
* Initialize the TestFairy SDK with only crash handling. No sessions will be recorded.
*/
+ (void)installCrashHandler:(NSString *)appToken;
/**
* Initialize the TestFairy SDK with shake for feedback enabled. No sessions will be recorded.
*/
+ (void)installFeedbackHandler:(NSString *)appToken;
/**
* Initialize the TestFairy SDK with shake for feedback enabled. No sessions will be recorded.
* Enables the ability to present the feedback form
* based on the method given. Valid values include
* "shake", "screenshot" or "shake|screenshot".
*/
+ (void)installFeedbackHandler:(NSString *)appToken method:(NSString *)method;
/**
* Change the server endpoint for use with on-premise hosting. Please
* contact support or sales for more information. Must be called before begin
*
* @param serverOverride server address for use with TestFairy
*/
+ (void)setServerEndpoint:(NSString *)serverOverride;
/**
* Returns SDK version (x.x.x) string
*
* @return version
*/
+ (NSString *)version;
/**
* Hides a specific view from appearing in the video generated.
* Holds a weak reference to the view
*
* @param view The specific view you wish to hide from screenshots
*/
+ (void)hideView:(UIView *)view;
/**
* Removes a view added to hideView. Useful for table views
* which reuse cells, where cells only need to be hidden
* conditionally.
*
* @param view The specific view added to hideView
*/
+ (void)unhideView:(UIView *)view;
/**
* Hides a specific html element from appearing in your WKWebView
*
* @param selector The specific selector you wish to hide from screenshots. Multiple selectors can be comma separated
*/
+ (void)hideWebViewElements:(NSString *)selector;
/**
* Pushes the feedback view controller. Hook a button
* to this method to allow users to provide feedback about the current
* session. All feedback will appear in your build report page, and in
* the recorded session page.
*/
+ (void)pushFeedbackController TF_DEPRECATED("Please refer to showFeedbackForm");
/**
* Programmatically display the feedback form to users.
* Users can provide feedback about the current session.
* All feedback will appear in your build report page,
* and in the recorded session page.
*/
+ (void)showFeedbackForm;
/**
* Displays the feedback form. Allow users to provide
* feedback without prior call to begin. All feedback
* will appear in your build report page, and in
* "Feedbacks" tab.
*
* This method is different from showFeedbackForm by
* that it does not require a call to begin().
*
* @param appToken Your key as given to you in your TestFairy account
* @param takeScreenshot whether screenshot should be automatically added
*/
+ (void)showFeedbackForm:(NSString *)appToken takeScreenshot:(BOOL)takeScreenshot;
/**
* Start collecting feedback by having your users either capture a
* screenshot or recording before filling the Feedback form. All
* feedbacks will appear in your build report page, and on the
* "Feedbacks" tab.
*
* Does not require a call to begin().
*
* @param appToken Your key as given to you in your TestFairy account
* @param intent Either "video" or "screenshot"
*/
+ (void)startFeedback:(NSString *)appToken withIntent:(NSString *)intent;
/**
* Send a feedback on behalf of the user. Call when using a in-house
* feedback view controller with a custom design and feel. Feedback will
* be associated with the current session.
*
* @param feedback Feedback text
*/
+ (void)sendUserFeedback:(NSString *)feedback;
/**
* Send a feedback on behalf of the user. Call when using a in-house
* feedback view controller with a custom design and feel. Feedback will
* be associated with the current session.
*
* @param text Feedback text
*/
+ (void)sendUserFeedback:(NSString *)appToken text:(NSString *)text screenshot:(UIImage *)image;
/**
* Proxy didUpdateLocation delegate values and these
* locations will appear in the recorded sessions. Useful for debugging
* actual long/lat values against what the user sees on screen.
*
* @param locations Array of CLLocation. The first object of the array will determine the user location
*/
+ (void)updateLocation:(NSArray *)locations;
/**
* Marks a checkpoint in session. Use this text to tag a session
* with a checkpoint name. Later you can filter sessions where your
* user passed through this checkpoint.
*
* @param name The checkpoint name
*/
+ (void)checkpoint:(NSString *)name TF_DEPRECATED("Please refer to addEvent:");
/**
* Marks an event in session timeline. Use this text to tag a session
* with an event name. Later you can filter sessions where your
* user passed through this event.
*
* @param name The event name
*/
+ (void)addEvent:(NSString *)name;
/**
* Adds a new user interaction to the timeline. Can be used by non-native UI frameworks to report
* user interactions such as clicks, long-clicks and double clicks.
*
* @param kind Kind of interaction to add [button pressed = 1, button long pressed = 8, button double tapped = 9]
* @param label Text content of the clicked view
* @param info (Optional) Extra meta data, accepted keys are "accessibilityLabel", "accessibilityIdentifier", "accessibilityHint" and "className"
*/
+ (void)addUserInteraction:(int)kind label:(NSString *)label info:(NSDictionary *)info;
/**
* Sets a correlation identifier for this session. This value can
* be looked up via web dashboard. For example, setting correlation
* to the value of the user-id after they logged in. Can be called
* only once per session (subsequent calls will be ignored.)
*
* @param correlationId Id for the current session
*/
+ (void)setCorrelationId:(NSString *)correlationId TF_DEPRECATED("Please refer to setUser:");
/**
* Sets a correlation identifier for this session. This value can
* be looked up via web dashboard. For example, setting correlation
* to the value of the user-id after they logged in. Can be called
* only once per session (subsequent calls will be ignored.)
*
* @param correlationId Id for the current session
*/
+ (void)identify:(NSString *)correlationId TF_DEPRECATED("Please refer to setAttribute: and setUser:");
/**
* Sets a correlation identifier for this session. This value can
* be looked up via web dashboard. For example, setting correlation
* to the value of the user-id after they logged in. Can be called
* only once per session (subsequent calls will be ignored.)
*
* @param correlationId Id for the current session
* @param traits Attributes and custom attributes to be associated with this session
*/
+ (void)identify:(NSString *)correlationId traits:(NSDictionary *)traits TF_DEPRECATED("Please refer to setAttribute:");
/**
* Pauses the current session. This method stops recoding of
* the current session until resume has been called.
*
* @see resume
*/
+ (void)pause;
/**
* Resumes the recording of the current session. This method
* resumes a session after it was paused.
*
* @see pause
*/
+ (void)resume;
/**
* Returns the address of the recorded session on testfairy's
* developer portal. Will return nil if recording not yet started.
*
* @return session URL
*/
+ (NSString *)sessionUrl;
/**
* Takes a screenshot and sends it to TestFairy
*/
+ (void)takeScreenshot;
/**
* Takes a screenshot. Can return nil.
*/
+ (void)takeScreenshot:(void(^)(UIImage *))callback;
/**
* Adds a screenshot to the current moment in session.
* Overrides the current screen recording system
*
* @param image Screenshot to add
*/
+ (void)addScreenshot:(UIImage *)image;
/**
* Set the name of the current screen. Useful for single page
* applications which use a single UIViewController.
*
* @param name logic name of current screen
*/
+ (void)setScreenName:(NSString *)name;
/**
* Stops the current session recording. Unlike 'pause', when
* calling 'resume', a new session will be created and will be
* linked to the previous recording. Useful if you want short
* session recordings of specific use-cases of the app. Hidden
* views and user identity will be applied to the new session
* as well, if started.
*/
+ (void)stop;
/**
* Records a session level attribute which can be looked up via web dashboard.
*
* @param key The name of the attribute. Cannot be nil.
* @param value The value associated with the attribute. Cannot be nil.
* @return YES if successfully set attribute value, NO if failed with error in log.
*
* @note The SDK limits you to storing 64 named attributes. Adding more than 64 will fail and return NO.
*/
+ (BOOL)setAttribute:(NSString *)key withValue:(NSString *)value;
/**
* Records a user identified as an attribute. We recommend passing values such as
* email, phone number, or user id that your app may use.
*
* @param userId The identifying user. Cannot be nil.
*
*/
+ (void)setUserId:(NSString *)userId;
/**
* Remote logging. These logs will be sent to the server,
* but will not appear in the console.
*/
+ (void)log:(NSString *)message;
/**
* Attach a file to the session. A maximum of 5 files may be attached. Each file cannot be more
* than 15 mb in size. In order to see if the file successfully uploads or fails, please view
* the logs.
*
* @param file path to file on disk.
*
*/
+ (void)attachFile:(NSURL *)file;
/**
* Query to see if the previous session crashed. Can be called before or
* after calling begin.
*/
+ (BOOL)didLastSessionCrash;
/**
* Enables the ability to capture crashes. TestFairy
* crash handler is installed by default. Once installed
* it cannot be uninstalled. Must be called before begin.
*/
+ (void)enableCrashHandler;
/**
* Disables the ability to capture crashes. TestFairy
* crash handler is installed by default. Once installed
* it cannot be uninstalled. Must be called before begin.
*/
+ (void)disableCrashHandler;
/**
* Enables recording of a metric regardless of build settings.
* Valid values include "cpu", "memory", "logcat", "battery", "network-requests"
* A metric cannot be enabled and disabled at the same time, therefore
* if a metric is also disabled, the last call to enable to disable wins.
* Must be called be before begin.
*/
+ (void)enableMetric:(NSString *)metric;
/**
* Disables recording of a metric regardless of build settings.
* Valid values include "cpu", "memory", "logcat", "battery", "network-requests"
* A metric cannot be enabled and disabled at the same time, therefore
* if a metric is also disabled, the last call to enable to disable wins.
* Must be called be before begin.
*/
+ (void)disableMetric:(NSString *)metric;
/**
* Enables the ability to capture video recording regardless of build settings.
* Valid values for policy include "always" and "wifi"
* Valid values for quality include "high", "low", "medium"
* Values for fps must be between 0.1 and 2.0. Value will be rounded to
* the nearest frame.
*/
+ (void)enableVideo:(NSString *)policy quality:(NSString *)quality framesPerSecond:(float)fps TF_DEPRECATED("Please refer to enableVideo:");
/**
* Enables the ability to capture video recording regardless of build settings.
* Valid values for policy include "always" and "wifi"
*/
+ (void)enableVideo:(NSString *)policy;
/**
* Disables the ability to capture video recording. Must be
* called before begin.
*/
+ (void)disableVideo;
/**
* Enables the ability to present the feedback form
* based on the method given. Valid values include
* "shake", "screenshot" or "shake|screenshot". If an
* unrecognized method is passed, the value defined in
* the build settings will be used. Must be called before
* begin.
*/
+ (void)enableFeedbackForm:(NSString *) method;
/**
* Disables the ability to present users with feedback when
* devices is shaken, or if a screenshot is taken. Must be called
* before begin.
*/
+ (void)disableFeedbackForm;
/**
* Disable auto updates for this build. Even if there's a newer
* build available through TestFairy, ignore it, and continue
* using the current build. Must be called before begin
*/
+ (void)disableAutoUpdate;
/**
* Sets the maximum recording time. Minimum value is 60 seconds,
* else the value defined in the build settings will be used. The
* maximum value is the lowest value between this value and the
* value defined in the build settings.
* Time is rounded to the nearest minute.
* Must be called before begin.
*/
+ (void)setMaxSessionLength:(float)seconds;
/**
* Determines whether the "email field" in the Feedback form will be visible or not.
* default is true
*
* @param visible BOOL
*/
+ (void)setFeedbackEmailVisible:(BOOL)visible TF_DEPRECATED("Please refer setTestFairyFeedbackOptions");
/**
* Customize the feedback form
*
* Accepted dictionary values: @{
* @"defaultText": @"Default feedback text",
* @"isEmailMandatory": @NO|@YES,
* @"isEmailVisible": @NO|@YES
* }
*
* defaultText: By setting a default text, you will override the initial content of the text area
* inside the feedback form. This way, you can standardize the way you receive feedbacks
* by specifying guidelines to your users.
*
* isEmailMandatory: Determines whether the user has to add his email address to the feedback. Default is true
*
* isEmailVisible: Determines whether the email field is displayed in the feedback form. Default is true
*/
+ (void)setFeedbackOptions:(NSDictionary *)options TF_DEPRECATED("Please refer to setTestFairyFeedbackOptions");
/**
* You can customize the feedback form by creating FeedbackOptions, See TestFairyFeedbackOptions
*/
+ (void)setTestFairyFeedbackOptions:(TestFairyFeedbackOptions *)options;
/**
* Query the distribution status of this build. Distribution is not required
* for working with the TestFairy SDK, meaning, you can use the SDK with the App Store.
*
* The distribution status can be either "enabled" or "disabled", and optionally, can have
* an auto-update. This method is useful if you're using TestFairy in your development
* stage and want to know if you expired the distribution of this version in your dashboard.
*
* Possible response keys:
*
* response[@"status"] = @"enabled" or @"disabled"
* response[@"autoUpdateDownloadUrl"] = @"<url to download url>"
*
* @param appToken App token as used with begin()
* @param callback to receive asynchornous response. Response dictionary can be nil
*/
+ (void)getDistributionStatus:(NSString *)appToken callback:(void(^)(NSDictionary<NSString *, NSString *> *, NSError*))callback;
/**
* Enable end-to-end encryption for this session. Screenshots and logs will be encrypted using
* this RSA key. Please refer to the documentation to learn more about the subject and how
* to create public/private key pair.
*
* @param publicKey RSA Public Key converted to DER format and encoded in base64
*/
+ (void)setPublicKey:(NSString *)publicKey;
/**
* Define whether logs or screenshots are encrypted. Should be called before setPublicKey
*/
+ (void)setEncryptionPolicy:(BOOL)encryptScreenshots encryptLogs:(BOOL)encryptLogs;
/**
* Set the delegate object to listent to TestFairy events. See @TestFairySessionStateDelegate
* for more information
*/
+ (void)setSessionStateDelegate:(id<TestFairySessionStateDelegate>)delegate;
/**
* Log network calls to TestFairy.
*/
+ (void)addNetwork:(NSURLSessionTask *)task error:(NSError *)error;
/**
* Log network calls to TestFairy
*/
+ (void)addNetwork:(NSURL *)url
method:(NSString *)method
code:(int)code
startTimeInMillis:(long)startTime
endTimeInMillis:(long)endTime
requestSize:(long)requestSize
responseSize:(long)responseSize
errorMessage:(NSString*)error;
/**
* Log network calls to TestFairy, include request and response payloads.
*/
+ (void)addNetwork:(NSURL *)url
method:(NSString *)method
code:(int)code
startTimeInMillis:(long)startTime
endTimeInMillis:(long)endTime
requestSize:(long)requestSize
responseSize:(long)responseSize
errorMessage:(NSString*)error
requestHeaders:(NSString*)requestHeaders
requestBody:(NSData *)requestBody
responseHeaders:(NSString *)responseHeaders
responseBody:(NSData*)responseBody;
/**
* Send an NSError to TestFairy.
* Note, this function is limited to 5 errors.
* @param error NSError
* @param trace Stacktrace
*/
+ (void)logError:(NSError *)error stacktrace:(NSArray *)trace;
+ (void)logError:(NSError *)error;
/**
* Force crash (only for testing purposes)
*/
+ (void)crash;
@end
#if __cplusplus
extern "C" {
#endif
/**
* Remote logging, use TFLog as you would use printf. These logs will be sent to the server,
* but will not appear in the console.
*
* @param format sprintf-like format for the arguments that follow
*/
void TFLog(NSString *format, ...) __attribute__((format(__NSString__, 1, 2)));
/**
* Remote logging, use TFLogv as you would use printfv. These logs will be sent to the server,
* but will not appear in the console.
*
* @param format sprintf-like format for the arguments that follow
* @param arg_list list of arguments
*/
void TFLogv(NSString *format, va_list arg_list);
#if __cplusplus
}
#endif
extern NSString *const TFSDKIdentityTraitNameKey;
extern NSString *const TFSDKIdentityTraitEmailAddressKey;
extern NSString *const TFSDKIdentityTraitBirthdayKey;
extern NSString *const TFSDKIdentityTraitGenderKey;
extern NSString *const TFSDKIdentityTraitPhoneNumberKey;
extern NSString *const TFSDKIdentityTraitWebsiteAddressKey;
extern NSString *const TFSDKIdentityTraitAgeKey;
extern NSString *const TFSDKIdentityTraitSignupDateKey;
extern NSString *const TFSDKEnableCrashReporterKey;
extern NSString *const TestFairyDidShakeDevice;
extern NSString *const TestFairyWillProvideFeedback;
extern NSString *const TestFairyDidCancelFeedback;
extern NSString *const TestFairyDidSendFeedback;