✨ showWelcomeMessage API

Author: salmatarzi

android/src/main/java/com/instabug/reactlibrary/RNInstabugReactnativeModule.java

@@ -106,6 +106,11 @@ public class RNInstabugReactnativeModule extends ReactContextBaseJavaModule {
     private final String ENABLED = "enabled";
     private final String DISABLED = "disabled";
 
+    //Instabug welcome message modes
+    private final String WELCOME_MESSAGE_MODE_LIVE = "welcomeMessageModeLive";
+    private final String WELCOME_MESSAGE_MODE_BETA = "welcomeMessageModeBeta";
+    private final String WELCOME_MESSAGE_MODE_DISABLED = "welcomeMessageModeDisabled";
+
     //Theme colors
     private final String COLOR_THEME_LIGHT = "light";
     private final String COLOR_THEME_DARK = "dark";
@@ -1360,6 +1365,31 @@ public void setReproStepsMode(String reproStepsMode) {
         }
     }
 
+    /**
+     * Shows the welcome message in a specific mode.
+     *
+     * @param welcomeMessageMode An enum to set the welcome message mode to
+      *                          live, beta or disabled.
+     */
+    @ReactMethod
+    public void showWelcomeMessageWithMode(String welcomeMessageMode) {
+        try {
+            switch (welcomeMessageMode) {
+                case WELCOME_MESSAGE_MODE_LIVE:
+                    Instabug.showWelcomeMessage(WelcomeMessage.State.LIVE);
+                    break;
+                case WELCOME_MESSAGE_MODE_BETA:
+                    Instabug.showWelcomeMessage(WelcomeMessage.State.BETA);
+                    break;
+                default:
+                    Instabug.showWelcomeMessage(WelcomeMessage.State.LIVE);
+            }
+
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+    }
+
     /**
      * Sets the threshold value of the shake gesture for android devices.
      * Default for android is an integer value equals 350.
@@ -1719,6 +1749,10 @@ public Map<String, Object> getConstants() {
         constants.put("reproStepsEnabled", ENABLED);
         constants.put("reproStepsDisabled", DISABLED);
 
+        constants.put("welcomeMessageModeLive", WELCOME_MESSAGE_MODE_LIVE);
+        constants.put("welcomeMessageModeBeta", WELCOME_MESSAGE_MODE_BETA);
+        constants.put("welcomeMessageModeDisabled", WELCOME_MESSAGE_MODE_DISABLED);
+
         constants.put("allActions", ACTION_TYPE_ALL_ACTIONS);
         constants.put("reportBugAction", ACTION_TYPE_REPORT_BUG);
         constants.put("requestNewFeature", ACTION_TYPE_REQUEST_NEW_FEATURE);

index.js

@@ -215,6 +215,7 @@ module.exports = {
     },
 
     /**
+     * @deprecated Use {@link showWelcomeMessage} instead.
      * Present a view that educates the user on how to invoke the SDK with the
      * currently set invocation event.
      */
@@ -286,6 +287,7 @@ module.exports = {
     },
 
     /**
+     * @deprecated Use {@link setEmailFieldRequiredForActions} instead.
      * Sets whether users are required to enter an email address or not when
      * sending reports.
      * Defaults to YES.
@@ -297,7 +299,6 @@ module.exports = {
     },
 
     /**
-     * @deprecated since version 2.3.0. Use {@link setEnabledAttachmentTypes} instead.
      * Sets whether users are required to enter an email address or not when
      * sending reports.
      * Defaults to YES.
@@ -993,6 +994,16 @@ module.exports = {
          Instabug.setShouldShowSurveysWelcomeScreen(shouldShowWelcomeScreen);
      },
 
+     /**
+      * Shows the welcome message in a specific mode.
+      * @param welcomeMessageMode An enum to set the welcome message mode to
+      *                           live, beta or disabled.
+      *
+      */
+     showWelcomeMessage: function(welcomeMessageMode) {
+        Instabug.showWelcomeMessageWithMode(welcomeMessageMode);
+    },
+
     /**
      * The event used to invoke the feedback form
      * @readonly
@@ -1120,6 +1131,17 @@ module.exports = {
         topLeft: Instabug.topLeft
     },
 
+    /**
+     * The welcome message mode.
+     * @readonly
+     * @enum {number}
+     */
+    welcomeMessageMode: {
+        live: Instabug.welcomeMessageModeLive,
+        beta: Instabug.welcomeMessageModeBeta,
+        disabled: Instabug.welcomeMessageModeDisabled
+    },
+
     /**
      * Instabug action types.
      * @readonly

ios/RNInstabug/InstabugReactBridge.m

@@ -423,7 +423,11 @@ - (dispatch_queue_t)methodQueue {
     }
 
      [Instabug setEmailFieldRequired:isEmailFieldRequired forAction:actionTypes];
-  }
+}
+
+RCT_EXPORT_METHOD(showWelcomeMessageWithMode:(IBGWelcomeMessageMode)welcomeMessageMode) {
+    [Instabug showWelcomeMessageWithMode:welcomeMessageMode];
+}
 
 RCT_EXPORT_METHOD(isRunningLive:(RCTResponseSenderBlock)callback) {
   BOOL result = NO;
@@ -508,6 +512,10 @@ - (NSDictionary *)constantsToExport
               @"enabledWithOptionalFields": @(IBGExtendedBugReportModeEnabledWithOptionalFields),
               @"disabled": @(IBGExtendedBugReportModeDisabled),
 
+              @"welcomeMessageModeLive": @(IBGWelcomeMessageModeLive),
+              @"welcomeMessageModeBeta": @(IBGWelcomeMessageModeBeta),
+              @"welcomeMessageModeDisabled": @(IBGWelcomeMessageModeDisabled),
+
               @"shakeHint": @(IBGStringShakeHint),
               @"swipeHint": @(IBGStringSwipeHint),
               @"edgeSwipeStartHint": @(IBGStringEdgeSwipeStartHint),

ios/RNInstabug/RCTConvert+InstabugEnums.m

@@ -92,6 +92,12 @@ @implementation RCTConvert (InstabugEnums)
                                     @"topLeft": @(IBGPositionTopLeft)
                                     }), IBGPositionBottomRight, integerValue);
 
+RCT_ENUM_CONVERTER(IBGWelcomeMessageMode, (@{
+                                    @"welcomeMessageModeLive": @(IBGWelcomeMessageModeLive),
+                                    @"welcomeMessageModeBeta": @(IBGWelcomeMessageModeBeta),
+                                    @"welcomeMessageModeDisabled": @(IBGWelcomeMessageModeDisabled)
+                                    }), IBGWelcomeMessageModeLive, integerValue);
+
 
 RCT_ENUM_CONVERTER(IBGActionType, (@{
                                     @"allActions": @(IBGActionAllActions),