|
5 | 5 |
|
6 | 6 | Copyright: (c) 2014 by Instabug, Inc., all rights reserved.
|
7 | 7 |
|
8 |
| - Version: 3.5 |
| 8 | + Version: 3.6 |
9 | 9 | */
|
10 | 10 |
|
11 | 11 | //===========================================================================================================================================
|
|
38 | 38 | //===========================================================================================================================================
|
39 | 39 | /** @name SDK Pro Features */
|
40 | 40 | //===========================================================================================================================================
|
| 41 | +/** |
| 42 | + * Adds custom logs that will be sent with each report |
| 43 | + * |
| 44 | + * @param format format |
| 45 | + * @param ... ... |
| 46 | + */ |
| 47 | +void IBGLog(NSString *format, ...); |
| 48 | + |
41 | 49 | /**
|
42 | 50 | * Sets the user data that's attached with each bug report sent. Maximum size of the string is 1000 characters
|
43 | 51 | * @param userData userData
|
|
79 | 87 | //===========================================================================================================================================
|
80 | 88 |
|
81 | 89 | //===========================================================================================================================================
|
82 |
| -/** @name SDK Parameters' Initialization */ |
| 90 | +/** @name SDK Functions Customization */ |
83 | 91 | //===========================================================================================================================================
|
84 | 92 | /**
|
85 | 93 | * Sets the event that invocates the feedback form
|
|
89 | 97 | */
|
90 | 98 | + (void)setInvocationEvent:(IBGInvocationEvent)invocationEvent;
|
91 | 99 |
|
92 |
| -/** |
93 |
| - * Sets the locale used to display the strings in the correct language |
94 |
| - * |
95 |
| - * Default is fetched from the device locale |
96 |
| - * @param locale locale |
97 |
| - */ |
98 |
| -+ (void)setLocale:(IBGLocale)locale; |
99 |
| - |
100 | 100 | /**
|
101 | 101 | * Sets whether to track the crashes in the app or not
|
102 | 102 | *
|
|
122 | 122 | + (void)setIsTrackingUserSteps:(BOOL)isTrackingUserSteps;
|
123 | 123 |
|
124 | 124 | /**
|
125 |
| - * Sets whether to show a screenshot to be annotated or not |
| 125 | + * Sets whether to send the crash report immediatly on crash or not. When set to NO, the crash report is sent on the next app launch. |
126 | 126 | *
|
127 |
| - * Default = YES for bug reports, NO for feedback reports |
128 |
| - * @param willShowScreenshotAnnotation willShowScreenshotAnnotation |
| 127 | + * Default = NO |
| 128 | + * @param sendCrashReportsImmendiatly sendCrashReportsImmendiatly |
129 | 129 | */
|
130 |
| -+ (void)setWillShowScreenshotAnnotation:(BOOL)willShowScreenshotAnnotation; |
| 130 | ++ (void)setWillSendCrashReportsImmendiatly:(BOOL)sendCrashReportsImmendiatly; |
131 | 131 |
|
| 132 | +/** |
| 133 | + * Sets the default value of the email field |
| 134 | + * |
| 135 | + * Default = @"" |
| 136 | + * @param defaultEmail defaultEmail |
| 137 | + */ |
| 138 | ++ (void)setDefaultEmail:(NSString *)defaultEmail; |
| 139 | +//=========================================================================================================================================== |
| 140 | + |
| 141 | +//=========================================================================================================================================== |
| 142 | +/** @name SDK Experience Customization */ |
| 143 | +//=========================================================================================================================================== |
132 | 144 | /**
|
133 | 145 | * Sets the default SDK mode upon invocation
|
134 | 146 | *
|
|
137 | 149 | */
|
138 | 150 | + (void)setDefaultInvocationMode:(IBGInvocationMode)invocationMode;
|
139 | 151 |
|
| 152 | +/** |
| 153 | + * Sets whether to show a screenshot to be annotated or not |
| 154 | + * |
| 155 | + * Default = YES for bug reports, NO for feedback reports |
| 156 | + * @param willShowScreenshotAnnotation willShowScreenshotAnnotation |
| 157 | + */ |
| 158 | ++ (void)setWillShowScreenshotAnnotation:(BOOL)willShowScreenshotAnnotation; |
| 159 | + |
140 | 160 | /**
|
141 | 161 | * Sets the default value of whether to ask the user for an email or not
|
142 | 162 | *
|
|
161 | 181 | */
|
162 | 182 | + (void)setCommentIsRequired:(BOOL)commentIsRequired;
|
163 | 183 |
|
164 |
| -/** |
165 |
| - * Sets the default value of the email field |
166 |
| - * |
167 |
| - * Default = @"" |
168 |
| - * @param defaultEmail defaultEmail |
169 |
| - */ |
170 |
| -+ (void)setDefaultEmail:(NSString *)defaultEmail; |
171 |
| - |
172 |
| -/** |
173 |
| - * Sets the placeholder text of the email field |
174 |
| - * |
175 |
| - * Default = @"Enter your email..." |
176 |
| - * @param emailPlaceholder emailPlaceholder |
177 |
| - */ |
178 |
| -+ (void)setEmailPlaceholder:(NSString *)emailPlaceholder; |
179 |
| - |
180 |
| -/** |
181 |
| - * Sets the placeholder text of the comment field |
182 |
| - * |
183 |
| - * Default = @"Enter your feedback..." |
184 |
| - * @param commentPlaceholder commentPlaceholder |
185 |
| - */ |
186 |
| -+ (void)setCommentPlaceholder:(NSString *)commentPlaceholder; |
187 |
| - |
188 | 184 | /**
|
189 | 185 | * Sets the default value of the tutorial alert, that gets shown on launching the first bug report
|
190 | 186 | *
|
|
209 | 205 | */
|
210 | 206 | + (void)setWillShowFeedbackSentAlert:(BOOL)willShowFeedbackSentAlert;
|
211 | 207 |
|
| 208 | +/** |
| 209 | + * Sets the default offset of the floating button from the top of the screen. Different orientations are already handled |
| 210 | + * |
| 211 | + * Default = 50 |
| 212 | + * @param floatingButtonOffsetFromTop floatingButtonOffsetFromTop |
| 213 | + */ |
| 214 | ++ (void)setFloatingButtonOffsetFromTop:(double)floatingButtonOffsetFromTop; |
| 215 | + |
| 216 | +/** |
| 217 | + * Sets the default edge at which the floating button will be shown. Use CGRectMaxXEdge(right) or CGRectMinXEdge(left). Different orientations are already handled |
| 218 | + * |
| 219 | + * Default = CGRectMaxXEdge |
| 220 | + * @param floatingButtonEdge floatingButtonEdge |
| 221 | + */ |
| 222 | ++ (void)setFloatingButtonEdge:(CGRectEdge)floatingButtonEdge; |
| 223 | + |
212 | 224 | /**
|
213 | 225 | * Sets the threshold value of the shake gesture on iPhone/iPod Touch
|
214 | 226 | *
|
|
232 | 244 | * @param willVibrateOnInvocation willVibrateOnInvocation
|
233 | 245 | */
|
234 | 246 | + (void)setWillVibrateOnInvocation:(BOOL)willVibrateOnInvocation;
|
235 |
| - |
236 |
| -/** |
237 |
| - * Sets the default offset of the floating button from the top of the screen. Different orientations are already handled |
238 |
| - * |
239 |
| - * Default = 50 |
240 |
| - * @param floatingButtonOffsetFromTop floatingButtonOffsetFromTop |
241 |
| - */ |
242 |
| -+ (void)setFloatingButtonOffsetFromTop:(double)floatingButtonOffsetFromTop; |
243 |
| - |
244 |
| -/** |
245 |
| - * Sets the default edge at which the floating button will be shown. Use CGRectMaxXEdge(right) or CGRectMinXEdge(left). Different orientations are already handled |
246 |
| - * |
247 |
| - * Default = CGRectMaxXEdge |
248 |
| - * @param floatingButtonEdge floatingButtonEdge |
249 |
| - */ |
250 |
| -+ (void)setFloatingButtonEdge:(CGRectEdge)floatingButtonEdge; |
251 | 247 | //===========================================================================================================================================
|
252 | 248 |
|
253 | 249 | //===========================================================================================================================================
|
|
316 | 312 | */
|
317 | 313 | + (void)setFloatingButtonBackColor:(UIColor *)color;
|
318 | 314 | //===========================================================================================================================================
|
| 315 | + |
| 316 | +//=========================================================================================================================================== |
| 317 | +/** @name SDK Strings Customization */ |
| 318 | +//=========================================================================================================================================== |
| 319 | +/** |
| 320 | + * Sets the locale used to display the strings in the correct language |
| 321 | + * |
| 322 | + * Default is fetched from the device locale |
| 323 | + * @param locale locale |
| 324 | + */ |
| 325 | ++ (void)setLocale:(IBGLocale)locale; |
| 326 | + |
| 327 | +/** |
| 328 | + * Sets the text displayed in the header and the action sheet representing bug reports |
| 329 | + * |
| 330 | + * Default = @"Report a bug" |
| 331 | + * @param bugHeaderText bugHeaderText |
| 332 | + */ |
| 333 | ++ (void)setBugHeaderText:(NSString *)bugHeaderText; |
| 334 | + |
| 335 | +/** |
| 336 | + * Sets the text displayed in the header and the action sheet representing feedback reports |
| 337 | + * |
| 338 | + * Default = @"Send Feedback" |
| 339 | + * @param feedbackHeaderText feedbackHeaderText |
| 340 | + */ |
| 341 | ++ (void)setFeedbackHeaderText:(NSString *)feedbackHeaderText; |
| 342 | + |
| 343 | +/** |
| 344 | + * Sets the placeholder text of the email field |
| 345 | + * |
| 346 | + * Default = @"Enter your email..." |
| 347 | + * @param emailPlaceholder emailPlaceholder |
| 348 | + */ |
| 349 | ++ (void)setEmailPlaceholder:(NSString *)emailPlaceholder; |
| 350 | + |
| 351 | +/** |
| 352 | + * Sets the placeholder text of the comment field |
| 353 | + * |
| 354 | + * Default = @"Enter your feedback..." |
| 355 | + * @param commentPlaceholder commentPlaceholder |
| 356 | + */ |
| 357 | ++ (void)setCommentPlaceholder:(NSString *)commentPlaceholder; |
| 358 | + |
| 359 | +/** |
| 360 | + * Sets the text displayed in the alert shown on startup |
| 361 | + * |
| 362 | + * Default = @"Shake to send feedback" |
| 363 | + * @param startAlertText startAlertText |
| 364 | + */ |
| 365 | ++ (void)setStartAlertText:(NSString *)startAlertText; |
| 366 | + |
| 367 | +/** |
| 368 | + * Sets the text displayed in the alert shown on sending the first report |
| 369 | + * |
| 370 | + * Default = @"Draw on screenshot then add text" |
| 371 | + * @param tutorialAlertText tutorialAlertText |
| 372 | + */ |
| 373 | ++ (void)setTutorialAlertText:(NSString *)tutorialAlertText; |
| 374 | + |
| 375 | +/** |
| 376 | + * Sets the title displayed in the alert shown after sending reports |
| 377 | + * |
| 378 | + * Default = @"Feedback Sent" |
| 379 | + * @param feedbackSentAlertTitle feedbackSentAlertTitle |
| 380 | + */ |
| 381 | ++ (void)setFeedbackSentAlertTitle:(NSString *)feedbackSentAlertTitle; |
| 382 | + |
| 383 | +/** |
| 384 | + * Sets the text displayed in the alert shown after sending reports |
| 385 | + * |
| 386 | + * Default = @"Thank you for helping us improve <App Name>!" |
| 387 | + * @param feedbackSentAlertText feedbackSentAlertText |
| 388 | + */ |
| 389 | ++ (void)setFeedbackSentAlertText:(NSString *)feedbackSentAlertText; |
| 390 | + |
| 391 | +/** |
| 392 | + * Sets the title displayed in the alert shown when an invalid email is entered, and the email field is required |
| 393 | + * |
| 394 | + * Default = @"Invalid Email" |
| 395 | + * @param invalidEmailAlertTitle invalidEmailAlertTitle |
| 396 | + */ |
| 397 | ++ (void)setInvalidEmailAlertTitle:(NSString *)invalidEmailAlertTitle; |
| 398 | + |
| 399 | +/** |
| 400 | + * Sets the text displayed in the alert shown when an invalid email is entered, and the email field is required |
| 401 | + * |
| 402 | + * Default = @"Please enter a valid email" |
| 403 | + * @param invalidEmailAlertText invalidEmailAlertText |
| 404 | + */ |
| 405 | ++ (void)setInvalidEmailAlertText:(NSString *)invalidEmailAlertText; |
| 406 | + |
| 407 | +/** |
| 408 | + * Sets the title displayed in the alert shown when no comment is entered, and the comment field is required |
| 409 | + * |
| 410 | + * Default = @"Invalid Comment" |
| 411 | + * @param invalidCommentAlertTitle invalidCommentAlertTitle |
| 412 | + */ |
| 413 | ++ (void)setInvalidCommentAlertTitle:(NSString *)invalidCommentAlertTitle; |
| 414 | + |
| 415 | +/** |
| 416 | + * Sets the text displayed in the alert shown when no comment is entered, and the comment field is required |
| 417 | + * |
| 418 | + * Default = @"Please enter a valid comment" |
| 419 | + * @param invalidCommentAlertText invalidCommentAlertText |
| 420 | + */ |
| 421 | ++ (void)setInvalidCommentAlertText:(NSString *)invalidCommentAlertText; |
| 422 | + |
| 423 | +/** |
| 424 | + * Sets the text of the OK button that dismisses alerts |
| 425 | + * |
| 426 | + * Default = @"OK" |
| 427 | + * @param okButtonText okButtonText |
| 428 | + */ |
| 429 | ++ (void)setOkButtonText:(NSString *)okButtonText; |
| 430 | + |
| 431 | +/** |
| 432 | + * Sets the text of the submit button that sends reports |
| 433 | + * |
| 434 | + * Default = @"Send" |
| 435 | + * @param submitButtonText submitButtonText |
| 436 | + */ |
| 437 | ++ (void)setSubmitButtonText:(NSString *)submitButtonText; |
| 438 | + |
| 439 | +/** |
| 440 | + * Sets the text of the cancel button that dismisses sending reports |
| 441 | + * |
| 442 | + * Default = @"Cancel" |
| 443 | + * @param cancelButtonText cancelButtonText |
| 444 | + */ |
| 445 | ++ (void)setCancelButtonText:(NSString *)cancelButtonText; |
| 446 | +//=========================================================================================================================================== |
319 | 447 | @end
|
0 commit comments