Merge pull request #744 from Iterable/loren/embedded/MOB-12263-android-add-ability-to-sync-embedded-messages

lposen · web-flow · commit e0e83b2b76f5 · 2025-12-15T10:43:11.000-08:00
[MOB-12263] android-add-ability-to-get placements
diff --git a/android/src/main/java/com/iterable/reactnative/RNIterableAPIModuleImpl.java b/android/src/main/java/com/iterable/reactnative/RNIterableAPIModuleImpl.java
@@ -15,6 +15,7 @@
 import com.facebook.react.bridge.ReadableArray;
 import com.facebook.react.bridge.ReadableMap;
 import com.facebook.react.bridge.UiThreadUtil;
+import com.facebook.react.bridge.WritableArray;
 import com.facebook.react.bridge.WritableMap;
 import com.facebook.react.modules.core.DeviceEventManagerModule;
 
@@ -23,11 +24,12 @@
 import com.iterable.iterableapi.IterableAction;
 import com.iterable.iterableapi.IterableActionContext;
 import com.iterable.iterableapi.IterableApi;
+import com.iterable.iterableapi.IterableAttributionInfo;
 import com.iterable.iterableapi.IterableAuthHandler;
 import com.iterable.iterableapi.IterableAuthManager;
 import com.iterable.iterableapi.IterableConfig;
 import com.iterable.iterableapi.IterableCustomActionHandler;
-import com.iterable.iterableapi.IterableAttributionInfo;
+import com.iterable.iterableapi.IterableEmbeddedMessage;
 import com.iterable.iterableapi.IterableHelper;
 import com.iterable.iterableapi.IterableInAppCloseAction;
 import com.iterable.iterableapi.IterableInAppHandler;
@@ -46,6 +48,7 @@
 import java.util.Map;
 import java.util.HashMap;
 import java.util.List;
+import java.util.ArrayList;
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.TimeUnit;
 
@@ -122,6 +125,7 @@ public void initializeWithApiKey(String apiKey, ReadableMap configReadableMap, S
         IterableApi.getInstance().setDeviceAttribute("reactNativeSDKVersion", version);
 
         IterableApi.getInstance().getInAppManager().addListener(this);
+        IterableApi.getInstance().getEmbeddedManager().syncMessages();
 
         // MOB-10421: Figure out what the error cases are and handle them appropriately
         // This is just here to match the TS types and let the JS thread know when we are done initializing
@@ -185,6 +189,7 @@ public void initialize2WithApiKey(String apiKey, ReadableMap configReadableMap,
         IterableApi.getInstance().setDeviceAttribute("reactNativeSDKVersion", version);
 
         IterableApi.getInstance().getInAppManager().addListener(this);
+        IterableApi.getInstance().getEmbeddedManager().syncMessages();
 
         // MOB-10421: Figure out what the error cases are and handle them appropriately
         // This is just here to match the TS types and let the JS thread know when we are done initializing
@@ -683,14 +688,39 @@ public void sendEvent(@NonNull String eventName, @Nullable Object eventData) {
     public void onInboxUpdated() {
         sendEvent(EventName.receivedIterableInboxChanged.name(), null);
     }
+    // ---------------------------------------------------------------------------------------
+    // endregion
+
+    // ---------------------------------------------------------------------------------------
+    // region Embedded messaging
+    public void getEmbeddedPlacementIds(Promise promise) {
+        IterableLogger.d(TAG, "getEmbeddedPlacementIds");
+        try {
+            List<Long> placementIds = IterableApi.getInstance().getEmbeddedManager().getPlacementIds();
+            WritableArray writableArray = Arguments.createArray();
+            if (placementIds != null) {
+                for (Long placementId : placementIds) {
+                    writableArray.pushDouble(placementId.doubleValue());
+                }
+            }
+            promise.resolve(writableArray);
+        } catch (Exception e) {
+            IterableLogger.e(TAG, "Error getting placement IDs: " + e.getLocalizedMessage());
+            promise.reject("", "Failed to get placement IDs: " + e.getLocalizedMessage());
+        }
+    }
+
+    // ---------------------------------------------------------------------------------------
+    // endregion
 }
 
 enum EventName {
-  handleUrlCalled,
-  handleCustomActionCalled,
-  handleInAppCalled,
   handleAuthCalled,
-  receivedIterableInboxChanged,
+  handleAuthFailureCalled,
   handleAuthSuccessCalled,
-  handleAuthFailureCalled
+  handleCustomActionCalled,
+  handleInAppCalled,
+  handleUrlCalled,
+  receivedIterableEmbeddedMessagesChanged,
+  receivedIterableInboxChanged
 }
diff --git a/android/src/main/java/com/iterable/reactnative/Serialization.java b/android/src/main/java/com/iterable/reactnative/Serialization.java
@@ -16,15 +16,16 @@
 import com.iterable.iterableapi.IterableActionContext;
 import com.iterable.iterableapi.IterableConfig;
 import com.iterable.iterableapi.IterableDataRegion;
+import com.iterable.iterableapi.IterableEmbeddedMessage;
 import com.iterable.iterableapi.IterableInAppCloseAction;
 import com.iterable.iterableapi.IterableInAppDeleteActionType;
 import com.iterable.iterableapi.IterableInAppHandler;
 import com.iterable.iterableapi.IterableInAppLocation;
 import com.iterable.iterableapi.IterableInAppMessage;
 import com.iterable.iterableapi.IterableInboxSession;
 import com.iterable.iterableapi.IterableLogger;
-import com.iterable.iterableapi.RNIterableInternal;
 import com.iterable.iterableapi.RetryPolicy;
+import com.iterable.iterableapi.RNIterableInternal;
 
 import org.json.JSONArray;
 import org.json.JSONException;
@@ -218,6 +219,10 @@ static IterableConfig.Builder getConfigFromReadableMap(ReadableMap iterableConte
                 configBuilder.setDataRegion(iterableDataRegion);
             }
 
+            if (iterableContextJSON.has("enableEmbeddedMessaging")) {
+                configBuilder.setEnableEmbeddedMessaging(iterableContextJSON.optBoolean("enableEmbeddedMessaging"));
+            }
+
             if (iterableContextJSON.has("retryPolicy")) {
                 JSONObject retryPolicyJson = iterableContextJSON.getJSONObject("retryPolicy");
                 int maxRetry = retryPolicyJson.getInt("maxRetry");
diff --git a/android/src/newarch/java/com/RNIterableAPIModule.java b/android/src/newarch/java/com/RNIterableAPIModule.java
@@ -224,6 +224,11 @@ public void pauseAuthRetries(boolean pauseRetry) {
     moduleImpl.pauseAuthRetries(pauseRetry);
   }
 
+  @Override
+  public void getEmbeddedPlacementIds(Promise promise) {
+    moduleImpl.getEmbeddedPlacementIds(promise);
+  }
+
   public void sendEvent(@NonNull String eventName, @Nullable Object eventData) {
     moduleImpl.sendEvent(eventName, eventData);
   }
diff --git a/android/src/oldarch/java/com/RNIterableAPIModule.java b/android/src/oldarch/java/com/RNIterableAPIModule.java
@@ -228,6 +228,10 @@ public void pauseAuthRetries(boolean pauseRetry) {
       moduleImpl.pauseAuthRetries(pauseRetry);
     }
 
+    @ReactMethod
+    public void getEmbeddedPlacementIds(Promise promise) {
+      moduleImpl.getEmbeddedPlacementIds(promise);
+    }
 
     public void sendEvent(@NonNull String eventName, @Nullable Object eventData) {
       moduleImpl.sendEvent(eventName, eventData);
diff --git a/example/src/components/Embedded/Embedded.tsx b/example/src/components/Embedded/Embedded.tsx
@@ -1,10 +1,19 @@
+import { Text, TouchableOpacity } from 'react-native';
+import { useCallback, useState } from 'react';
 import { Iterable } from '@iterable/react-native-sdk';
-import { Text } from 'react-native';
 import { SafeAreaView } from 'react-native-safe-area-context';
 
 import styles from './Embedded.styles';
 
 export const Embedded = () => {
+  const [placementIds, setPlacementIds] = useState<number[]>([]);
+  const getPlacementIds = useCallback(() => {
+    Iterable.embeddedManager.getPlacementIds().then((ids: unknown) => {
+      console.log(ids);
+      setPlacementIds(ids as number[]);
+    });
+  }, []);
+
   return (
     <SafeAreaView style={styles.container}>
       <Text style={styles.text}>EMBEDDED</Text>
@@ -15,6 +24,12 @@ export const Embedded = () => {
         Is embedded manager enabled?{' '}
         {Iterable.embeddedManager.isEnabled ? 'Yes' : 'No'}
       </Text>
+      <Text style={styles.text}>
+        Placement ids: [{placementIds.join(', ')}]
+      </Text>
+      <TouchableOpacity style={styles.button} onPress={getPlacementIds}>
+        <Text style={styles.buttonText}>Get placement ids</Text>
+      </TouchableOpacity>
     </SafeAreaView>
   );
 };
diff --git a/example/src/hooks/useIterableApp.tsx b/example/src/hooks/useIterableApp.tsx
@@ -155,6 +155,8 @@ export const IterableAppProvider: FunctionComponent<
         retryBackoff: IterableRetryBackoff.linear,
       };
 
+      config.enableEmbeddedMessaging = true;
+
       config.onJwtError = (authFailure) => {
         console.log('onJwtError', authFailure);
 
@@ -192,7 +194,7 @@ export const IterableAppProvider: FunctionComponent<
 
       config.logLevel = IterableLogLevel.debug;
 
-      config.embeddedMessagingEnabled = true;
+      config.enableEmbeddedMessaging = true;
 
       config.inAppHandler = () => IterableInAppShowResponse.show;
 
diff --git a/src/api/NativeRNIterableAPI.ts b/src/api/NativeRNIterableAPI.ts
@@ -118,6 +118,9 @@ export interface Spec extends TurboModule {
   passAlongAuthToken(authToken?: string | null): void;
   pauseAuthRetries(pauseRetry: boolean): void;
 
+  // Embedded Messaging
+  getEmbeddedPlacementIds(): Promise<number[]>;
+
   // Wake app -- android only
   wakeApp(): void;
 
diff --git a/src/core/classes/Iterable.test.ts b/src/core/classes/Iterable.test.ts
@@ -307,7 +307,7 @@ describe('Iterable', () => {
       expect(config.checkForDeferredDeeplink).toBe(false);
       expect(config.customActionHandler).toBe(undefined);
       expect(config.dataRegion).toBe(IterableDataRegion.US);
-      expect(config.embeddedMessagingEnabled).toBe(false);
+      expect(config.enableEmbeddedMessaging).toBe(false);
       expect(config.encryptionEnforced).toBe(false);
       expect(config.expiringAuthTokenRefreshPeriod).toBe(60.0);
       expect(config.inAppDisplayInterval).toBe(30.0);
@@ -324,7 +324,7 @@ describe('Iterable', () => {
       expect(configDict.autoPushRegistration).toBe(true);
       expect(configDict.customActionHandlerPresent).toBe(false);
       expect(configDict.dataRegion).toBe(IterableDataRegion.US);
-      expect(configDict.embeddedMessagingEnabled).toBe(false);
+      expect(configDict.enableEmbeddedMessaging).toBe(false);
       expect(configDict.encryptionEnforced).toBe(false);
       expect(configDict.expiringAuthTokenRefreshPeriod).toBe(60.0);
       expect(configDict.inAppDisplayInterval).toBe(30.0);
@@ -1218,13 +1218,13 @@ describe('Iterable', () => {
   describe('embeddedManager', () => {
     it('should be disabled by default', () => {
       const config = new IterableConfig();
-      expect(config.embeddedMessagingEnabled).toBe(false);
+      expect(config.enableEmbeddedMessaging).toBe(false);
       expect(Iterable.embeddedManager.isEnabled).toBe(false);
     });
 
     it('should enable embeddedManager when config is set', async () => {
       const config = new IterableConfig();
-      config.embeddedMessagingEnabled = true;
+      config.enableEmbeddedMessaging = true;
       await Iterable.initialize('test-key', config);
       expect(Iterable.embeddedManager.isEnabled).toBe(true);
     });
diff --git a/src/core/classes/Iterable.ts b/src/core/classes/Iterable.ts
@@ -196,7 +196,7 @@ export class Iterable {
       IterableLogger.setLogLevel(config.logLevel);
 
       Iterable.embeddedManager.setEnabled(
-        config.embeddedMessagingEnabled ?? false
+        config.enableEmbeddedMessaging ?? false
       );
     }
 
diff --git a/src/core/classes/IterableApi.ts b/src/core/classes/IterableApi.ts
@@ -507,7 +507,21 @@ export class IterableApi {
   // ---- End IN-APP ---- //
 
   // ====================================================== //
-  // ======================= MOSC ======================= //
+  // ======================= EMBEDDED ===================== //
+  // ====================================================== //
+
+  /**
+   * Get the embedded placement IDs.
+   */
+  static getEmbeddedPlacementIds() {
+    IterableLogger.log('getEmbeddedPlacementIds');
+    return RNIterableAPI.getEmbeddedPlacementIds();
+  }
+
+  // ---- End EMBEDDED ---- //
+
+  // ====================================================== //
+  // ======================= MISCELLANEOUS ================ //
   // ====================================================== //
 
   /**
diff --git a/src/core/classes/IterableConfig.ts b/src/core/classes/IterableConfig.ts
@@ -337,7 +337,7 @@ export class IterableConfig {
    * - [Android Embedded Messaging](https://support.iterable.com/hc/en-us/articles/23061877893652-Embedded-Messages-with-Iterable-s-Android-SDK)
    * - [iOS Embedded Messaging](https://support.iterable.com/hc/en-us/articles/23061840746900-Embedded-Messages-with-Iterable-s-iOS-SDK)
    */
-  embeddedMessagingEnabled = false;
+  enableEmbeddedMessaging = false;
 
   /**
    * Converts the IterableConfig instance to a dictionary object.
@@ -388,7 +388,7 @@ export class IterableConfig {
       pushPlatform: this.pushPlatform,
       encryptionEnforced: this.encryptionEnforced,
       retryPolicy: this.retryPolicy,
-      embeddedMessagingEnabled: this.embeddedMessagingEnabled,
+      enableEmbeddedMessaging: this.enableEmbeddedMessaging,
     };
   }
 }
diff --git a/src/embedded/classes/IterableEmbeddedManager.ts b/src/embedded/classes/IterableEmbeddedManager.ts
@@ -1,3 +1,5 @@
+import { IterableApi } from '../../core/classes/IterableApi';
+
 /**
  * Manages embedded messages from Iterable.
  *
@@ -30,4 +32,13 @@ export class IterableEmbeddedManager {
   setEnabled(enabled: boolean) {
     this._isEnabled = enabled;
   }
+
+  /**
+   * Retrieves a list of placement IDs for the embedded manager.
+   *
+   * [Placement Documentation](https://support.iterable.com/hc/en-us/articles/23060529977364-Embedded-Messaging-Overview#placements-and-prioritization)
+   */
+  getPlacementIds() {
+    return IterableApi.getEmbeddedPlacementIds();
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -224,6 +224,11 @@ public void pauseAuthRetries(boolean pauseRetry) {`
`224`	`224`	`moduleImpl.pauseAuthRetries(pauseRetry);`
`225`	`225`	`}`
`226`	`226`
	`227`	`+ @Override`
	`228`	`+ public void getEmbeddedPlacementIds(Promise promise) {`
	`229`	`+ moduleImpl.getEmbeddedPlacementIds(promise);`
	`230`	`+ }`
	`231`	`+`
`227`	`232`	`public void sendEvent(@NonNull String eventName, @Nullable Object eventData) {`
`228`	`233`	`moduleImpl.sendEvent(eventName, eventData);`
`229`	`234`	`}`
Original file line number	Diff line number	Diff line change
`@@ -228,6 +228,10 @@ public void pauseAuthRetries(boolean pauseRetry) {`
`228`	`228`	`moduleImpl.pauseAuthRetries(pauseRetry);`
`229`	`229`	`}`
`230`	`230`
	`231`	`+ @ReactMethod`
	`232`	`+ public void getEmbeddedPlacementIds(Promise promise) {`
	`233`	`+ moduleImpl.getEmbeddedPlacementIds(promise);`
	`234`	`+ }`
`231`	`235`
`232`	`236`	`public void sendEvent(@NonNull String eventName, @Nullable Object eventData) {`
`233`	`237`	`moduleImpl.sendEvent(eventName, eventData);`
Original file line number	Diff line number	Diff line change
`@@ -196,7 +196,7 @@ export class Iterable {`
`196`	`196`	`IterableLogger.setLogLevel(config.logLevel);`
`197`	`197`
`198`	`198`	`Iterable.embeddedManager.setEnabled(`
`199`		`- config.embeddedMessagingEnabled ?? false`
	`199`	`+ config.enableEmbeddedMessaging ?? false`
`200`	`200`	`);`
`201`	`201`	`}`
`202`	`202`