[MOB-12264] Add sync messages and get messages to android #746

lposen · 2025-10-13T19:36:32Z

🔹 JIRA Ticket(s) if any

MOB-12264

✏️ Description

Adds the ability to sync and get messages to android

Testing

cd into the example dir and run:

yarn install
watchman watch-del-all
yarn start --reset-cache

In a separate terminal, cd into example then either run yarn android
Click on the "Embedded" tab.
Click "Get messages"
Params of your embedded messages should display in the UI

…isplay

github-actions · 2025-10-13T19:38:03Z

Lines	Statements	Branches	Functions
	59.86% (349/583)	33.18% (76/229)	58.98% (128/217)

qltysh · 2025-10-13T19:38:17Z

Diff Coverage: The code coverage on the diff in this pull request is 100.0%.

Total Coverage: This PR will increase coverage by 0.43%.

File Coverage Changes

Path	File Coverage Δ	Indirect
src/embedded/types/IterableEmbeddedMessage.ts	100.0
src/embedded/types/IterableEmbeddedMessageElements.ts	100.0
src/embedded/types/IterableEmbeddedMessageElementsButton.ts	100.0
src/embedded/types/IterableEmbeddedMessageElementsText.ts	100.0
src/embedded/types/IterableEmbeddedMessageMetadata.ts	100.0
src/embedded/types/index.ts	100.0

🛟 Help

Diff Coverage: Coverage for added or modified lines of code (excludes deleted files). Learn more.
Total Coverage: Coverage for the whole repository, calculated as the sum of all File Coverage. Learn more.
File Coverage: Covered Lines divided by Covered Lines plus Missed Lines. (Excludes non-executable lines including blank lines and comments.)
- Indirect Changes: Changes to File Coverage for files that were not modified in this PR. Learn more.

_{This is from Qlty Cloud, the successor to Code Climate Quality. Learn more.}

qltysh · 2025-10-13T19:38:28Z

2 new issues

Tool	Category	Rule	Count
qlty	Structure	High total complexity (count = 65)	1
qlty	Structure	Function with high complexity (count = 11): getEmbeddedMessages	1

_{This is from Qlty Cloud, the successor to Code Climate Quality. Learn more.}

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

…embedded/MOB-12264-android-sync-and-get-messages

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

Copilot

Pull Request Overview

This PR adds support for syncing and retrieving embedded messages in the Android SDK, bringing feature parity between iOS and Android platforms for embedded messaging functionality.

Key Changes:

Adds syncMessages() method to manually refresh the local cache of embedded messages
Adds getMessages(placementIds) method to retrieve embedded messages for specific placements
Exports TypeScript type definitions for embedded message structures

Reviewed Changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
src/index.tsx	Exports `IterableEmbeddedMessage` type for public API
src/embedded/types/*.ts	New TypeScript interfaces defining the structure of embedded messages, metadata, elements, buttons, and text
src/embedded/index.ts	Exports embedded message types
src/embedded/classes/IterableEmbeddedManager.ts	Adds `syncMessages()` and `getMessages()` methods to the manager class
src/core/classes/IterableApi.ts	Adds wrapper methods for native embedded message operations
src/api/NativeRNIterableAPI.ts	Defines native bridge interface including `EmbeddedMessage` type and method signatures
android/src/oldarch/java/com/RNIterableAPIModule.java	Adds React method bindings for old architecture
android/src/newarch/java/com/RNIterableAPIModule.java	Adds React method bindings for new architecture
android/src/main/java/com/iterable/reactnative/Serialization.java	Adds serialization logic for embedded messages using native SDK's toJSONObject()
android/src/main/java/com/iterable/reactnative/RNIterableAPIModuleImpl.java	Implements sync and get messages logic, iterating through placement IDs
example/src/components/Embedded/Embedded.tsx	Demo implementation showing how to sync and retrieve embedded messages in the example app

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-19T07:42:30Z

src/embedded/classes/IterableEmbeddedManager.ts

+   * 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


The documentation incorrectly refers to "iOS SDK" in a comment about syncing messages. Since this PR is adding Android support, the comment should mention both iOS and Android SDKs, or be platform-agnostic.

Suggested fix:

/** * Syncs embedded local cache with the server. * * When your app first launches, and each time it comes to the foreground, * Iterable's SDK automatically refreshes 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(); * ``` */

Suggested change

* Iterable's iOS SDK automatically refresh a local, on-device cache of

* Iterable's SDK automatically refreshes a local, on-device cache of

Copilot · 2025-11-19T07:42:31Z

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

+                // If no placement IDs provided, we need to get messages for all possible placements
+                // Since the Android SDK requires a placement ID, we'll use 0 as a default
+                // This might need to be adjusted based on the actual SDK behavior
+                List<IterableEmbeddedMessage> messages = IterableApi.getInstance().getEmbeddedManager().getMessages(0L);
+                if (messages != null) {
+                    allMessages.addAll(messages);


Using 0 as a default placement ID when none are provided is questionable and may not work as expected. The comment acknowledges this with "This might need to be adjusted based on the actual SDK behavior."

This should either:

Return an empty list when no placement IDs are provided (if that's the expected behavior)

Fetch all messages across all known placements by iterating through getPlacementIds()

Be documented clearly if 0 is a valid special value in the Iterable Android SDK

Consider implementing option 2:

if (placementIds == null || placementIds.size() == 0) { List<Long> allPlacementIds = IterableApi.getInstance().getEmbeddedManager().getPlacementIds(); if (allPlacementIds != null) { for (Long placementId : allPlacementIds) { List<IterableEmbeddedMessage> messages = IterableApi.getInstance().getEmbeddedManager().getMessages(placementId); if (messages != null) { allMessages.addAll(messages); } } } }

Suggested change

// If no placement IDs provided, we need to get messages for all possible placements

// Since the Android SDK requires a placement ID, we'll use 0 as a default

// This might need to be adjusted based on the actual SDK behavior

List<IterableEmbeddedMessage> messages = IterableApi.getInstance().getEmbeddedManager().getMessages(0L);

if (messages != null) {

allMessages.addAll(messages);

// If no placement IDs provided, get messages for all known placements

List<Long> allPlacementIds = IterableApi.getInstance().getEmbeddedManager().getPlacementIds();

if (allPlacementIds != null) {

for (Long placementId : allPlacementIds) {

List<IterableEmbeddedMessage> messages = IterableApi.getInstance().getEmbeddedManager().getMessages(placementId);

if (messages != null) {

allMessages.addAll(messages);

}

}

Copilot · 2025-11-19T07:42:31Z

example/src/components/Embedded/Embedded.tsx

+      .then((ids: number[]) => Iterable.embeddedManager.getMessages(ids))
+      .then((messages: IterableEmbeddedMessage[]) => {
+        setEmbeddedMessages(messages);
+        console.log(messages);


[nitpick] Missing error handling for the promise chain. If any of the promises reject (e.g., network error, SDK error), the error will be unhandled and could cause issues in the example app. Consider adding a .catch() block:

const getEmbeddedMessages = useCallback(() => { getPlacementIds() .then((ids: number[]) => Iterable.embeddedManager.getMessages(ids)) .then((messages: IterableEmbeddedMessage[]) => { setEmbeddedMessages(messages); console.log(messages); }) .catch((error) => { console.error('Failed to get embedded messages:', error); }); }, [getPlacementIds]);

Suggested change

console.log(messages);

console.log(messages);

})

.catch((error) => {

console.error('Failed to get embedded messages:', error);

Copilot · 2025-11-19T07:42:31Z

src/api/NativeRNIterableAPI.ts

+    text?: { id: string; text?: string | null; label?: string | null }[] | null;
+    title?: string | null;
+  } | null;
+  payload?: { [key: string]: string | number | boolean | null } | null;


Type mismatch: The payload property in the EmbeddedMessage interface is defined as { [key: string]: string | number | boolean | null }, but in IterableEmbeddedMessage it's defined as Record<string, unknown>.

The native interface is more restrictive (only allows primitive types and null), while the TypeScript interface is more permissive (allows any value including nested objects/arrays). This could cause type safety issues.

Consider either:

Aligning the types to match (likely the native version is correct based on what the native SDKs actually return)

Adding a type guard or runtime validation when converting from native to TypeScript types

Suggested fix in IterableEmbeddedMessage.ts:

payload?: Record<string, string | number | boolean | null> | null;

Copilot · 2025-11-19T07:42:31Z

src/embedded/classes/IterableEmbeddedManager.ts

+   * @param placementIds - The placement IDs to retrieve messages for.
+   * @returns A Promise that resolves to an array of embedded messages.


The documentation for getMessages() doesn't explain the behavior when placementIds is null or an empty array. Based on the Android implementation, this is an important detail to document since the behavior is unclear (currently uses placement ID 0 as a default, which may not be correct).

Suggested documentation improvement:

/** * Retrieves a list of embedded messages the user is eligible to see. * * @param placementIds - The placement IDs to retrieve messages for. * Pass null or an empty array to get messages for all placements. * @returns A Promise that resolves to an array of embedded messages. * @example * ```typescript * // Get messages for specific placements * const messages = await Iterable.embeddedManager.getMessages([123, 456]); * * // Get messages for all placements * const allMessages = await Iterable.embeddedManager.getMessages(null); * ``` */

Suggested change

* @param placementIds - The placement IDs to retrieve messages for.

* @returns A Promise that resolves to an array of embedded messages.

* @param placementIds - The placement IDs to retrieve messages for.

* Pass `null` or an empty array to get messages for all placements.

* @returns A Promise that resolves to an array of embedded messages.

* @example

* ```typescript

* // Get messages for specific placements

* const messages = await Iterable.embeddedManager.getMessages([123, 456]);

*

* // Get messages for all placements

* const allMessages = await Iterable.embeddedManager.getMessages(null);

* ```

… in IterableEmbeddedManager

qltysh · 2025-11-19T07:45:36Z

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

+        } catch (JSONException e) {
+            IterableLogger.e(TAG, e.getLocalizedMessage());
+            promise.reject("", "Failed to fetch messages with error " + e.getLocalizedMessage());
+        }


Function with high complexity (count = 11): getEmbeddedMessages [qlty:function-complexity]

lposen added 3 commits October 13, 2025 11:18

feat: add syncEmbeddedMessages method

760a9e3

feat: implement getEmbeddedMessages method and add example on embedded

1986caa

feat: enhance Embedded component with ScrollView and button details d…

94e46a6

…isplay

lposen changed the base branch from loren/embedded/MOB-12263-android-add-ability-to-sync-embedded-messages to loren/embedded/MOB-12265-start-end-session October 13, 2025 19:36

qltysh bot reviewed Oct 13, 2025

View reviewed changes

android/src/main/java/com/iterable/reactnative/RNIterableAPIModuleImpl.java Show resolved Hide resolved

qltysh bot reviewed Oct 13, 2025

View reviewed changes

android/src/main/java/com/iterable/reactnative/RNIterableAPIModuleImpl.java Show resolved Hide resolved

lposen changed the title ~~feat: add session management methods to IterableEmbeddedManager~~ [MOB-12264] Add sync messages and get messages to android Oct 13, 2025

lposen added the embedded Issues/PRs related to Embedded Messages label Oct 14, 2025

lposen mentioned this pull request Oct 14, 2025

[MOB-7052] Embedded messaging feature #751

Open

Merge branch 'loren/embedded/MOB-12265-start-end-session' into loren/…

bb0c200

…embedded/MOB-12264-android-sync-and-get-messages

lposen marked this pull request as ready for review November 19, 2025 07:35

qltysh bot reviewed Nov 19, 2025

View reviewed changes

android/src/main/java/com/iterable/reactnative/RNIterableAPIModuleImpl.java Show resolved Hide resolved

lposen requested a review from Copilot November 19, 2025 07:36

Copilot started reviewing on behalf of lposen November 19, 2025 07:37 View session

Copilot finished reviewing on behalf of lposen November 19, 2025 07:41

Copilot AI reviewed Nov 19, 2025

View reviewed changes

test: add unit tests for syncEmbeddedMessages and getEmbeddedMessages…

0984e9e

… in IterableEmbeddedManager

qltysh bot reviewed Nov 19, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[MOB-12264] Add sync messages and get messages to android #746

[MOB-12264] Add sync messages and get messages to android #746

Uh oh!

lposen commented Oct 13, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Oct 13, 2025 •

edited

Loading

Uh oh!

qltysh bot commented Oct 13, 2025 •

edited

Loading

Uh oh!

qltysh bot commented Oct 13, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Nov 19, 2025

Uh oh!

Copilot AI Nov 19, 2025

Uh oh!

Copilot AI Nov 19, 2025

Uh oh!

Copilot AI Nov 19, 2025

Uh oh!

Copilot AI Nov 19, 2025

Uh oh!

qltysh bot Nov 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	* Iterable's iOS SDK automatically refresh a local, on-device cache of
	* Iterable's SDK automatically refreshes a local, on-device cache of

		* @param placementIds - The placement IDs to retrieve messages for.
		* @returns A Promise that resolves to an array of embedded messages.

-   * @param placementIds - The placement IDs to retrieve messages for.
-   * @returns A Promise that resolves to an array of embedded messages.
+   * @param placementIds - The placement IDs to retrieve messages for.
+   *                       Pass `null` or an empty array to get messages for all placements.
+   * @returns A Promise that resolves to an array of embedded messages.
+   * @example
+   * ```typescript
+   * // Get messages for specific placements
+   * const messages = await Iterable.embeddedManager.getMessages([123, 456]);
+   *
+   * // Get messages for all placements
+   * const allMessages = await Iterable.embeddedManager.getMessages(null);
+   * ```

[MOB-12264] Add sync messages and get messages to android #746

Are you sure you want to change the base?

[MOB-12264] Add sync messages and get messages to android #746

Uh oh!

Conversation

lposen commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔹 JIRA Ticket(s) if any

✏️ Description

Testing

Uh oh!

github-actions bot commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

qltysh bot commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

qltysh bot commented Oct 13, 2025

2 new issues

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

qltysh bot Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

lposen commented Oct 13, 2025 •

edited

Loading

github-actions bot commented Oct 13, 2025 •

edited

Loading

qltysh bot commented Oct 13, 2025 •

edited

Loading