[User Model] Rename notification event listeners

* Make all notification listeners 0:* (some were 0:1)
* Renamed all "handlers" to be either a "listener" or an "observer" depending on their purpose.  All callbacks now have pattern "onXXXXXX" for each callback.
* Use the terminology "click" instead of "open".
* Add IEventNotifier.hasSubscribers to determine if there are subscribers. A few implementing classes had to add this.
* Replaced `complete()` pattern with `preventDefault()` pattern in NSE notification received callback and foreground onWillDisplay callback.
* Add IDisplayableNotification and IDisplayableMutableNotification which adds a `display()` function to an INotification. This allows the manual display of a notification, when `event.preventDefault()` is called.
* Internally, rework NotificationGenerationProcessor to accommodate `preventDefault` pattern. The notification is now constructed when the notification job is constructed and is never copied/altered until the end of its lifecycle.
* Update example application for new naming conventions and patterns.
* Update for new naming conventions and patterns

Author: brismithers

Examples/OneSignalDemo/app/src/main/java/com/onesignal/sdktest/activity/MainActivity.java

@@ -21,7 +21,7 @@ protected void onCreate(Bundle savedInstanceState) {
         setContentView(R.layout.main_activity_layout);
 
         viewModel = new MainActivityViewModel();
-        OneSignal.getNotifications().addPermissionChangedHandler(viewModel);
+        OneSignal.getNotifications().addPermissionObserver(viewModel);
 // TODO("STILL SUPPORT?")
 //        OneSignal.addSubscriptionObserver(viewModel);
 //        OneSignal.addEmailSubscriptionObserver(viewModel);

Examples/OneSignalDemo/app/src/main/java/com/onesignal/sdktest/application/MainApplication.java

@@ -13,7 +13,9 @@
 import com.onesignal.inAppMessages.IInAppMessageClickResult;
 import com.onesignal.inAppMessages.IInAppMessageLifecycleHandler;
 import com.onesignal.debug.LogLevel;
-import com.onesignal.notifications.INotification;
+import com.onesignal.notifications.IDisplayableNotification;
+import com.onesignal.notifications.INotificationLifecycleListener;
+import com.onesignal.notifications.INotificationWillDisplayEvent;
 import com.onesignal.sdktest.BuildConfig;
 import com.onesignal.sdktest.R;
 import com.onesignal.sdktest.constant.Tag;
@@ -76,23 +78,40 @@ public void inAppMessageClicked(@Nullable IInAppMessageClickResult result) {
             }
         });
 
-        OneSignal.getNotifications().setNotificationClickHandler(result ->
-                {
-                    Log.v("MainApplication", "INotificationOpenedResult: " + result);
-                });
-
-        OneSignal.getNotifications().setNotificationWillShowInForegroundHandler(notificationReceivedEvent ->
-                {
-                    Log.v("MainApplication", "NotificationWillShowInForegroundHandler fired!" +
-                    " with notification event: " + notificationReceivedEvent.toString());
-
-                    INotification notification = notificationReceivedEvent.getNotification();
-                    JSONObject data = notification.getAdditionalData();
+        OneSignal.getNotifications().addClickListener(event ->
+        {
+            Log.v("MainApplication", "INotificationClickListener.onClick fired!" +
+                    " with event: " + event);
+        });
 
-                    notificationReceivedEvent.complete(notification);
-                });
+        OneSignal.getNotifications().addForegroundLifecycleListener(new INotificationLifecycleListener() {
+            @Override
+            public void onWillDisplay(@NonNull INotificationWillDisplayEvent event) {
+                Log.v("MainApplication", "INotificationLifecycleListener.onWillDisplay fired!" +
+                        " with event: " + event);
+
+                IDisplayableNotification notification = event.getNotification();
+                JSONObject data = notification.getAdditionalData();
+
+                //Prevent OneSignal from displaying the notification immediately on return. Spin
+                //up a new thread to mimic some asynchronous behavior, when the async behavior (which
+                //takes 2 seconds) completes, then the notification can be displayed.
+                event.preventDefault();
+                Runnable r = () -> {
+                    try {
+                        Thread.sleep(2000);
+                    } catch (InterruptedException e) {
+                        e.printStackTrace();
+                    }
+
+                    notification.display();
+                };
+
+                Thread t = new Thread(r);
+                t.start();
+            }
+        });
 
-//        OneSignal.getNotifications().setUnsubscribeWhenNotificationsAreDisabled(true);
         OneSignal.getInAppMessages().setPaused(true);
         OneSignal.getLocation().setShared(false);
 

Examples/OneSignalDemo/app/src/main/java/com/onesignal/sdktest/model/ActivityViewModel.java

@@ -4,13 +4,13 @@
 import android.content.Context;
 import androidx.appcompat.app.AppCompatActivity;
 
-import com.onesignal.notifications.IPermissionChangedHandler;
+import com.onesignal.notifications.IPermissionObserver;
 
 /**
  * This is the interface created with a few generic methods for setting a ViewModel
  * as the responsible guardian of an Activity
  */
-public interface ActivityViewModel extends IPermissionChangedHandler { // TODO() extends OSPermissionObserver, OSSubscriptionObserver, OSEmailSubscriptionObserver  {
+public interface ActivityViewModel extends IPermissionObserver {
 
     /**
      * Casts Context of the given Activity to an Activity object

Examples/OneSignalDemo/app/src/main/java/com/onesignal/sdktest/model/MainActivityViewModel.java

@@ -359,7 +359,7 @@ public void networkDisconnected() {
     }
 
     @Override
-    public void onPermissionChanged(@Nullable boolean permission) {
+    public void onNotificationPermissionChange(@Nullable boolean permission) {
         refreshSubscriptionState();
     }
 

Examples/OneSignalDemo/app/src/main/java/com/onesignal/sdktest/model/SplashActivityViewModel.java

@@ -141,7 +141,7 @@ private void attemptEnterApplication() {
     }
 
     @Override
-    public void onPermissionChanged(@Nullable boolean permission) {
+    public void onNotificationPermissionChange(@Nullable boolean permission) {
 
     }
 }

Examples/OneSignalDemo/app/src/main/java/com/onesignal/sdktest/notification/NotificationServiceExtension.java

@@ -1,33 +1,27 @@
 package com.onesignal.sdktest.notification;
 
-import android.content.Context;
 import android.util.Log;
 
 import com.onesignal.notifications.IActionButton;
-import com.onesignal.notifications.IMutableNotification;
-import com.onesignal.notifications.INotification;
+import com.onesignal.notifications.IDisplayableMutableNotification;
 import com.onesignal.notifications.INotificationReceivedEvent;
-import com.onesignal.notifications.IRemoteNotificationReceivedHandler;
+import com.onesignal.notifications.INotificationServiceExtension;
 import com.onesignal.sdktest.R;
 
-public class NotificationServiceExtension implements IRemoteNotificationReceivedHandler {
+public class NotificationServiceExtension implements INotificationServiceExtension {
 
    @Override
-   public void remoteNotificationReceived(Context context, INotificationReceivedEvent notificationReceivedEvent) {
-      Log.v("MainApplication", "IRemoteNotificationReceivedHandler fired!" + " with INotificationReceivedEvent: " + notificationReceivedEvent.toString());
+   public void onNotificationReceived(INotificationReceivedEvent event) {
+      Log.v("MainApplication", "IRemoteNotificationReceivedHandler fired!" + " with INotificationReceivedEvent: " + event.toString());
 
-      INotification notification = notificationReceivedEvent.getNotification();
+      IDisplayableMutableNotification notification = event.getNotification();
 
       if (notification.getActionButtons() != null) {
          for (IActionButton button : notification.getActionButtons()) {
             Log.v("MainApplication", "ActionButton: " + button.toString());
          }
       }
 
-      IMutableNotification mutableNotification = notification.mutableCopy();
-      mutableNotification.setExtender(builder -> builder.setColor(context.getResources().getColor(R.color.colorPrimary)));
-
-      // If complete isn't call within a time period of 25 seconds, OneSignal internal logic will show the original notification
-      notificationReceivedEvent.complete(mutableNotification);
+      notification.setExtender(builder -> builder.setColor(event.getContext().getResources().getColor(R.color.colorPrimary)));
    }
 }

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/common/events/EventProducer.kt

@@ -10,6 +10,9 @@ import kotlinx.coroutines.withContext
  */
 open class EventProducer<THandler> : IEventNotifier<THandler> {
 
+    override val hasSubscribers: Boolean
+        get() = _subscribers.any()
+
     private val _subscribers: MutableList<THandler> = mutableListOf()
 
     override fun subscribe(handler: THandler) {

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/common/events/IEventNotifier.kt

@@ -12,6 +12,10 @@ package com.onesignal.common.events
  * @param THandler The type that the implementor is expecting to raise events to.
  */
 interface IEventNotifier<THandler> {
+    /**
+     * Whether there are currently any subscribers.
+     */
+    val hasSubscribers: Boolean
 
     /**
      * Subscribe to listen for events.

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/common/modeling/Model.kt

@@ -334,4 +334,6 @@ open class Model(
 
     override fun subscribe(handler: IModelChangedHandler) = _changeNotifier.subscribe(handler)
     override fun unsubscribe(handler: IModelChangedHandler) = _changeNotifier.unsubscribe(handler)
+    override val hasSubscribers: Boolean
+        get() = _changeNotifier.hasSubscribers
 }

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/common/modeling/ModelStore.kt

@@ -147,4 +147,6 @@ abstract class ModelStore<TModel>(
 
     override fun subscribe(handler: IModelStoreChangeHandler<TModel>) = _changeSubscription.subscribe(handler)
     override fun unsubscribe(handler: IModelStoreChangeHandler<TModel>) = _changeSubscription.unsubscribe(handler)
+    override val hasSubscribers: Boolean
+        get() = _changeSubscription.hasSubscribers
 }