[MOB 5730] Add callbacks to reading/removing in-app messages

iterableapi/src/main/java/com/iterable/iterableapi/IterableApi.java

@@ -38,6 +38,7 @@ public class IterableApi {
     private IterableNotificationData _notificationData;
     private String _deviceId;
     private boolean _firstForegroundHandled;
+    private ResultCallbackHandler callbackHandler;
 
     IterableApiClient apiClient = new IterableApiClient(new IterableApiAuthProvider());
     private @Nullable IterableInAppManager inAppManager;
@@ -678,14 +679,15 @@ public void trackPushOpen(int campaignId, int templateId, @NonNull String messag
     /**
      * Consumes an InApp message.
      * @param messageId
+     * @param callbackHandler The callback which returns `success` or `failure`.
      */
-    public void inAppConsume(@NonNull String messageId) {
+    public void inAppConsume(@NonNull String messageId, @Nullable ResultCallbackHandler callbackHandler) {
         IterableInAppMessage message = getInAppManager().getMessageById(messageId);
         if (message == null) {
             IterableLogger.e(TAG, "inAppConsume: message is null");
             return;
         }
-        inAppConsume(message, null, null);
+        inAppConsume(message, null, null, callbackHandler);
         IterableLogger.printInfo();
     }
 
@@ -697,13 +699,13 @@ public void inAppConsume(@NonNull String messageId) {
      * @param message message object
      * @param source An enum describing how the in App delete was triggered
      * @param clickLocation The module in which the action happened
+     * @param callbackHandler The callback which returns `success` or `failure`.
      */
-    public void inAppConsume(@NonNull IterableInAppMessage message, @Nullable IterableInAppDeleteActionType source, @Nullable IterableInAppLocation clickLocation) {
+    public void inAppConsume(@NonNull IterableInAppMessage message, @Nullable IterableInAppDeleteActionType source, @Nullable IterableInAppLocation clickLocation, @Nullable ResultCallbackHandler callbackHandler) {
         if (!checkSDKInitialization()) {
             return;
         }
-
-        apiClient.inAppConsume(message, source, clickLocation, inboxSessionId);
+        apiClient.inAppConsume(message, source, clickLocation, inboxSessionId, callbackHandler);
     }
 
     /**

iterableapi/src/main/java/com/iterable/iterableapi/IterableApiClient.java

@@ -315,7 +315,7 @@ void trackInAppDelivery(@NonNull IterableInAppMessage message) {
         }
     }
 
-    public void inAppConsume(@NonNull IterableInAppMessage message, @Nullable IterableInAppDeleteActionType source, @Nullable IterableInAppLocation clickLocation, @Nullable String inboxSessionId) {
+    public void inAppConsume(@NonNull IterableInAppMessage message, @Nullable IterableInAppDeleteActionType source, @Nullable IterableInAppLocation clickLocation, @Nullable String inboxSessionId, @Nullable final ResultCallbackHandler callbackHandler) {
         JSONObject requestJSON = new JSONObject();
 
         try {
@@ -333,8 +333,22 @@ public void inAppConsume(@NonNull IterableInAppMessage message, @Nullable Iterab
             if (clickLocation == IterableInAppLocation.INBOX) {
                 addInboxSessionID(requestJSON, inboxSessionId);
             }
-
-            sendPostRequest(IterableConstants.ENDPOINT_INAPP_CONSUME, requestJSON);
+
+            sendPostRequest(IterableConstants.ENDPOINT_INAPP_CONSUME, requestJSON, new IterableHelper.SuccessHandler() {
+                @Override
+                public void onSuccess(@NonNull JSONObject data) {
+                    if (callbackHandler != null) {
+                        callbackHandler.sendResult(true);
+                    }
+                }
+            }, new IterableHelper.FailureHandler() {
+                @Override
+                public void onFailure(@NonNull String reason, @Nullable JSONObject data) {
+                    if (callbackHandler != null) {
+                        callbackHandler.sendResult(false);
+                    }
+                }
+            });
         } catch (JSONException e) {
             e.printStackTrace();
         }

iterableapi/src/main/java/com/iterable/iterableapi/IterableInAppFragmentHTMLNotification.java

@@ -417,7 +417,7 @@ private void processMessageRemoval() {
         }
 
         if (message.isMarkedForDeletion() && !message.isConsumed()) {
-            IterableApi.sharedInstance.getInAppManager().removeMessage(message);
+            IterableApi.sharedInstance.getInAppManager().removeMessage(message, null);
         }
     }
 

iterableapi/src/main/java/com/iterable/iterableapi/IterableInAppManager.java

@@ -131,9 +131,13 @@ public synchronized int getUnreadInboxMessagesCount() {
      * Set the read flag on an inbox message
      * @param message Inbox message object retrieved from {@link IterableInAppManager#getInboxMessages()}
      * @param read Read state flag. true = read, false = unread
+     * @param callbackHandler The callback which returns `success` or `failure`.
      */
-    public synchronized void setRead(@NonNull IterableInAppMessage message, boolean read) {
+    public synchronized void setRead(@NonNull IterableInAppMessage message, boolean read, @Nullable ResultCallbackHandler callbackHandler) {
         message.setRead(read);
+        if(callbackHandler != null){
+            callbackHandler.sendResult(true);
+        }
         notifyOnChange();
     }
 
@@ -248,17 +252,18 @@ public void execute(Uri url) {
     /**
      * Remove message from the list
      * @param message The message to be removed
+     * @param callbackHandler The callback which returns `success` or `failure`.
      */
-    public synchronized void removeMessage(@NonNull IterableInAppMessage message) {
+    public synchronized void removeMessage(@NonNull IterableInAppMessage message, @Nullable ResultCallbackHandler callbackHandler) {
         message.setConsumed(true);
-        api.inAppConsume(message.getMessageId());
+        api.inAppConsume(message.getMessageId(), callbackHandler);
         notifyOnChange();
     }
 
-    public synchronized void removeMessage(@NonNull IterableInAppMessage message, @NonNull IterableInAppDeleteActionType source, @NonNull IterableInAppLocation clickLocation) {
+    public synchronized void removeMessage(@NonNull IterableInAppMessage message, @NonNull IterableInAppDeleteActionType source, @NonNull IterableInAppLocation clickLocation, @Nullable ResultCallbackHandler callbackHandler) {
         IterableLogger.printInfo();
         message.setConsumed(true);
-        api.inAppConsume(message, source, clickLocation);
+        api.inAppConsume(message, source, clickLocation, callbackHandler);
         notifyOnChange();
     }
 

iterableapi/src/main/java/com/iterable/iterableapi/ResultCallbackHandler.java

 } 
 public interface SuccessCallback<T> { 
     void onSuccess(T result); 
 } 
 public interface FailureCallback { 
     void onFailure(Throwable throwable); 
 } 
@@ -0,0 +1,13 @@
+package com.iterable.iterableapi;
+
+/**
+ * Handler to pass result of success/failure for setemail/setuserid
+ */
+public interface ResultCallbackHandler {
+
+ /**
+  * Callback called when registertoken API hits
+  * @param success can be true or false based on result of registertoken API success/failure
+  */
+   void sendResult(boolean success);
+}

iterableapi/src/test/java/com/iterable/iterableapi/IterableInboxTest.java

@@ -78,18 +78,57 @@ public void testInboxMessageOrdering() throws Exception {
         assertEquals("message4", inboxMessages.get(1).getMessageId());
     }
 
+    @Test
+    public void testRemoveMessage() throws Exception {
+        dispatcher.enqueueResponse("/inApp/getMessages", new MockResponse().setBody(IterableTestUtils.getResourceString("inapp_payload_inbox_multiple.json")));
+        IterableInAppManager inAppManager = IterableApi.getInstance().getInAppManager();
+        inAppManager.syncInApp();
+        shadowOf(getMainLooper()).idle();
+        List<IterableInAppMessage> inboxMessages = inAppManager.getInboxMessages();
+        assertEquals(2, inboxMessages.size());
+        assertEquals(1, inAppManager.getUnreadInboxMessagesCount());
+        inAppManager.removeMessage(inboxMessages.get(0), IterableInAppLocation.inbox, IterableInAppDeleteSource.deleteButton, new IterableHelper.SuccessHandler() {
+            @Override
+            public void onSuccess() {
+                assertEquals(1, inAppManager.getInboxMessages().size());
+                assertEquals("message2", inAppManager.getInboxMessages().get(0).getMessageId());
+            }
+        });
+        assertEquals(1, inAppManager.getInboxMessages().size());
+        assertEquals("message2", inAppManager.getInboxMessages().get(0).getMessageId());
+    }
+
     @Test
     public void testSetRead() throws Exception {
+        // Set up mock response
         dispatcher.enqueueResponse("/inApp/getMessages", new MockResponse().setBody(IterableTestUtils.getResourceString("inapp_payload_inbox_multiple.json")));
+
+        // Initialize in-app manager and wait for messages to be synced
         IterableInAppManager inAppManager = IterableApi.getInstance().getInAppManager();
         inAppManager.syncInApp();
         shadowOf(getMainLooper()).idle();
+
+        // Get inbox messages
         List<IterableInAppMessage> inboxMessages = inAppManager.getInboxMessages();
+
+        // Verify initial state
         assertEquals(1, inAppManager.getUnreadInboxMessagesCount());
         assertEquals(2, inboxMessages.size());
         assertFalse(inboxMessages.get(0).isRead());
         assertTrue(inboxMessages.get(1).isRead());
-        inAppManager.setRead(inboxMessages.get(0), true);
+
+        // Set first message as read with a callback
+        boolean[] callbackCalled = { false };
+        inAppManager.setRead(inboxMessages.get(0), true, success -> {
+            callbackCalled[0] = true;
+            assertTrue(success);
+        });
+
+        // Wait for callback to be called
+        shadowOf(getMainLooper()).idle();
+
+        // Verify that callback was called and that message is marked as read
+        assertTrue(callbackCalled[0]);
         assertEquals(0, inAppManager.getUnreadInboxMessagesCount());
         assertEquals(2, inAppManager.getInboxMessages().size());
         assertTrue(inboxMessages.get(0).isRead());