[MOB-12267] add pauseEmbeddedImpression method to manage embedded message impressions

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

@@ -666,6 +666,14 @@ public void endEmbeddedSession() {
         IterableApi.getInstance().getEmbeddedManager().getEmbeddedSessionManager().endSession();
     }
 
+    public void startEmbeddedImpression(String messageId, int placementId) {
+        IterableApi.getInstance().getEmbeddedManager().getEmbeddedSessionManager().startImpression(messageId, placementId);
+    }
+
+    public void pauseEmbeddedImpression(String messageId) {
+        IterableApi.getInstance().getEmbeddedManager().getEmbeddedSessionManager().pauseImpression(messageId);
+    }
+
     public void getEmbeddedPlacementIds(Promise promise) {
         IterableLogger.d(TAG, "getEmbeddedPlacementIds");
         try {

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

@@ -239,6 +239,16 @@ public void endEmbeddedSession() {
     moduleImpl.endEmbeddedSession();
   }
 
+  @Override
+  public void startEmbeddedImpression(String messageId, double placementId) {
+    moduleImpl.startEmbeddedImpression(messageId, (int) placementId);
+  }
+
+  @Override
+  public void pauseEmbeddedImpression(String messageId) {
+    moduleImpl.pauseEmbeddedImpression(messageId);
+  }
+
   @Override
   public void getEmbeddedPlacementIds(Promise promise) {
     moduleImpl.getEmbeddedPlacementIds(promise);

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

@@ -243,6 +243,16 @@ public void endEmbeddedSession() {
       moduleImpl.endEmbeddedSession();
     }
 
+    @ReactMethod
+    public void startEmbeddedImpression(String messageId, double placementId) {
+      moduleImpl.startEmbeddedImpression(messageId, (int) placementId);
+    }
+
+    @ReactMethod
+    public void pauseEmbeddedImpression(String messageId) {
+      moduleImpl.pauseEmbeddedImpression(messageId);
+    }
+
     @ReactMethod
     public void getEmbeddedPlacementIds(Promise promise) {
       moduleImpl.getEmbeddedPlacementIds(promise);

example/src/components/Embedded/Embedded.styles.ts

@@ -1,5 +1,5 @@
 import { StyleSheet } from 'react-native';
-import { button, buttonText, container, hr } from '../../constants';
+import { button, buttonText, container, hr, link } from '../../constants';
 
 const styles = StyleSheet.create({
   button,
@@ -11,7 +11,17 @@ const styles = StyleSheet.create({
     gap: 16,
     paddingHorizontal: 16,
   },
+  embeddedTitle: {
+    fontSize: 16,
+    fontWeight: 'bold',
+    lineHeight: 20,
+  },
+  embeddedTitleContainer: {
+    display: 'flex',
+    flexDirection: 'row',
+  },
   hr,
+  link,
   text: { textAlign: 'center' },
   utilitySection: {
     paddingHorizontal: 16,

example/src/components/Embedded/Embedded.tsx

@@ -48,6 +48,26 @@ export const Embedded = () => {
       });
   }, [getPlacementIds]);
 
+  const startEmbeddedImpression = useCallback(
+    (message: IterableEmbeddedMessage) => {
+      console.log(`startEmbeddedImpression`, message);
+      Iterable.embeddedManager.startImpression(
+        message.metadata.messageId,
+        // TODO: check if this should be changed to a number, as per the type
+        Number(message.metadata.placementId)
+      );
+    },
+    []
+  );
+
+  const pauseEmbeddedImpression = useCallback(
+    (message: IterableEmbeddedMessage) => {
+      console.log(`pauseEmbeddedImpression:`, message);
+      Iterable.embeddedManager.pauseImpression(message.metadata.messageId);
+    },
+    []
+  );
+
   return (
     <View style={styles.container}>
       <Text style={styles.text}>EMBEDDED</Text>
@@ -63,27 +83,41 @@ export const Embedded = () => {
           Placement ids: [{placementIds.join(', ')}]
         </Text>
         <TouchableOpacity style={styles.button} onPress={syncEmbeddedMessages}>
-          <Text style={styles.buttonText}>Sync embedded messages</Text>
+          <Text style={styles.buttonText}>Sync messages</Text>
         </TouchableOpacity>
         <TouchableOpacity style={styles.button} onPress={getPlacementIds}>
           <Text style={styles.buttonText}>Get placement ids</Text>
         </TouchableOpacity>
         <TouchableOpacity style={styles.button} onPress={startEmbeddedSession}>
-          <Text style={styles.buttonText}>Start embedded session</Text>
+          <Text style={styles.buttonText}>Start session</Text>
         </TouchableOpacity>
         <TouchableOpacity style={styles.button} onPress={endEmbeddedSession}>
-          <Text style={styles.buttonText}>End embedded session</Text>
+          <Text style={styles.buttonText}>End session</Text>
         </TouchableOpacity>
         <TouchableOpacity style={styles.button} onPress={getEmbeddedMessages}>
-          <Text style={styles.buttonText}>Get embedded messages</Text>
+          <Text style={styles.buttonText}>Get messages</Text>
         </TouchableOpacity>
       </View>
       <View style={styles.hr} />
       <ScrollView>
         <View style={styles.embeddedSection}>
           {embeddedMessages.map((message) => (
             <View key={message.metadata.messageId}>
-              <Text>Embedded message</Text>
+              <View style={styles.embeddedTitleContainer}>
+                <Text style={styles.embeddedTitle}>Embedded message | </Text>
+                <TouchableOpacity
+                  onPress={() => startEmbeddedImpression(message)}
+                >
+                  <Text style={styles.link}>Start impression</Text>
+                </TouchableOpacity>
+                <Text style={styles.embeddedTitle}> | </Text>
+                <TouchableOpacity
+                  onPress={() => pauseEmbeddedImpression(message)}
+                >
+                  <Text style={styles.link}>Pause impression</Text>
+                </TouchableOpacity>
+              </View>
+
               <Text>metadata.messageId: {message.metadata.messageId}</Text>
               <Text>metadata.placementId: {message.metadata.placementId}</Text>
               <Text>elements.title: {message.elements?.title}</Text>

example/src/constants/styles/typography.ts

@@ -57,3 +57,8 @@ export const requiredStar: TextStyle = {
   ...label,
   color: colors.textDestructive,
 };
+
+export const link: TextStyle = {
+  color: colors.textInteractive,
+  textDecorationLine: 'underline',
+};

src/api/NativeRNIterableAPI.ts

@@ -149,6 +149,8 @@ export interface Spec extends TurboModule {
   syncEmbeddedMessages(): void;
   startEmbeddedSession(): void;
   endEmbeddedSession(): void;
+  startEmbeddedImpression(messageId: string, placementId: number): void;
+  pauseEmbeddedImpression(messageId: string): void;
   getEmbeddedPlacementIds(): Promise<number[]>;
   getEmbeddedMessages(
     placementIds: number[] | null

src/core/classes/IterableApi.ts

@@ -535,6 +535,22 @@ export class IterableApi {
     return RNIterableAPI.endEmbeddedSession();
   }
 
+  /**
+   * Starts an embedded impression.
+   */
+  static startEmbeddedImpression(messageId: string, placementId: number) {
+    IterableLogger.log('startEmbeddedImpression: ', messageId, placementId);
+    return RNIterableAPI.startEmbeddedImpression(messageId, placementId);
+  }
+
+  /**
+   * Pauses an embedded impression.
+   */
+  static pauseEmbeddedImpression(messageId: string) {
+    IterableLogger.log('pauseEmbeddedImpression: ', messageId);
+    return RNIterableAPI.pauseEmbeddedImpression(messageId);
+  }
+
   /**
    * Get the embedded placement IDs.
    */

src/embedded/classes/IterableEmbeddedManager.ts

@@ -101,4 +101,44 @@ export class IterableEmbeddedManager {
   endSession() {
     return IterableApi.endEmbeddedSession();
   }
+  /**
+   * Starts an embedded impression.
+   *
+   * An impression represents the on-screen appearances of a given embedded message,
+   * in context of a session.
+   *
+   * Each impression tracks:
+   * - The total number of times a message appears during a session.
+   * - The total amount of time that message was visible, across all its
+   *   appearances in the session.
+   *
+   * Be sure to start and pause impressions when your app goes to and from the
+   * background, too.
+   *
+   * @example
+   * ```typescript
+   * IterableEmbeddedManager.startImpression(messageId, placementId);
+   * ```
+   */
+  startImpression(messageId: string, placementId: number) {
+    return IterableApi.startEmbeddedImpression(messageId, placementId);
+  }
+
+  /**
+   * Pauses an embedded impression.
+   *
+   * An impression represents the on-screen appearances of a given embedded message,
+   * in context of a session.
+   *
+   * And impression should be paused when the message is no longer visible,
+   * including when your app goes to the background.
+   *
+   * @example
+   * ```typescript
+   * IterableEmbeddedManager.pauseImpression(messageId);
+   * ```
+   */
+  pauseImpression(messageId: string) {
+    return IterableApi.pauseEmbeddedImpression(messageId);
+  }
 }