+ * Use this when display was deferred — by returning {@link IterableInAppHandler.InAppResponse#DEFER} + * from {@link IterableInAppHandler#onNewInApp(IterableInAppMessage)}, or via + * {@link #setAutoDisplayPaused(boolean)} — and your app has since become ready to show in-apps, + * for example once a splash screen is dismissed and the main UI is visible. The SDK otherwise + * only re-checks pending messages on its own triggers (foreground, sync, new message); calling + * this prompts a re-check without one of those occurring. This does not change any stored state; + * it triggers a single display attempt. + *
+ * This is independent of {@link #setAutoDisplayPaused(boolean)}: if auto display is paused, this
+ * call will not show anything until you also call {@code setAutoDisplayPaused(false)}.
+ */
+ public void resumeInAppDisplay() {
+ if (isAutoDisplayPaused()) {
+ IterableLogger.w(TAG, "resumeInAppDisplay() ignored: auto display is paused. Call setAutoDisplayPaused(false) to resume.");
+ }
+ scheduleProcessing();
+ }
+
/**
* Trigger a manual sync. This method is called automatically by the SDK, so there should be no
* need to call this method from your app.
@@ -398,7 +415,20 @@ public int compare(IterableInAppMessage message1, IterableInAppMessage message2)
}
private void processMessages() {
- if (!activityMonitor.isInForeground() || isShowingInApp() || !canShowInAppAfterPrevious() || isAutoDisplayPaused()) {
+ if (!activityMonitor.isInForeground()) {
+ IterableLogger.d(TAG, "processMessages skipped: app is not in foreground");
+ return;
+ }
+ if (isShowingInApp()) {
+ IterableLogger.d(TAG, "processMessages skipped: an in-app is already showing");
+ return;
+ }
+ if (!canShowInAppAfterPrevious()) {
+ IterableLogger.d(TAG, "processMessages skipped: within the in-app display interval");
+ return;
+ }
+ if (isAutoDisplayPaused()) {
+ IterableLogger.d(TAG, "processMessages skipped: auto display is paused");
return;
}
@@ -412,6 +442,12 @@ private void processMessages() {
IterableLogger.d(TAG, "Calling onNewInApp on " + message.getMessageId());
InAppResponse response = handler.onNewInApp(message);
IterableLogger.d(TAG, "Response: " + response);
+
+ if (response == InAppResponse.DEFER) {
+ // Leave the message unprocessed so it is reconsidered on a later display pass.
+ continue;
+ }
+
message.setProcessed(true);
if (message.isJsonOnly()) {
@@ -462,6 +498,10 @@ private boolean canShowInAppAfterPrevious() {
return getSecondsSinceLastInApp() >= inAppDisplayInterval;
}
+ boolean isAutoDisplayPaused() {
+ return autoDisplayPaused;
+ }
+
private void handleIterableCustomAction(String actionName, IterableInAppMessage message) {
if (IterableConstants.ITERABLE_IN_APP_ACTION_DELETE.equals(actionName)) {
removeMessage(message, IterableInAppDeleteActionType.DELETE_BUTTON, IterableInAppLocation.IN_APP, null, null);
diff --git a/iterableapi/src/test/java/com/iterable/iterableapi/IterableInAppManagerTest.java b/iterableapi/src/test/java/com/iterable/iterableapi/IterableInAppManagerTest.java
index 2a5902978..8733087cf 100644
--- a/iterableapi/src/test/java/com/iterable/iterableapi/IterableInAppManagerTest.java
+++ b/iterableapi/src/test/java/com/iterable/iterableapi/IterableInAppManagerTest.java
@@ -92,6 +92,10 @@ public IterableConfig.Builder run(IterableConfig.Builder builder) {
public void tearDown() throws IOException {
server.shutdown();
server = null;
+ // Tests that swap in a spy in-app manager register it on the activity monitor; reset the
+ // monitor so a leaked manager doesn't consume the next test's enqueued response on foreground.
+ IterableActivityMonitor.getInstance().unregisterLifecycleCallbacks(getContext());
+ IterableActivityMonitor.instance = new IterableActivityMonitor();
}
@Ignore("Stalls under Robolectric: showIterableFragmentNotificationHTML requires real Activity lifecycle - candidate for androidTest with Espresso")
@@ -398,6 +402,118 @@ public void testInAppAutoDisplayPause() throws Exception {
verify(inAppHandler, times(1)).onNewInApp(inAppMessageCaptor.capture());
}
+ private IterableInAppManager createManagerWithHandler(IterableInAppDisplayer displayer, IterableInAppHandler handler) {
+ IterableActivityMonitor.getInstance().unregisterLifecycleCallbacks(getContext());
+ IterableActivityMonitor.instance = new IterableActivityMonitor();
+ IterableInAppManager inAppManager = spy(new IterableInAppManager(IterableApi.sharedInstance, handler, 30.0, new IterableInAppMemoryStorage(), IterableActivityMonitor.getInstance(), displayer));
+ IterableApi.sharedInstance = new IterableApi(inAppManager);
+ IterableTestUtils.createIterableApiNew(new IterableTestUtils.ConfigBuilderExtender() {
+ @Override
+ public IterableConfig.Builder run(IterableConfig.Builder builder) {
+ return builder.setCustomActionHandler(customActionHandler).setUrlHandler(urlHandler);
+ }
+ });
+ shadowOf(getMainLooper()).idle();
+ return inAppManager;
+ }
+
+ @Test
+ public void testDeferLeavesMessagePendingWithoutConsuming() throws Exception {
+ dispatcher.enqueueResponse("/inApp/getMessages", new MockResponse().setBody(IterableTestUtils.getResourceString("inapp_payload_single.json")));
+
+ IterableInAppDisplayer displayerMock = mock(IterableInAppDisplayer.class);
+ IterableInAppHandler handler = mock(IterableInAppHandler.class);
+ doReturn(IterableInAppHandler.InAppResponse.DEFER).when(handler).onNewInApp(any(IterableInAppMessage.class));
+ IterableInAppManager inAppManager = createManagerWithHandler(displayerMock, handler);
+
+ Robolectric.buildActivity(Activity.class).create().start().resume();
+ shadowOf(getMainLooper()).idle();
+
+ verify(handler).onNewInApp(any(IterableInAppMessage.class));
+ verify(displayerMock, never()).showMessage(any(IterableInAppMessage.class), any(IterableInAppLocation.class), any(IterableHelper.IterableUrlCallback.class));
+ // Deferred, not consumed: message remains available and unprocessed for a later pass
+ assertEquals(1, inAppManager.getMessages().size());
+ assertFalse(inAppManager.getMessages().get(0).isProcessed());
+ assertFalse(inAppManager.getMessages().get(0).isConsumed());
+ }
+
+ @Test
+ public void testDeferThenShowDisplaysOnLaterPass() throws Exception {
+ dispatcher.enqueueResponse("/inApp/getMessages", new MockResponse().setBody(IterableTestUtils.getResourceString("inapp_payload_single.json")));
+
+ IterableInAppDisplayer displayerMock = mock(IterableInAppDisplayer.class);
+ IterableInAppHandler handler = mock(IterableInAppHandler.class);
+ // Defer on the first pass, then allow display on the next
+ doReturn(IterableInAppHandler.InAppResponse.DEFER, IterableInAppHandler.InAppResponse.SHOW).when(handler).onNewInApp(any(IterableInAppMessage.class));
+ IterableInAppManager inAppManager = createManagerWithHandler(displayerMock, handler);
+
+ // First pass: deferred, nothing shown
+ Robolectric.buildActivity(Activity.class).create().start().resume();
+ shadowOf(getMainLooper()).idle();
+ verify(displayerMock, never()).showMessage(any(IterableInAppMessage.class), any(IterableInAppLocation.class), any(IterableHelper.IterableUrlCallback.class));
+
+ // App prompts a re-check via the public API (no background->foreground transition);
+ // handler now returns SHOW and the message is displayed
+ inAppManager.resumeInAppDisplay();
+ shadowOf(getMainLooper()).idle();
+ verify(displayerMock).showMessage(any(IterableInAppMessage.class), eq(IterableInAppLocation.IN_APP), any(IterableHelper.IterableUrlCallback.class));
+ }
+
+ @Test
+ public void testResumeInAppDisplayIsNoOpWhilePaused() throws Exception {
+ dispatcher.enqueueResponse("/inApp/getMessages", new MockResponse().setBody(IterableTestUtils.getResourceString("inapp_payload_single.json")));
+ IterableInAppManager inAppManager = IterableApi.getInstance().getInAppManager();
+
+ inAppManager.syncInApp();
+ shadowOf(getMainLooper()).idle();
+ assertEquals(1, inAppManager.getMessages().size());
+
+ inAppManager.setAutoDisplayPaused(true);
+ Robolectric.buildActivity(Activity.class).create().start().resume();
+ shadowOf(getMainLooper()).idle();
+ ArgumentCaptor