@selligent-marketing-cloud/selligent-react-native 3.5.1 → 3.6.0

package/README.md

@@ -10,7 +10,7 @@ This module supports the following SDK and tools:
 
 | SDK                                                                            | Version |
 | ------------------------------------------------------------------------------ | ------- |
-| [Android SDK](https://github.com/SelligentMarketingCloud/MobileSDK-Android)    | 4.4.0   |
+| [Android SDK](https://github.com/SelligentMarketingCloud/MobileSDK-Android)    | 4.4.1   |
 | [iOS SDK](https://github.com/SelligentMarketingCloud/MobileSDK-iOS)            | 3.8.1   |
 | ReactNative                                                                    | 0.72.4  |
 | Expo SDK                                                                       | 49      |

package/android/build.gradle

@@ -63,7 +63,7 @@ dependencies {
         exclude group:'com.facebook.fbjni'
         exclude group:'com.facebook.yoga'
     }
-    implementation 'com.selligent.sdk:selligent_mobile_sdk:4.4.0'
+    implementation 'com.selligent.sdk:selligent_mobile_sdk:4.4.1'
     implementation 'com.google.code.gson:gson:2.9.0'
     implementation 'com.google.firebase:firebase-messaging:23.2.1'
     implementation 'androidx.work:work-runtime:2.8.1'

package/android/src/main/java/com/selligent/RNSelligent.java

@@ -31,6 +31,7 @@ import com.facebook.react.modules.core.DeviceEventManagerModule;
 import com.google.gson.Gson;
 import com.google.gson.reflect.TypeToken;
 import com.selligent.rnmobilesdk.BroadcastEventType;
+import com.selligent.rnmobilesdk.ButtonAction;
 import com.selligent.rnmobilesdk.ButtonBroadcastEventDataParser;
 import com.selligent.rnmobilesdk.DeviceIdBroadcastEventDataParser;
 import com.selligent.rnmobilesdk.Event;
@@ -64,6 +65,7 @@ public class RNSelligent extends ReactContextBaseJavaModule implements Lifecycle
     EventReceiver eventReceiver;
     SMForegroundGcmBroadcastReceiver receiver;
     private static SMInAppRefreshType inAppMessageRefreshType;
+    private static boolean inAppMessageCustomUi;
 
     public static final String REACT_CLASS = "SelligentReactNative"; // for logging purposes
 
@@ -108,9 +110,10 @@ public class RNSelligent extends ReactContextBaseJavaModule implements Lifecycle
             final Settings settings = Settings.fromHashMap(settingsHashMap);
             final SMSettings smSettings = SMSettingsFactory.getSMSettings(settings);
             final String notificationActivityName = settings.getActivityName();
-
+            
             SMManager.NOTIFICATION_ACTIVITY = getActivityClass(notificationActivityName);
             inAppMessageRefreshType = settings.getInAppMessageRefreshType().getSmInAppRefreshType();
+            inAppMessageCustomUi = settings.getCustomInAppUi();
 
             final SMManager smManager = getSMManager();
             SMManager.DEBUG = BuildConfig.BUILD_TYPE.equals("debug") || settings.getEnableAndroidLogging();
@@ -225,7 +228,7 @@ public class RNSelligent extends ReactContextBaseJavaModule implements Lifecycle
                         buttonMap.putString("id", button.id);
                         buttonMap.putString("value", button.value);
                         buttonMap.putString("label", button.label);
-                        buttonMap.putInt("type", button.type);
+                        buttonMap.putInt("type", ButtonAction.valueOf(button.action).getValue());
 
                         buttonsArray.pushMap(buttonMap);
                     }
@@ -605,9 +608,9 @@ public class RNSelligent extends ReactContextBaseJavaModule implements Lifecycle
             {
                 receiver = new SMForegroundGcmBroadcastReceiver(currentActivity);
             }
-            currentActivity.registerReceiver(receiver, receiver.getIntentFilter());
 
-            smManager.checkAndDisplayMessage(currentActivity.getIntent(), currentActivity);
+            currentActivity.registerReceiver(receiver, receiver.getIntentFilter());
+            this.DisplayInAppMessage(currentActivity.getIntent(), currentActivity);
         }
     }
 
@@ -629,10 +632,26 @@ public class RNSelligent extends ReactContextBaseJavaModule implements Lifecycle
 
         if (currentActivity != null) {
             currentActivity.setIntent(intent);
-            smManager.checkAndDisplayMessage(intent, currentActivity);
+            this.DisplayInAppMessage(intent, currentActivity);
         }
     }
 
     @Override
     public void onActivityResult(Activity activity, int requestCode, int resultCode, Intent data) { }
+    
+    private void DisplayInAppMessage(Intent intent, Activity currentActivity) {
+        smManager.checkAndDisplayMessage(intent, currentActivity, message -> {
+            if (!inAppMessageCustomUi) {
+                return true;
+            }
+
+            DeviceEventManagerModule.RCTDeviceEventEmitter rctDeviceEventEmitter = reactContext.getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter.class);
+            InAppMessageBroadcastEventDataParser inAppDataParser = new InAppMessageBroadcastEventDataParser();
+            String eventName = BroadcastEventType.DisplayingInAppMessage.getBroadcastEventType();
+            WritableMap data = inAppDataParser.wrap(message);
+            rctDeviceEventEmitter.emit(eventName, getBroadcastData(eventName, data));
+
+            return false;
+        });
+    }
 }

package/constants.d.ts

@@ -74,4 +74,5 @@ export namespace BroadcastEventType {
   const RECEIVED_REMOTE_NOTIFICATION = "ReceivedRemoteNotification";
   const UNIVERSAL_LINK_EXECUTED = "UniversalLinkExecuted";
   const TRIGGERED_CUSTOM_EVENT = "TriggeredCustomEvent";
+  const DISPLAYING_IN_APP_MESSAGE = "DisplayingInAppMessage";
 }

package/constants.js

@@ -174,7 +174,9 @@ const SelligentConstants = {
 		/** Received an universal link execution */
 		UNIVERSAL_LINK_EXECUTED: "UniversalLinkExecuted",
 		/** A custom event has been triggered */
-		TRIGGERED_CUSTOM_EVENT: "TriggeredCustomEvent"
+		TRIGGERED_CUSTOM_EVENT: "TriggeredCustomEvent",
+		/** An IAM is about to be displayed (when `customInAppUi` is set to `true` in `selligent.json`) */
+		DISPLAYING_IN_APP_MESSAGE: "DisplayingInAppMessage"
 	},
 
 };

package/documentation/README.md

@@ -66,6 +66,7 @@ The following properties can be used in the `selligent.json` to further configur
 | url                                         | string | The Marigold Engage webservice url to be used to integrate with your Marigold Engage platform |
 | clientId                                    | string | The Marigold Engage client id to be used to integrate with your Marigold Engage platform |
 | privateKey                                  | string | The Marigold Engage private key to be used to integrate with your Marigold Engage platform |
+| customInAppUi                               | boolean| When this is enabled and a "push + inapp" notification is clicked, the SDK will NOT display the inApp message and instead a `SelligentConstants.BroadcastEventType.DISPLAYING_IN_APP_MESSAGE` event will be sent |
 | delayedPushAction                           | boolean| (iOS Only) Optin for a specific push action handling (wait for React UI to be ready) when coming from a push message and having the app killed |
 | interceptSelligentUniversalLinks            | boolean| (iOS Only) Optin to customly handle the execution of universal links coming from a Push/IAM [more information](#universal-linking---ios) |
 | clearCacheIntervalValue                     | [enum](#clearcacheintervalvalue) | How much time the SDK will keep things in cache |  
@@ -482,7 +483,7 @@ The `data` property is an object itself containing more information specific to
 
     | Property | Type   | Description        |
     | -------- | ------ | ------------------ |
-    | id       | string | Internal id of the message    |
+    | id       | string | Internal id of the message |
     | title    | string | Title of the message |
 
 ```javascript
@@ -512,7 +513,7 @@ The response of the success callback is an array of objects which contain the in
 | -------------- | ------------------------------------------------------------------------------- | ---------------------------------------------------------- |
 | id             | string                                                                          | Internal id of the IAM                                 |
 | title          | string                                                                          | Title of the IAM                               |
-| body           | string                                                                          | Body of the IAM                          |
+| body           | string                                                                          | Body of the IAM. For message of type `ALERT` it will be the text corresponding to the body of the Alert, for type `HTML` it will be the html code, for type `URL`, `IMAGE` and `PASSBOOK` it will be an URL.                          |
 | type           | [enum](#inappmessagetype) | Type of the IAM                                  |
 | creationDate   | number                                                                          | Creation date of the IAM in unix time            |
 | expirationDate | number                                                                          | Expiration date of the IAM in unix time         |
@@ -529,6 +530,36 @@ The `buttons` property is an array of button-objects which contain the informati
 | value    | string | Value of the button of the in app message  | Both         |
 | type     | number | Type of the button of the in app message   | Both         |
 
+- When the IAM is linked to a push notification, you can set `customInAppUi` to `true` in `selligent.json` and subscribe to `SelligentConstants.BroadcastEventType.DISPLAYING_IN_APP_MESSAGE` events through the `Selligent.subscribeToEvents`, to know when messages are about to be displayed.
+You will also need to set `addInAppMessageFromPushToInAppMessageList` to `true` in `selligent.json` to be able to retrieve the full object calling `Selligent.getInAppMessages` and do not forget to use the [IAM Helper methods](#iam-helper-methods) to properly track Open and Click interactions.
+For Android, to avoid the SDK directly displaying the IAM if the App is in foreground, do also set `remoteMessageDisplayType` to `22` (NOTIFICATION) in `selligent.json`.
+The response of the success callback is an object which contains information on the type of broadcast event and the data attached to it.
+
+| Property           | Type                                                    | Description                                                       |
+| ------------------ | ------------------------------------------------------- | ----------------------------------------------------------------- |
+| broadcastEventType | [enum](#broadcasteventtype)                             | The type of broadcast event                                       |
+| data               | object                                                  | Contains more information specific to the type of broadcast event |
+
+The `data` property is an object itself containing more information specific to the type of the broadcast event:
+
+- DISPLAYING_IN_APP_MESSAGE
+
+    | Property | Type   | Description        |
+    | -------- | ------ | ------------------ |
+    | id       | string | Internal id of the message |
+    | title    | string | Title of the message |
+
+```javascript
+Selligent.subscribeToEvents(
+    () => {}, 
+    () => {},
+    (response) => {
+      if (response?.broadcastEventType === SelligentConstants.BroadcastEventType.DISPLAYING_IN_APP_MESSAGE) {
+      }
+    }
+)
+```
+
 To display any of these messages, you can call `Selligent.displayMessage`:
 
 ### Selligent.displayMessage
@@ -596,7 +627,7 @@ In the other hand, you can also use the native methods `RNSelligent/willPresentN
 
 ### IAM Helper methods
 
-If you decide to display the AIM on your own (without `Selligent.displayMessage` and `Selligent.displayNotification`), listening for new messages with the `Selligent.subscribeToEvents` and/or getting the full list with `Selligent.getInAppMessages`. You will be able to build your own layout with the object provided from the mentioned functions and then you can use the helper methods described here to still push KPI statistics to the Marigold Engage platform:
+If you decide to display the IAM on your own (without `Selligent.displayMessage` and `Selligent.displayNotification`), listening for new messages with the `Selligent.subscribeToEvents` and/or getting the full list with `Selligent.getInAppMessages`. You will be able to build your own layout with the object provided from the mentioned functions and then you can use the helper methods described here to still push KPI statistics to the Marigold Engage platform:
 
 - setInAppMessageAsSeen: sets an IAM as seen and sends the corresponding `Opened` event to the Marigold Engage platform
 
@@ -905,3 +936,4 @@ Defines the type of a broadcast event.
 | RECEIVED_REMOTE_NOTIFICATION     | string | ReceivedRemoteNotification | A remote notification has been received               |
 | iOS.UNIVERSAL_LINK_EXECUTED      | string | UniversalLinkExecuted      | An universal link has been executed                   |
 | TRIGGERED_CUSTOM_EVENT           | string | TriggeredCustomEvent       | A custom event has been triggered                     |
+| DISPLAYING_IN_APP_MESSAGE        | string | DisplayingInAppMessage     | An IAM is about to be displayed (when `customInAppUi` is set to `true` in `selligent.json`) |

package/index.js

@@ -306,6 +306,7 @@ export default Object.assign(
 			RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.RECEIVED_DEVICE_ID, eventCallback);
 			RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.RECEIVED_REMOTE_NOTIFICATION, eventCallback);
 			RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.TRIGGERED_CUSTOM_EVENT, eventCallback);
+			RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.DISPLAYING_IN_APP_MESSAGE, eventCallback);
 
 			if (Platform.OS === "ios") {
 				RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.UNIVERSAL_LINK_EXECUTED, eventCallback);

package/ios/RNSelligentMapper.m

@@ -148,7 +148,8 @@ RCT_EXPORT_METHOD(subscribeToEvents:(NSArray<NSString *> *)events) {
         @"ReceivedRemoteNotification",
         @"ReceivedDeviceId",
         @"UniversalLinkExecuted",
-        @"TriggeredCustomEvent"
+        @"TriggeredCustomEvent",
+        @"DisplayingInAppMessage"
      ];
 }
 

package/package.json

@@ -4,7 +4,7 @@
   },
   "name": "@selligent-marketing-cloud/selligent-react-native",
   "title": "Marigold Engage React Native",
-  "version": "3.5.1",
+  "version": "3.6.0",
   "description": "React Native wrapper for the Marigold Engage Android and iOS SDKs",
   "main": "index.js",
   "repository": {