You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@brief Sets the welcome message mode to live, beta or disabled.
118
-
119
-
@discussion By default, the welcome message live mode is enabled. It appears automatically after 10 seconds from the user's first session. You can change it to the beta mode or disable it.
120
-
The live mode consists of one step to inform the users how to report a bug or feedback. The beta mode consists of three steps to welcome your testers on board, inform them how to report a bug or feedback and to motivate them to always be on the latest app version. Please note, the into message appears only if the invocation event isn't set to none.
115
+
@brief Use to specify different options that would affect how Instabug is shown and other aspects about the reporting experience.
@brief Invokes the SDK manually with the default invocation mode.
@@ -143,15 +140,5 @@ NS_SWIFT_NAME(BugReporting)
143
140
*/
144
141
+ (void)dismiss;
145
142
146
-
/**
147
-
@brief Shows the welcome message in a specific mode.
148
-
149
-
@discussion By default, the welcome message live mode is enabled. It appears automatically after 10 seconds from the user's first session. You can show it manually in a specific mode through this API.
150
-
The live mode consists of one step to inform the users how to report a bug or feedback. The beta mode consists of three steps to welcome your testers on board, inform them how to report a bug or feedback and to motivate them to always be on the latest app version. Please note, the into message appears only if the invocation event isn't set to none.
151
-
152
-
@param welcomeMessageMode An enum to set the welcome message mode to live, beta or disabled.
@brief Sets the welcome message mode to live, beta or disabled.
130
+
131
+
@discussion By default, the welcome message live mode is enabled. It appears automatically after 10 seconds from the user's first session. You can change it to the beta mode or disable it.
132
+
The live mode consists of one step to inform the users how to report a bug or feedback. The beta mode consists of three steps to welcome your testers on board, inform them how to report a bug or feedback and to motivate them to always be on the latest app version. Please note, the into message appears only if the invocation event isn't set to none.
@brief Sets the verbosity level of logs used to debug the Instabug SDK itself.
154
+
155
+
@discussion This API sets the verbosity level of logs used to debug The SDK. The defualt value in debug mode is IBGSDKDebugLogsLevelVerbose and in production is IBGSDKDebugLogsLevelError.
@brief Attaches user data to each report being sent.
247
-
248
-
@discussion Each call to this method overrides the user data to be attached.
249
-
Maximum size of the string is 1,000 characters.
250
-
251
-
@param userData A string to be attached to each report, with a maximum size of 1,000 characters.
252
-
*/
253
-
+ (void)setUserData:(NSString *)userData DEPRECATED_MSG_ATTRIBUTE("This API has been deprecated. See https://docs.instabug.com/v1.0/docs/ios-migration-guide for instructions on migrating to SDK v8.x APIs.");
254
-
255
277
/**
256
278
@brief Sets whether the SDK is tracking user steps or not.
+ (void)setUserStepsEnabled:(BOOL)isUserStepsEnabled DEPRECATED_MSG_ATTRIBUTE("This API has been deprecated. See https://docs.instabug.com/v1.0/docs/ios-migration-guide for instructions on migrating to SDK v8.x APIs.");
266
288
267
-
/**
268
-
@brief Sets whether the session profiler is enabled or disabled.
269
-
270
-
@discussion The session profiler is enabled by default and it attaches to the bug and crash reports the following information during the last 60 seconds before the report is sent.
271
-
1. CPU load.
272
-
2. Dispatch queues latency.
273
-
3. Memory usage.
274
-
4. Storage usage.
275
-
5. Connectivity.
276
-
6. Battery percentage and state.
277
-
7. Orientation.
278
-
279
-
@param sessionProfilerEnabled A boolean parameter to enable or disable the feature.
280
-
*/
281
-
+ (void)setSessionProfilerEnabled:(BOOL)sessionProfilerEnabled DEPRECATED_MSG_ATTRIBUTE("This API has been deprecated. See https://docs.instabug.com/v1.0/docs/ios-migration-guide for instructions on migrating to SDK v8.x APIs.");
282
-
283
289
/**
284
290
@brief Sets whether to track and report crashes or not.
@param welcomeMessageMode An enum to set the welcome message mode to live, beta or disabled.
413
419
*/
414
-
+ (void)showWelcomeMessageWithMode:(IBGWelcomeMessageMode)welcomeMessageMode DEPRECATED_MSG_ATTRIBUTE("This API has been deprecated. See https://docs.instabug.com/v1.0/docs/ios-migration-guide for instructions on migrating to SDK v8.x APIs.");
415
-
416
-
/**
417
-
@brief Sets the welcome message mode to live, beta or disabled.
418
-
419
-
@discussion By default, the welcome message live mode is enabled. It appears automatically after 10 seconds from the user's first session. You can change it to the beta mode or disable it.
420
-
The live mode consists of one step to inform the users how to report a bug or feedback. The beta mode consists of three steps to welcome your testers on board, inform them how to report a bug or feedback and to motivate them to always be on the latest app version. Please note, the into message appears only if the invocation event isn't set to none.
421
-
422
-
@param welcomeMessageMode An enum to set the welcome message mode to live, beta or disabled.
423
-
*/
424
-
+ (void)setWelcomeMessageMode:(IBGWelcomeMessageMode)welcomeMessageMode DEPRECATED_MSG_ATTRIBUTE("This API has been deprecated. See https://docs.instabug.com/v1.0/docs/ios-migration-guide for instructions on migrating to SDK v8.x APIs.");
@param email Email address to be set as the user's email.
440
436
@param name Name of the user to be set.
441
437
*/
442
-
+ (void)identifyUserWithEmail:(NSString *)emailname:(nullable NSString *)name DEPRECATED_MSG_ATTRIBUTE("This API has been deprecated. See https://docs.instabug.com/v1.0/docs/ios-migration-guide for instructions on migrating to SDK v8.x APIs.");
+ (void)setLocale:(IBGLocale)locale DEPRECATED_MSG_ATTRIBUTE("This API has been deprecated. See https://docs.instabug.com/v1.0/docs/ios-migration-guide for instructions on migrating to SDK v8.x APIs.");
611
+
+ (void)setLocale:(IBGLocale)locale;
616
612
617
613
/**
618
614
@brief Sets whether the intro message that gets shown on launching the app is enabled or not.
@param screenshotCapturingHandler A block of code that's going to be used to capture screenshots.
670
666
*/
671
-
+ (void)setScreenshotCapturingHandler:(UIImage *(^)(void))screenshotCapturingHandler DEPRECATED_MSG_ATTRIBUTE("This API has been deprecated. See https://docs.instabug.com/v1.0/docs/ios-migration-guide for instructions on migrating to SDK v8.x APIs.");
@param tags An array of tags to append to current tags.
708
704
*/
709
-
+ (void)appendTags:(NSArray<NSString *> *)tags DEPRECATED_MSG_ATTRIBUTE("This API has been deprecated. See https://docs.instabug.com/v1.0/docs/ios-migration-guide for instructions on migrating to SDK v8.x APIs.");
705
+
+ (void)appendTags:(NSArray<NSString *> *)tags;
710
706
711
707
/**
712
708
@brief Manually removes all tags of reported feedback, bug or crash.
713
709
*/
714
-
+ (void)resetTags DEPRECATED_MSG_ATTRIBUTE("This API has been deprecated. See https://docs.instabug.com/v1.0/docs/ios-migration-guide for instructions on migrating to SDK v8.x APIs.");
710
+
+ (void)resetTags;
715
711
716
712
/**
717
713
@brief Gets all tags of reported feedback, bug or crash.
718
714
719
715
@return An array of tags.
720
716
*/
721
-
+ (NSArray *)getTags DEPRECATED_MSG_ATTRIBUTE("This API has been deprecated. See https://docs.instabug.com/v1.0/docs/ios-migration-guide for instructions on migrating to SDK v8.x APIs.");
717
+
+ (NSArray *)getTags;
722
718
723
719
/**
724
720
@brief Overrides any of the strings shown in the SDK with custom ones.
+ (void)setValue:(NSString *)valueforStringWithKey:(NSString *)key DEPRECATED_MSG_ATTRIBUTE("This API has been deprecated. See https://docs.instabug.com/v1.0/docs/ios-migration-guide for instructions on migrating to SDK v8.x APIs.");
+ (void)setUserAttribute:(NSString *)valuewithKey:(NSString *)key DEPRECATED_MSG_ATTRIBUTE("This API has been deprecated. See https://docs.instabug.com/v1.0/docs/ios-migration-guide for instructions on migrating to SDK v8.x APIs.");
@return The value associated with aKey, or nil if no value is associated with aKey.
856
852
*/
857
-
+ (nullable NSString *)userAttributeForKey:(NSString *)key DEPRECATED_MSG_ATTRIBUTE("This API has been deprecated. See https://docs.instabug.com/v1.0/docs/ios-migration-guide for instructions on migrating to SDK v8.x APIs.");
+ (void)removeUserAttributeForKey:(NSString *)key DEPRECATED_MSG_ATTRIBUTE("This API has been deprecated. See https://docs.instabug.com/v1.0/docs/ios-migration-guide for instructions on migrating to SDK v8.x APIs.");
@return A new dictionary containing all the currently set user attributes, or an empty dictionary if no user attributes have been set.
872
868
*/
873
-
+ (nullable NSDictionary *)userAttributes DEPRECATED_MSG_ATTRIBUTE("This API has been deprecated. See https://docs.instabug.com/v1.0/docs/ios-migration-guide for instructions on migrating to SDK v8.x APIs.");
869
+
+ (nullable NSDictionary *)userAttributes;
874
870
875
871
/**
876
872
@brief Enables/disables inspect view hierarchy when reporting a bug/feedback.
@param deviceToken Device token received in `-[UIApplicationDelegate didRegisterForRemoteNotificationsWithDeviceToken:]`
945
941
*/
946
-
+ (void)didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken DEPRECATED_MSG_ATTRIBUTE("This API has been deprecated. See https://docs.instabug.com/v1.0/docs/ios-migration-guide for instructions on migrating to SDK v8.x APIs.");
+ (void)didReceiveRemoteNotification:(NSDictionary *)userInfo DEPRECATED_MSG_ATTRIBUTE("This API has been deprecated. See https://docs.instabug.com/v1.0/docs/ios-migration-guide for instructions on migrating to SDK v8.x APIs.");
+ (void)logUserEventWithName:(NSString *)name DEPRECATED_MSG_ATTRIBUTE("This API has been deprecated. See https://docs.instabug.com/v1.0/docs/ios-migration-guide for instructions on migrating to SDK v8.x APIs.");
965
+
+ (void)logUserEventWithName:(NSString *)name;
970
966
971
967
/**
972
968
@brief Logs a user event that happens through the lifecycle of the application.
+ (void)showFeatureRequests DEPRECATED_MSG_ATTRIBUTE("This API has been deprecated. See https://docs.instabug.com/v1.0/docs/ios-migration-guide for instructions on migrating to SDK v8.x APIs.");
1298
1294
1299
-
#pragma mark - SDK Debugging
1300
-
1301
-
/// ------------------------
1302
-
/// @name SDK Debugging
1303
-
/// ------------------------
1304
-
1305
-
/**
1306
-
@brief Sets the verbosity level of logs used to debug the Instabug SDK itself.
1307
-
1308
-
@discussion This API sets the verbosity level of logs used to debug The SDK. The defualt value in debug mode is IBGSDKDebugLogsLevelVerbose and in production is IBGSDKDebugLogsLevelError.
0 commit comments