✨ setExtendedBugReportMode API for Android and iOS

Author: salmatarzi

src/android/IBGPlugin.java

@@ -7,6 +7,7 @@
 
 import com.instabug.library.Feature;
 import com.instabug.library.Instabug;
+import com.instabug.library.extendedbugreport.ExtendedBugReport;
 import com.instabug.library.invocation.InstabugInvocationEvent;
 import com.instabug.library.invocation.InstabugInvocationMode;
 import com.instabug.library.invocation.util.InstabugVideoRecordingButtonCorner;
@@ -169,7 +170,10 @@ public boolean execute(final String action, JSONArray args, final CallbackContex
         } else if ("setAutoScreenRecordingMaxDuration".equals(action)) {
             setAutoScreenRecordingMaxDuration(callbackContext, args.optInt(0));
 
-        } else {
+        } else if ("setExtendedBugReportMode".equals(action)) {
+            setExtendedBugReportMode(callbackContext, args.optString(0));
+
+        }else {
             // Method not found.
             return false;
         }
@@ -244,7 +248,7 @@ private void showIntroDialog(final CallbackContext callbackContext) {
      *
      * @param callbackContext
      *        Used when calling back into JavaScript
-     * @param colorInt
+     * @param colorString
      *        The value of the primary color
      */
     private void setPrimaryColor(final CallbackContext callbackContext, String colorString) {
@@ -706,6 +710,30 @@ private void setVideoRecordingFloatingButtonPosition(final CallbackContext callb
         }
     }
 
+    /**
+     * Sets whether the extended bug report mode should be disabled, enabled with
+     * required fields or enabled with optional fields.
+     *
+     * @param callbackContext
+     *        Used when calling back into JavaScript
+     * @param mode
+     *        A string to disable the extended bug report mode, enable it with
+     *        required or with optional fields
+     */
+    private void setExtendedBugReportMode(final CallbackContext callbackContext, String mode) {
+        try {
+          if(mode.equals("enabledWithRequiredFields")) {
+            Instabug.setExtendedBugReportState(ExtendedBugReport.State.ENABLED_WITH_REQUIRED_FIELDS);
+          } else if(mode.equals("enabledWithOptionalFields")) {
+            Instabug.setExtendedBugReportState(ExtendedBugReport.State.ENABLED_WITH_OPTIONAL_FIELDS);
+          } else if(mode.equals("disabled")) {
+            Instabug.setExtendedBugReportState(ExtendedBugReport.State.DISABLED);
+          }
+        } catch (IllegalStateException e) {
+            callbackContext.error(errorMsg);
+        }
+    }
+
     /**
      * Adds intent extras for all options passed to activate().
      */

src/ios/IBGPlugin.m

@@ -417,6 +417,31 @@ - (void) setReproStepsMode:(CDVInvokedUrlCommand*)command
     [self.commandDelegate sendPluginResult:result callbackId:[command callbackId]];
 }
 
+
+/**
+ * Sets whether the extended bug report mode should be disabled, enabled with
+ * required fields or enabled with optional fields.
+ *
+ * @param {CDVInvokedUrlCommand*} command
+ *        The command sent from JavaScript
+ */
+- (void) setExtendedBugReportMode:(CDVInvokedUrlCommand*)command
+{
+    CDVPluginResult* result;
+
+    IBGExtendedBugReportMode extendedBugReportMode = [self parseExtendedBugReportMode:[command argumentAtIndex:0]];
+
+    if (extendedBugReportMode != -1) {
+        [Instabug setExtendedBugReportMode:extendedBugReportMode];
+        result = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK];
+    } else {
+        result = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR
+                                   messageAsString:@"A valid extended bug report mode must be provided."];
+    }
+
+    [self.commandDelegate sendPluginResult:result callbackId:[command callbackId]];
+}
+
 /**
  * Convenience method for setting whether the email
  * field is validated or not.
@@ -737,6 +762,24 @@ - (IBGUserStepsMode) parseReproStepsMode:(NSString*)mode
     } else return 0;
 }
 
+/**
+ * Convenience method for converting NSString to
+ * IBGExtendedBugReportMode.
+ *
+ * @param  {NSString*} mode
+ *         NSString shortcode for IBGExtendedBugReportMode
+ */
+- (IBGExtendedBugReportMode) parseExtendedBugReportMode:(NSString*)mode
+{
+    if ([mode isEqualToString:@"enabledWithRequiredFields"]) {
+        return IBGExtendedBugReportModeEnabledWithRequiredFields;
+    } else if ([mode isEqualToString:@"enabledWithOptionalFields"]) {
+        return IBGExtendedBugReportModeEnabledWithOptionalFields;
+    } else if ([mode isEqualToString:@"disabled"]) {
+        return IBGExtendedBugReportModeDisabled;
+    } else return -1;
+}
+
 /**
  * Convenience method for converting NSString to
  * IBGLocale.

www/instabug.js

@@ -28,6 +28,14 @@ var getReproStepsMode = function () {
     };
 };
 
+var getExtendedBugReportMode = function () {
+    return {
+        enabledWithRequiredFields: 'enabledWithRequiredFields',
+        enabledWithOptionalFields: 'enabledWithOptionalFields',
+        disabled: 'disabled'
+    };
+};
+
 var getLocales = function () {
     return {
         arabic: 'arabic',
@@ -116,6 +124,17 @@ Instabug.setReproStepsMode = function (reproStepsMode, success, error) {
   }
 };
 
+Instabug.setExtendedBugReportMode = function (extendedBugReportMode, success, error) {
+
+  var validatedExtendedBugReportMode = getExtendedBugReportMode()[extendedBugReportMode];
+
+  if (validatedExtendedBugReportMode) {
+      exec(success, error, 'IBGPlugin', 'setExtendedBugReportMode', [validatedExtendedBugReportMode]);
+  } else {
+      console.log('Could not set extended bug report mode - "' + validatedExtendedBugReportMode + '" is not valid.');
+  }
+};
+
 Instabug.setUserData = function (data, success, error) {
     exec(success, error, 'IBGPlugin', 'setUserData', [data]);
 };