Implement support for notification.vibrate

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

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package org.chromium.chrome.browser.notifications;
 
 import android.app.Notification;
 import android.app.NotificationManager;
 import android.app.PendingIntent;
 import android.content.Context;
@@ skipping 285 matching lines @@
      * @param origin Full text of the origin, including the protocol, owning this notification.
      * @param tag A string identifier for this notification. If the tag is not empty, the new
      *            notification will replace the previous notification with the same tag and origin,
      *            if present. If no matching previous notification is present, the new one will just
      *            be added.
      * @param title Title to be displayed in the notification.
      * @param body Message to be displayed in the notification. Will be trimmed to one line of
      *             text by the Android notification system.
      * @param icon Icon to be displayed in the notification. When this isn't a valid Bitmap, a
      *             default icon will be generated instead.
+     * @param vibrate Vibration pattern for the Notification. A notification that vibrates is

[Peter Beverloo, 2015/04/26 23:26:41]

nit: Remove the "A notification...heads-up notification." bit please. What
behavior Android gives us when using a vibration pattern will be completely up
to the version and the OEM running on the device.

What I meant with the "@see ..." remark in my previous comment is that we can
have a new line in this block-comment, after line 308, which says:

@see https://developer.android.com/reference/android/app/Notification.html

That way people can find additional information about displaying a notification
and usage of the properties on that page.

[Sanghyun Park, 2015/04/27 14:00:00]

I missunderstood about this. 
I'll add "@see
https://developer.android.com/reference/android/app/Notification.html"
Thanks!

+     *                more likely to be presented as a heads-up notification.
      * @param silent Whether the default sound, vibration and lights should be suppressed.
      */
     @CalledByNative
     private void displayNotification(long persistentNotificationId, String origin, String tag,
-            String title, String body, Bitmap icon, boolean silent) {
+            String title, String body, Bitmap icon, int[] vibrate, boolean silent) {
         if (icon == null || icon.getWidth() == 0) {
             icon = getIconGenerator().generateIconForUrl(origin, true);
         }
 
         Resources res = mAppContext.getResources();
 
         // The data used to make each intent unique according to the rules of Intent#filterEquals.
         // Without this, the pending intents derived from them may be reused, because extras are
         // not taken into account for the filterEquals comparison.
         Uri intentData = Uri.parse(origin).buildUpon().fragment(
@@ skipping 21 matching lines @@
                 .setDeleteIntent(getPendingIntent(
                         NotificationConstants.ACTION_CLOSE_NOTIFICATION,
                         persistentNotificationId, origin, tag, intentData))
                 .addAction(R.drawable.settings_cog,
                            res.getString(R.string.page_info_site_settings_button),
                            pendingSettingsIntent)
                 .setSubText(origin);
 
         // Use the system's default ringtone, vibration and indicator lights unless the notification
         // has been marked as being silent, for example because it's low priority.
-        if (!silent) notificationBuilder.setDefaults(Notification.DEFAULT_ALL);
+        // If a vibration pattern is set, the notification should use the provided pattern

[Peter Beverloo, 2015/04/26 23:26:41]

Could we perhaps extract this block to a separate method? It's quite a bit of
extra logic, part of which could have some unit tests as well (see
testGetOriginFromTag() in
chrome/android/javatests/src/org/chromium/chrome/browser/notifications/NotificationUIManagerTest.java).

[Sanghyun Park, 2015/04/27 14:00:00]

Sure, I'll make method and add testcase.

+        // rather than the defaulting to system settings.
+        assert silent && vibrate.length == 0;
+
+        int defaults = Notification.DEFAULT_ALL;
+        if (silent) defaults = 0;
+
+        if (vibrate.length > 0) {
+            // In Android platform, the first value indicates the number of
+            // milliseconds to wait before turning the vibrator on unlike Blink.
+            // So, we need to insert any value at the beginning of vibrate value.
+            long[] pattern = new long[vibrate.length + 1];
+            pattern[0] = 0;
+            for (int i = 0; i < vibrate.length; ++i) {

[Peter Beverloo, 2015/04/26 23:26:41]

Check out System.arraycopy() :-)

[Sanghyun Park, 2015/04/27 14:00:00]

Unfortunately, we cannot use "arraycopy()".
For using arraycopy(), src type is matched with dst type.
The src(vibrate) is int array, but dst(pattern) is long array 
Notification.Builder.setDefaults's parameter has long type..

I didn't prefer this also, I want to find solution. but I cannot  yet.

+                pattern[i + 1] = vibrate[i];
+            }
+            defaults &= ~Notification.DEFAULT_VIBRATE;

[Peter Beverloo, 2015/04/26 23:26:41]

nit: I'd have this line as the first line in the if-clause (line 362) since it
relates to the code just above there, maintaining chronology.

[Sanghyun Park, 2015/04/27 14:00:00]

Done.

+            notificationBuilder.setVibrate(pattern);
+        }
+        notificationBuilder.setDefaults(defaults);
 
         String platformTag = makePlatformTag(persistentNotificationId, origin, tag);
         mNotificationManager.notify(platformTag, PLATFORM_ID, notificationBuilder.build());
     }
 
     /**
      * Ensures the existance of an icon generator, which is created lazily.
      *
      * @return The icon generator which can be used.
      */
@@ skipping 73 matching lines @@
                                           origin, tag);
     }
 
     private static native void nativeInitializeNotificationUIManager();
 
     private native boolean nativeOnNotificationClicked(long nativeNotificationUIManagerAndroid,
             long persistentNotificationId, String origin, String tag);
     private native boolean nativeOnNotificationClosed(long nativeNotificationUIManagerAndroid,
             long persistentNotificationId, String origin, String tag);
 }