Add actionNamed handler. Run dismiss action in templates. (#460)

Author: hborisoff

AndroidSDKCore/src/main/java/com/leanplum/ActionContext.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014, Leanplum, Inc. All rights reserved.
+ * Copyright 2021, Leanplum, Inc. All rights reserved.
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -24,6 +24,7 @@
 import androidx.annotation.NonNull;
 import android.text.TextUtils;
 
+import com.leanplum.callbacks.ActionCallback;
 import com.leanplum.callbacks.VariablesChangedCallback;
 import com.leanplum.internal.ActionManager;
 import com.leanplum.internal.BaseActionContext;
@@ -33,7 +34,6 @@
 import com.leanplum.internal.JsonConverter;
 import com.leanplum.internal.LeanplumInternal;
 import com.leanplum.internal.Log;
-import com.leanplum.internal.Util;
 import com.leanplum.internal.VarCache;
 
 import org.json.JSONException;
@@ -57,6 +57,7 @@ public class ActionContext extends BaseActionContext implements Comparable<Actio
   private String key;
   private boolean preventRealtimeUpdating = false;
   private ContextualValues contextualValues;
+  private ActionCallback actionNamedHandler;
 
   public static class ContextualValues {
     /**
@@ -351,12 +352,27 @@ private Map<String, Object> getChildArgs(String name) {
     return actionArgs;
   }
 
+  public void setActionNamedHandler(ActionCallback handler) {
+    actionNamedHandler = handler;
+  }
+
+  private void triggerActionNamedHandler(String name, Map<String, Object> args) {
+    if (actionNamedHandler != null) {
+      ActionContext actionContext = new ActionContext(name, args, messageId);
+      actionContext.parentContext = this;
+      actionNamedHandler.onResponse(actionContext);
+    }
+  }
+
   public void runActionNamed(String name) {
     if (TextUtils.isEmpty(name)) {
       Log.e("runActionNamed - Invalid name parameter provided.");
       return;
     }
     Map<String, Object> args = getChildArgs(name);
+
+    triggerActionNamedHandler(name, args);
+
     if (args == null) {
       return;
     }
@@ -613,4 +629,8 @@ public static JSONObject mapToJsonObject(Map<String, ?> map) throws JSONExceptio
   public static <T> Map<String, T> mapFromJson(JSONObject jsonObject) throws JSONException {
     return JsonConverter.mapFromJson(jsonObject);
   }
+
+  public ActionContext getParentContext() {
+    return parentContext;
+  }
 }

AndroidSDKCore/src/main/java/com/leanplum/messagetemplates/controllers/AbstractPopupController.java

@@ -62,6 +62,11 @@ public BaseMessageOptions getOptions() {
     return options;
   }
 
+  @Override
+  protected void runDismissAction() {
+    options.dismiss();
+  }
+
   @Override
   void addMessageChildViews(RelativeLayout parent) {
     ImageView image = createBackgroundImageView(activity);

AndroidSDKCore/src/main/java/com/leanplum/messagetemplates/controllers/BaseController.java

@@ -117,6 +117,17 @@ private RelativeLayout createMessageView() {
    */
   abstract void applyWindowDecoration();
 
+  /**
+   * Calls ActionContext.runActionNamed for dismiss action.
+   */
+  protected abstract void runDismissAction();
+
+  @Override
+  public void onBackPressed() {
+    runDismissAction();
+    super.onBackPressed();
+  }
+
   @Override
   public void cancel() {
     if (isClosing) {
@@ -158,7 +169,10 @@ private CloseButton createCloseButton(View alignView) {
       closeLayout.setMargins(0, -SizeUtil.dp7, -SizeUtil.dp7, 0);
     }
     closeButton.setLayoutParams(closeLayout);
-    closeButton.setOnClickListener(clickedView -> cancel());
+    closeButton.setOnClickListener(clickedView -> {
+      runDismissAction();
+      cancel();
+    });
     return closeButton;
   }
 

AndroidSDKCore/src/main/java/com/leanplum/messagetemplates/controllers/RichHtmlController.java

@@ -79,6 +79,14 @@ boolean isFullscreen() {
     return richOptions.isFullScreen();
   }
 
+  @Override
+  protected void runDismissAction() {
+    // need to check state, because touches from banner sometimes trigger more than 1 action
+    if (!isClosing) {
+      richOptions.dismiss();
+    }
+  }
+
   @Override
   protected void applyWindowDecoration() {
     if (isFullscreen())
@@ -242,6 +250,7 @@ private boolean handleOpenEvent(String url) {
 
   private boolean handleCloseEvent(String url) {
     if (url.contains(richOptions.getCloseUrl())) {
+      runDismissAction();
       cancel();
       String queryComponentsFromUrl = queryComponentsFromUrl(url, "result");
       if (!TextUtils.isEmpty(queryComponentsFromUrl)) {
@@ -411,6 +420,7 @@ public boolean dispatchTouchEvent(@NonNull MotionEvent ev) {
 
       if (ev.getY() < top || ev.getY() > bottom || ev.getX() < left || ev.getX() > right) {
         if (richOptions.isHtmlTabOutsideToClose()) {
+          runDismissAction();
           cancel();
         }
         activity.dispatchTouchEvent(ev);

AndroidSDKCore/src/main/java/com/leanplum/messagetemplates/controllers/WebInterstitialController.java

@@ -56,6 +56,11 @@ protected boolean hasDismissButton() {
     return webOptions.hasDismissButton();
   }
 
+  @Override
+  protected void runDismissAction() {
+    webOptions.dismiss();
+  }
+
   @Override
   boolean isFullscreen() {
     return true;
@@ -106,6 +111,7 @@ public boolean shouldOverrideUrlLoading(WebView wView, String url) {
 
   private boolean handleCloseEvent(String url) {
     if (url.contains(webOptions.getCloseUrl())) {
+      runDismissAction();
       cancel();
       String[] urlComponents = url.split("\\?");
       if (urlComponents.length > 1) {

AndroidSDKCore/src/main/java/com/leanplum/messagetemplates/options/BaseMessageOptions.java

@@ -155,6 +155,10 @@ public void accept() {
     context.runTrackedActionNamed(Args.ACCEPT_ACTION);
   }
 
+  public void dismiss() {
+    context.runActionNamed(Args.DISMISS_ACTION);
+  }
+
   public static ActionArgs toArgs(Context currentContext) {
     return new ActionArgs()
         .with(Args.TITLE_TEXT, Util.getApplicationName(currentContext))

AndroidSDKCore/src/main/java/com/leanplum/messagetemplates/options/RichHtmlOptions.java

@@ -372,4 +372,8 @@ public boolean isBannerWithTapOutsideFalse() {
     String templateName = getActionContext().getArgs().get(Values.HTML_TEMPLATE_PREFIX).toString();
     return templateName.toLowerCase().contains("banner") && !isHtmlTabOutsideToClose();
   }
+
+  public void dismiss() {
+    actionContext.runActionNamed(Args.DISMISS_ACTION);
+  }
 }

AndroidSDKCore/src/main/java/com/leanplum/messagetemplates/options/WebInterstitialOptions.java

@@ -36,11 +36,13 @@ public class WebInterstitialOptions {
   private String url;
   private String closeUrl;
   private boolean hasDismissButton;
+  private ActionContext actionContext;
 
   public WebInterstitialOptions(ActionContext context) {
     this.setUrl(context.stringNamed(Args.URL));
     this.setHasDismissButton(context.booleanNamed(Args.HAS_DISMISS_BUTTON));
     this.setCloseUrl(context.stringNamed(Args.CLOSE_URL));
+    this.actionContext = context;
   }
 
   public String getUrl() {
@@ -67,6 +69,10 @@ private void setCloseUrl(String closeUrl) {
     this.closeUrl = closeUrl;
   }
 
+  public void dismiss() {
+    actionContext.runActionNamed(Args.DISMISS_ACTION);
+  }
+
   public static ActionArgs toArgs() {
     return new ActionArgs()
         .with(Args.URL, Values.DEFAULT_URL)