feat: add syncEmbeddedMessages method

Author: lposen

android/src/main/java/com/iterable/reactnative/RNIterableAPIModuleImpl.java

@@ -651,6 +651,11 @@ public void onInboxUpdated() {
     // ---------------------------------------------------------------------------------------
     // region Embedded messaging
 
+    public void syncEmbeddedMessages() {
+        IterableLogger.d(TAG, "syncEmbeddedMessages");
+        IterableApi.getInstance().getEmbeddedManager().syncMessages();
+    }
+
     public void startEmbeddedSession() {
         IterableLogger.d(TAG, "startEmbeddedSession");
         IterableApi.getInstance().getEmbeddedManager().getEmbeddedSessionManager().startSession();

android/src/newarch/java/com/RNIterableAPIModule.java

@@ -224,6 +224,11 @@ public void pauseAuthRetries(boolean pauseRetry) {
     moduleImpl.pauseAuthRetries(pauseRetry);
   }
 
+  @Override
+  public void syncEmbeddedMessages() {
+    moduleImpl.syncEmbeddedMessages();
+  }
+
   @Override
   public void startEmbeddedSession() {
     moduleImpl.startEmbeddedSession();

android/src/oldarch/java/com/RNIterableAPIModule.java

@@ -228,6 +228,11 @@ public void pauseAuthRetries(boolean pauseRetry) {
       moduleImpl.pauseAuthRetries(pauseRetry);
     }
 
+    @ReactMethod
+    public void syncEmbeddedMessages() {
+      moduleImpl.syncEmbeddedMessages();
+    }
+
     @ReactMethod
     public void startEmbeddedSession() {
       moduleImpl.startEmbeddedSession();

example/src/components/Embedded/Embedded.tsx

@@ -6,6 +6,11 @@ import styles from './Embedded.styles';
 
 export const Embedded = () => {
   const [placementIds, setPlacementIds] = useState<number[]>([]);
+
+  const syncEmbeddedMessages = useCallback(() => {
+    Iterable.embeddedManager.syncMessages();
+  }, []);
+
   const getPlacementIds = useCallback(() => {
     Iterable.embeddedManager.getPlacementIds().then((ids: unknown) => {
       console.log(ids);
@@ -40,6 +45,9 @@ export const Embedded = () => {
       <Text style={styles.text}>
         Placement ids: [{placementIds.join(', ')}]
       </Text>
+      <TouchableOpacity style={styles.button} onPress={syncEmbeddedMessages}>
+        <Text style={styles.buttonText}>Sync embedded messages</Text>
+      </TouchableOpacity>
       <TouchableOpacity style={styles.button} onPress={getPlacementIds}>
         <Text style={styles.buttonText}>Get placement ids</Text>
       </TouchableOpacity>

src/api/NativeRNIterableAPI.ts

@@ -119,6 +119,7 @@ export interface Spec extends TurboModule {
   pauseAuthRetries(pauseRetry: boolean): void;
 
   // Embedded Messaging
+  syncEmbeddedMessages(): void;
   startEmbeddedSession(): void;
   endEmbeddedSession(): void;
   getEmbeddedPlacementIds(): Promise<number[]>;

src/core/classes/IterableApi.ts

@@ -510,6 +510,14 @@ export class IterableApi {
   // ======================= EMBEDDED ===================== //
   // ====================================================== //
 
+  /**
+   * Syncs embedded local cache with the server.
+   */
+  static syncEmbeddedMessages() {
+    IterableLogger.log('syncEmbeddedMessages');
+    return RNIterableAPI.syncEmbeddedMessages();
+  }
+
   /**
    * Starts an embedded session.
    */

src/embedded/classes/IterableEmbeddedManager.ts

@@ -20,6 +20,29 @@ export class IterableEmbeddedManager {
    */
   isEnabled = false;
 
+  /**
+   * Syncs embedded local cache with the server.
+   *
+   * When your app first launches, and each time it comes to the foreground,
+   * Iterable's iOS SDK automatically refresh a local, on-device cache of
+   * embedded messages for the signed-in user. These are the messages the
+   * signed-in user is eligible to see.
+   *
+   * At key points during your app's lifecycle, you may want to manually refresh
+   * your app's local cache of embedded messages. For example, as users navigate
+   * around, on pull-to-refresh, etc.
+   *
+   * However, do not poll for new embedded messages at a regular interval.
+   *
+   * @example
+   * ```typescript
+   * IterableEmbeddedManager.syncMessages();
+   * ```
+   */
+  syncMessages() {
+    return IterableApi.syncEmbeddedMessages();
+  }
+
   /**
    * Retrieves a list of placement IDs for the embedded manager.
    *