Merge branch 'master' of https://github.com/OneSignal/OneSignal-Android-SDK

Author: Alamgir Mand

.travis.yml

@@ -30,7 +30,7 @@ before_install:
 before_script:
     - chmod +x gradlew
 script:
-    - ./gradlew unittest:build
+    - ./gradlew unittest:testReleaseUnitTest
 after_failure:
     - cat build/reports/lint-results.xml
     - cat build/outputs/lint-results-debug.xml

OneSignalSDK/onesignal/src/main/java/com/onesignal/NotificationExtenderService.java

@@ -53,6 +53,19 @@
 </service>
 */
 
+/**
+ * OneSignal supports sending additional data along with a notification as key/value pairs.
+ * You can read this additional data when a notification is opened by adding a
+ * {@link com.onesignal.OneSignal.NotificationOpenedHandler} instead.
+ * <br/><br/>
+ * However, if you want to do one of the following, continue with the instructions
+ * <a href="https://documentation.onesignal.com/docs/android-native-sdk#section--notificationextenderservice-">here</a>:
+ * <br/><br/>
+ * - Receive data in the background with our without displaying a notification
+ * <br/>
+ * - Override specific notification settings depending on client-side app logic (e.g. custom accent color,
+ * vibration pattern, any other {@link NotificationCompat} options)
+ */
 public abstract class NotificationExtenderService extends IntentService {
 
    public static class OverrideSettings {

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSNotification.java

@@ -34,8 +34,28 @@
 import org.json.JSONException;
 import org.json.JSONObject;
 
+/**
+ * The notification the user received
+ * <br/><br/>
+ * {@link #isAppInFocus} - Was app in focus.
+ * <br/>
+ * {@link #shown} - Was notification shown to the user. Will be {@code false} for silent notifications.
+ * <br/>
+ * {@link #androidNotificationId} - Android Notification ID assigned to the notification. Can be used to cancel or replace the notification
+ * <br/>
+ * {@link #payload} - Payload received from OneSignal
+ * <br/>
+ * {@link #displayType} - How the notification was displayed ot the user. Can be set to {@link DisplayType#Notification Notification},
+ * {@link DisplayType#InAppAlert InAppAlert}, or {@link DisplayType#None None} if it was not displayed.
+ * <br/>
+ * {@link #groupedNotifications} - If the notification is a summary notification for a group, this will contain
+ * all notification payloads it was created from.
+ */
 public class OSNotification {
 
+   /**
+    * How the notification was displayed to the user. Part of {@link OSNotification}.
+    */
    public enum DisplayType {
       // Notification shown in the notification shade.
       Notification,

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSNotificationAction.java

@@ -27,6 +27,9 @@
 
 package com.onesignal;
 
+/**
+ * The action the user took on the notification.
+ */
 public class OSNotificationAction {
    public enum ActionType {
       // Notification was tapped on.

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSNotificationOpenResult.java

@@ -30,6 +30,13 @@
 import org.json.JSONException;
 import org.json.JSONObject;
 
+/**
+ * The information returned from a notification the user received.
+ * <br/><br/>
+ * {@link #notification} - Notification the user received
+ * <br/>
+ * {@link #action} - The action the user took on the notification
+ */
 public class OSNotificationOpenResult {
    public OSNotification notification;
    public OSNotificationAction action;

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSNotificationPayload.java

@@ -34,6 +34,13 @@
 import java.util.List;
 
 // Notification properties received from OneSignal.
+
+/**
+ * Contents and settings of the notification received. See
+ * <a href="https://documentation.onesignal.com/docs/android-native-sdk#section--osnotificationpayload-">
+ *     OSNotificationPayload | OneSignal Docs
+ * </a> for a list of explanations for each field.
+ */
 public class OSNotificationPayload {
    public String notificationID;
    public String title, body;
@@ -87,7 +94,10 @@ public OSNotificationPayload(JSONObject jsonObject) {
       priority = jsonObject.optInt("priority");
       rawPayload = jsonObject.optString("rawPayload");
    }
-   
+
+   /**
+    * List of action buttons on the notification. Part of {@link OSNotificationPayload}.
+    */
    public static class ActionButton {
       public String id;
       public String text;
@@ -116,6 +126,9 @@ public JSONObject toJSONObject() {
       }
    }
 
+   /**
+    * If a background image was set, this object will be available. Part of {@link OSNotificationPayload}.
+    */
    public static class BackgroundImageLayout {
       public String image;
       public String titleTextColor;