Add ongoing notifications for android (#1996)

* ✨ add function for setting ongoing parameter

* 📝 Update payload documentation for ongoing parameter

* 🎨 improve code style of function 'setNotificationOngoing'

docs/PAYLOAD.md

@@ -21,6 +21,7 @@
  - [Huawei and Xiaomi Phones](#huawei-and-xiaomi-phones)
  - [Application force closed](#application-force-closed)
  - [Visibility](#visibility-of-notifications)
+ - [Ongoing Notifications](#ongoing-notifications)
  - [Badges](#badges)
  - [Support for Twilio Notify](#support-for-twilio-notify)
  - [Notification ID](#notification-id)
@@ -1390,6 +1391,49 @@ fcm.send(message, (err, response) => {
 });
 ```
 
+## Ongoing Notifications
+
+Set whether this is an "ongoing" notification. Ongoing notifications cannot be dismissed by the user, so your application or service must take care of canceling them. They are typically used to indicate a background task that the user is actively engaged with (e.g., playing music) or is pending in some way and therefore occupying the device (e.g., a file download, sync operation, active network connection).
+
+```javascript
+{
+ "registration_ids": ["my device id"],
+ "data": {
+ "title": "This is an ongoing Notification",
+ "message": "Some people also call me a sticky notification",
+ "ongoing": true
+ }
+}
+```
+
+Here is an example using fcm-node that sends the above JSON:
+
+```javascript
+var FCM = require('fcm-node');
+// Replace these with your own values.
+var apiKey = "replace with API key";
+var deviceID = "my device id";
+var fcm = new FCM(apiKey);
+
+var message = {
+ to: deviceID,
+ data: {
+ title: 'This is an ongoing Notification',
+ message: 'Some people also call me a sticky notification',
+ ongoing: true
+ }
+};
+
+fcm.send(message, function(err, response){
+ if (err) {
+ console.log(err);
+ console.log("Something has gone wrong!");
+ } else {
+ console.log("Successfully sent with response: ", response);
+ }
+});
+```
+
 ## Badges
 
 On Android not all launchers support badges. In order for us to set badges we use [ShortcutBadger](https://github.com/leolin310148/ShortcutBadger) in order to set the badge. Check out their website to see which launchers are supported.

src/android/com/adobe/phonegap/push/FCMService.java

@@ -485,6 +485,11 @@ public void createNotification(Context context, Bundle extras) {
  */
  setNotificationCount(context, extras, mBuilder);
 
+ /*
+ * Notification ongoing
+ */
+ setNotificationOngoing(extras, mBuilder);
+
  /*
  * Notification count
  */
@@ -633,6 +638,11 @@ private void setNotificationVibration(Bundle extras, Boolean vibrateOption, Noti
  }
  }
 
+ private void setNotificationOngoing(Bundle extras, NotificationCompat.Builder mBuilder) {
+ boolean ongoing = extras.optBoolean(ONGOING, false);
+ mBuilder.setOngoing(ongoing);
+ }
+
  private void setNotificationMessage(int notId, Bundle extras, NotificationCompat.Builder mBuilder) {
  String message = extras.getString(MESSAGE);
  String style = extras.getString(STYLE, STYLE_TEXT);

src/android/com/adobe/phonegap/push/PushConstants.java

@@ -100,4 +100,5 @@ public interface PushConstants {
  public static final String CREATE_CHANNEL = "create";
  public static final String DELETE_CHANNEL = "remove";
  public static final String UPDATE_CHANNEL = "update";
+ public static final String ONGOING = "ongoing";
 }