Plumb through notification action types and placeholders on Android

chrome/android/java/src/org/chromium/chrome/browser/notifications/NotificationBuilderBase.java

Index: chrome/android/java/src/org/chromium/chrome/browser/notifications/NotificationBuilderBase.java
diff --git a/chrome/android/java/src/org/chromium/chrome/browser/notifications/NotificationBuilderBase.java b/chrome/android/java/src/org/chromium/chrome/browser/notifications/NotificationBuilderBase.java
index 657b0e066dec52a7f71cd4a222f29156cf579e3d..3c8f2deb73ef3c8da52a2010c83993ac681ce9a1 100644
--- a/chrome/android/java/src/org/chromium/chrome/browser/notifications/NotificationBuilderBase.java
+++ b/chrome/android/java/src/org/chromium/chrome/browser/notifications/NotificationBuilderBase.java
@@ -7,6 +7,7 @@ package org.chromium.chrome.browser.notifications;
 import android.annotation.TargetApi;
 import android.app.Notification;
 import android.app.PendingIntent;
+import android.app.RemoteInput;
 import android.content.Context;
 import android.content.res.Resources;
 import android.graphics.Bitmap;
@@ -32,21 +33,46 @@ import javax.annotation.Nullable;
  */
 public abstract class NotificationBuilderBase {
     protected static class Action {
+        enum Type {
+            /**
+             * Regular action that triggers the provided intent when tapped.
+             */
+            BUTTON,
+
+            /**
+             * Action that triggers a remote input when tapped, for Android Wear input and inline
+             * replies from Android N.
+             */
+            TEXT
+        }
+
         public int iconId;
         public Bitmap iconBitmap;
         public CharSequence title;
         public PendingIntent intent;
+        public Type type;
+
+        /**
+         * If the action.type is TEXT, this corresponds to the placeholder text for the input.
+         */
+        public String placeholder;
 
-        Action(int iconId, CharSequence title, PendingIntent intent) {
+        Action(int iconId, CharSequence title, PendingIntent intent, Type type,
+                String placeholder) {
             this.iconId = iconId;
             this.title = title;
             this.intent = intent;
+            this.type = type;
+            this.placeholder = placeholder;
         }
 
-        Action(Bitmap iconBitmap, CharSequence title, PendingIntent intent) {
+        Action(Bitmap iconBitmap, CharSequence title, PendingIntent intent, Type type,
+                String placeholder) {
             this.iconBitmap = iconBitmap;
             this.title = title;
             this.intent = intent;
+            this.type = type;
+            this.placeholder = placeholder;
         }
     }
 
@@ -202,11 +228,29 @@ public abstract class NotificationBuilderBase {
     }
 
     /**
-     * Adds an action to the notification. Actions are typically displayed as a button adjacent to
-     * the notification content.
+     * Adds an action to the notification, displayed as a button adjacent to the notification
+     * content.
      */
-    public NotificationBuilderBase addAction(@Nullable Bitmap iconBitmap,
+    public NotificationBuilderBase addButtonAction(@Nullable Bitmap iconBitmap,
             @Nullable CharSequence title, @Nullable PendingIntent intent) {
+        addAuthorProvidedAction(iconBitmap, title, intent, Action.Type.BUTTON, null);
+        return this;
+    }
+
+    /**
+     * Adds an action to the notification, displayed as a button adjacent to the notification
+     * content, which when tapped will trigger a remote input. This enables Android Wear input and,
+     * from Android N, displays a text box within the notification for inline replies.
+     */
+    public NotificationBuilderBase addTextAction(@Nullable Bitmap iconBitmap,
+            @Nullable CharSequence title, @Nullable PendingIntent intent,
+            @Nullable String placeholder) {

[Peter Beverloo, 2016/09/26 16:04:34]

nit: drop @Nullable from |placeholder|

[awdf, 2016/09/27 14:45:26]

Done.

+        addAuthorProvidedAction(iconBitmap, title, intent, Action.Type.TEXT, placeholder);
+        return this;
+    }
+
+    private void addAuthorProvidedAction(@Nullable Bitmap iconBitmap, @Nullable CharSequence title,
+            @Nullable PendingIntent intent, Action.Type actionType, @Nullable String placeholder) {
         if (mActions.size() == MAX_AUTHOR_PROVIDED_ACTION_BUTTONS) {
             throw new IllegalStateException(
                     "Cannot add more than " + MAX_AUTHOR_PROVIDED_ACTION_BUTTONS + " actions.");
@@ -214,8 +258,7 @@ public abstract class NotificationBuilderBase {
         if (iconBitmap != null) {
             applyWhiteOverlayToBitmap(iconBitmap);
         }
-        mActions.add(new Action(iconBitmap, limitLength(title), intent));
-        return this;
+        mActions.add(new Action(iconBitmap, limitLength(title), intent, actionType, placeholder));
     }
 
     /**
@@ -223,7 +266,7 @@ public abstract class NotificationBuilderBase {
      */
     public NotificationBuilderBase addSettingsAction(
             int iconId, @Nullable CharSequence title, @Nullable PendingIntent intent) {
-        mSettingsAction = new Action(iconId, limitLength(title), intent);
+        mSettingsAction = new Action(iconId, limitLength(title), intent, Action.Type.BUTTON, null);
         return this;
     }
 
@@ -369,15 +412,35 @@ public abstract class NotificationBuilderBase {
      * level is high enough, otherwise a resource id is used.
      */
     @SuppressWarnings("deprecation") // For addAction(int, CharSequence, PendingIntent)
-    @TargetApi(Build.VERSION_CODES.M) // For the Icon class.
     protected static void addActionToBuilder(Notification.Builder builder, Action action) {
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT_WATCH) {
+            // Notification.Action.Builder and RemoteInput were added in KITKAT_WATCH.
+            Notification.Action.Builder actionBuilder = getActionBuilder(action);
+            if (action.type == Action.Type.TEXT) {
+                actionBuilder.addRemoteInput(
+                        new RemoteInput.Builder(NotificationConstants.KEY_TEXT_REPLY)
+                                .setLabel(action.placeholder != null ? action.placeholder : "")

[Peter Beverloo, 2016/09/26 16:04:34]

nit: drop the NULL check - addTextAction() is the only path through which we can
get here, where we know it not to be NULL.

You could add some future-proofing decoration too:

  assert !TextUtils.isEmpty(action.placeholder);

[awdf, 2016/09/27 14:45:27]

I thought we agreed that we'd allow the developer to set an empty string as the
placeholder if they want to?

Have added an 'assert action.placeholder != null;' though, and removed the other
nullcheck

[Peter Beverloo, 2016/09/27 15:28:31]

Sorry, you're right! We only have to assert that the placeholder is not NULL.

+                                .build());
+            }
+            builder.addAction(actionBuilder.build());
+        } else {
+            builder.addAction(action.iconId, action.title, action.intent);
+        }
+    }
+
+    @TargetApi(Build.VERSION_CODES.KITKAT_WATCH) // For Notification.Action.Builder
+    @SuppressWarnings("deprecation") // For Builder(int, CharSequence, PendingIntent)
+    private static Notification.Action.Builder getActionBuilder(Action action) {
+        Notification.Action.Builder actionBuilder;
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M && action.iconBitmap != null) {
+            // Icon was added in Android M.
             Icon icon = Icon.createWithBitmap(action.iconBitmap);
-            builder.addAction(
-                    new Notification.Action.Builder(icon, action.title, action.intent).build());
+            actionBuilder = new Notification.Action.Builder(icon, action.title, action.intent);
         } else {
-            builder.addAction(action.iconId, action.title, action.intent);
+            actionBuilder =
+                    new Notification.Action.Builder(action.iconId, action.title, action.intent);
         }
+        return actionBuilder;
     }
 
     /**