Add OS prefix to handlers

Author: Jeasmine

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

@@ -146,7 +146,7 @@ public void setFromBackgroundLogic(boolean fromBackgroundLogic) {
     * <br/><br/>
     * There is only one way to implement the {@link OneSignal.OSRemoteNotificationReceivedHandler}
     * <br/><br/>
-    * In the case of the {@link OneSignal.NotificationWillShowInForegroundHandler}
+    * In the case of the {@link OneSignal.OSNotificationWillShowInForegroundHandler}
     *  there are also setters for these handlers. So why create this new class and implement
     *  the same handlers, won't they just overwrite each other?
     * No, the idea here is to keep track of two separate handlers and keep them both

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

@@ -151,7 +151,7 @@ public interface OSRemoteNotificationReceivedHandler {
    }
 
    /**
-    * Meant to be implemented with {@link OneSignal#setNotificationWillShowInForegroundHandler(NotificationWillShowInForegroundHandler)}
+    * Meant to be implemented with {@link OneSignal#setNotificationWillShowInForegroundHandler(OSNotificationWillShowInForegroundHandler)}
     * <br/><br/>
     * Call {@link OSNotificationReceivedEvent#complete(OSNotification)} with null
     * for not displaying notification or {@link OSMutableNotification} to modify notification before displaying.
@@ -160,7 +160,7 @@ public interface OSRemoteNotificationReceivedHandler {
     * TODO: Update docs with new NotificationReceivedHandler
     * @see <a href="https://documentation.onesignal.com/docs/android-native-sdk#notificationreceivedhandler">NotificationReceivedHandler | OneSignal Docs</a>
     */
-   public interface NotificationWillShowInForegroundHandler {
+   public interface OSNotificationWillShowInForegroundHandler {
 
       void notificationWillShowInForeground(OSNotificationReceivedEvent notificationReceivedEvent);
    }
@@ -185,28 +185,28 @@ public interface OSNotificationOpenedHandler {
     * An interface used to process a OneSignal In-App Message the user just tapped on.
     * <br/>
     * Set this during OneSignal init in
-    * {@link OneSignal#setInAppMessageClickHandler(InAppMessageClickHandler)}
+    * {@link OneSignal#setInAppMessageClickHandler(OSInAppMessageClickHandler)}
     */
-   public interface InAppMessageClickHandler {
+   public interface OSInAppMessageClickHandler {
       /**
        * Fires when a user taps on a clickable element in the notification such as a button or image
        * @param result a {@link OSInAppMessageAction}
        **/
       void inAppMessageClicked(OSInAppMessageAction result);
    }
 
-   public interface IdsAvailableHandler {
+   public interface OSIdsAvailableHandler {
       void idsAvailable(String userId, String registrationId);
    }
 
    /**
-    * Interface which you can implement and pass to {@link OneSignal#getTags(GetTagsHandler)} to
+    * Interface which you can implement and pass to {@link OneSignal#getTags(OSGetTagsHandler)} to
     * get all the tags set on a user
     * <br/><br/>
     * <b>Note:</b> the {@link #tagsAvailable(JSONObject)} callback does not run on the Main(UI)
     * Thread, so be aware when modifying UI in this method.
     */
-   public interface GetTagsHandler {
+   public interface OSGetTagsHandler {
       /**
        * <b>Note:</b> this callback does not run on the Main(UI)
        * Thread, so be aware when modifying UI in this method.
@@ -297,13 +297,13 @@ static Activity getCurrentActivity() {
    private static int subscribableStatus = Integer.MAX_VALUE;
 
    static OSRemoteNotificationReceivedHandler remoteNotificationReceivedHandler;
-   static NotificationWillShowInForegroundHandler notificationWillShowInForegroundHandler;
+   static OSNotificationWillShowInForegroundHandler notificationWillShowInForegroundHandler;
 
    // TODO: Start of old mInitBuilder params
    //    These should be cleaned up and managed else where maybe?
    //    These have been ripped out of mInitBuilder since it was deleted and placed here for now
    static OSNotificationOpenedHandler notificationOpenedHandler;
-   static InAppMessageClickHandler inAppMessageClickHandler;
+   static OSInAppMessageClickHandler inAppMessageClickHandler;
 
    static boolean mAutoPromptLocation;
    // TODO: End of old mInitBuilder params
@@ -326,7 +326,7 @@ static boolean isInForeground() {
       return appEntryState;
    }
 
-   private static IdsAvailableHandler idsAvailableHandler;
+   private static OSIdsAvailableHandler idsAvailableHandler;
 
    private static TrackGooglePurchase trackGooglePurchase;
    private static TrackAmazonPurchase trackAmazonPurchase;
@@ -378,7 +378,7 @@ public void onSessionEnding(@NonNull List<OSInfluence> lastInfluences) {
 
    private static Collection<JSONArray> unprocessedOpenedNotifs = new ArrayList<>();
    private static HashSet<String> postedOpenedNotifIds = new HashSet<>();
-   private static final ArrayList<GetTagsHandler> pendingGetTagsHandlers = new ArrayList<>();
+   private static final ArrayList<OSGetTagsHandler> pendingGetTagsHandlers = new ArrayList<>();
 
    static DelayedConsentInitializationParameters delayedInitParams;
 
@@ -621,7 +621,7 @@ static void setRemoteNotificationReceivedHandler(OSRemoteNotificationReceivedHan
          remoteNotificationReceivedHandler = callback;
    }
 
-   public static void setNotificationWillShowInForegroundHandler(@Nullable NotificationWillShowInForegroundHandler callback) {
+   public static void setNotificationWillShowInForegroundHandler(@Nullable OSNotificationWillShowInForegroundHandler callback) {
       notificationWillShowInForegroundHandler = callback;
    }
 
@@ -632,7 +632,7 @@ public static void setNotificationOpenedHandler(@Nullable OSNotificationOpenedHa
          fireCallbackForOpenedNotifications();
    }
 
-   public static void setInAppMessageClickHandler(@Nullable InAppMessageClickHandler callback) {
+   public static void setInAppMessageClickHandler(@Nullable OSInAppMessageClickHandler callback) {
       inAppMessageClickHandler = callback;
    }
 
@@ -1697,11 +1697,11 @@ void onFailure(int statusCode, String response, Throwable throwable) {
 
    /**
     * Retrieve a list of tags that have been set on the user frm the OneSignal server.
-    * @param getTagsHandler an instance of {@link GetTagsHandler}.
+    * @param getTagsHandler an instance of {@link OSGetTagsHandler}.
     *                       <br/>
-    *                       Calls {@link GetTagsHandler#tagsAvailable(JSONObject) tagsAvailable} once the tags are available
+    *                       Calls {@link OSGetTagsHandler#tagsAvailable(JSONObject) tagsAvailable} once the tags are available
     */
-   public static void getTags(final GetTagsHandler getTagsHandler) {
+   public static void getTags(final OSGetTagsHandler getTagsHandler) {
       if (taskController.shouldQueueTaskForInit(OSTaskController.GET_TAGS)) {
          logger.error("Waiting for remote params. " +
                  "Moving " + OSTaskController.GET_TAGS + " operation to a pending queue.");
@@ -1760,7 +1760,7 @@ public void run() {
             if (tags.serverSuccess) getTagsCall = true;
 
             synchronized (pendingGetTagsHandlers) {
-               for (GetTagsHandler handler : pendingGetTagsHandlers) {
+               for (OSGetTagsHandler handler : pendingGetTagsHandlers) {
                   handler.tagsAvailable(tags.result == null || tags.toString().equals("{}") ? null : tags.result);
                }
 
@@ -1845,7 +1845,7 @@ public static void deleteTags(JSONArray jsonArray, ChangeTagsUpdateHandler handl
       }
    }
 
-   public static void idsAvailable(final IdsAvailableHandler inIdsAvailableHandler) {
+   public static void idsAvailable(final OSIdsAvailableHandler inIdsAvailableHandler) {
       if (taskController.shouldQueueTaskForInit(OSTaskController.IDS_AVAILABLE)) {
          logger.error("Waiting for remote params. " +
                  "Moving " + OSTaskController.IDS_AVAILABLE + " operation to a pending queue.");
@@ -2047,7 +2047,7 @@ static void handleNotificationReceived(OSNotificationGenerationJob notificationJ
     * Checks if the app is in the background
     * Checks if notificationWillShowInForegroundHandler is setup
     * <br/><br/>
-    * @see NotificationWillShowInForegroundHandler
+    * @see OSNotificationWillShowInForegroundHandler
     */
    static boolean shouldFireForegroundHandlers() {
       if (!isInForeground()) {
@@ -2066,7 +2066,7 @@ static boolean shouldFireForegroundHandlers() {
    /**
     * Responsible for firing the notificationWillShowInForegroundHandler
     * <br/><br/>
-    * @see NotificationWillShowInForegroundHandler
+    * @see OSNotificationWillShowInForegroundHandler
     */
    static void fireForegroundHandlers(OSNotificationController notificationController) {
       OneSignal.onesignalLog(OneSignal.LOG_LEVEL.INFO, "Fire notificationWillShowInForegroundHandler");

OneSignalSDK/unittest/src/test/java/com/test/onesignal/GenerateNotificationRunner.java

@@ -1926,7 +1926,7 @@ public void testNotificationWillShowInForegroundHandler_doesNotFireWhenAppBackgr
       // 1. Init OneSignal
       OneSignal.setAppId("b2f7f966-d8cc-11e4-bed1-df8f05be55ba");
       OneSignal.initWithContext(blankActivity);
-      OneSignal.setNotificationWillShowInForegroundHandler(new OneSignal.NotificationWillShowInForegroundHandler() {
+      OneSignal.setNotificationWillShowInForegroundHandler(new OneSignal.OSNotificationWillShowInForegroundHandler() {
          @Override
          public void notificationWillShowInForeground(OSNotificationReceivedEvent notificationReceivedEvent) {
             lastForegroundNotificationReceivedEvent = notificationReceivedEvent;
@@ -1958,7 +1958,7 @@ public void testNotificationWillShowInForegroundHandler_notCallCompleteShowsNoti
       // 1. Init OneSignal
       OneSignal.setAppId("b2f7f966-d8cc-11e4-bed1-df8f05be55ba");
       OneSignal.initWithContext(blankActivity);
-      OneSignal.setNotificationWillShowInForegroundHandler(new OneSignal.NotificationWillShowInForegroundHandler() {
+      OneSignal.setNotificationWillShowInForegroundHandler(new OneSignal.OSNotificationWillShowInForegroundHandler() {
          @Override
          public void notificationWillShowInForeground(OSNotificationReceivedEvent notificationReceivedEvent) {
             callbackCounter++;
@@ -2072,7 +2072,7 @@ public void testNotificationWillShowInForegroundHandler_notificationJobPayload()
       // 1. Init OneSignal
       OneSignal.setAppId("b2f7f966-d8cc-11e4-bed1-df8f05be55ba");
       OneSignal.initWithContext(blankActivity);
-      OneSignal.setNotificationWillShowInForegroundHandler(new OneSignal.NotificationWillShowInForegroundHandler() {
+      OneSignal.setNotificationWillShowInForegroundHandler(new OneSignal.OSNotificationWillShowInForegroundHandler() {
          @Override
          public void notificationWillShowInForeground(OSNotificationReceivedEvent notificationReceivedEvent) {
             lastForegroundNotificationReceivedEvent = notificationReceivedEvent;

OneSignalSDK/unittest/src/test/java/com/test/onesignal/InAppMessageIntegrationTests.java

@@ -708,7 +708,7 @@ public void testOnIAMActionSendsOutcome_usingOutcomesV2() throws Exception {
         trackerFactory.saveInfluenceParams(new OneSignalPackagePrivateHelper.RemoteOutcomeParams());
 
         final OSInAppMessageAction[] lastAction = new OSInAppMessageAction[1];
-        OneSignal.setInAppMessageClickHandler(new OneSignal.InAppMessageClickHandler() {
+        OneSignal.setInAppMessageClickHandler(new OneSignal.OSInAppMessageClickHandler() {
             @Override
             public void inAppMessageClicked(OSInAppMessageAction result) {
                 lastAction[0] = result;
@@ -769,7 +769,7 @@ public void testOnIAMActionSendsOutcome_afterDismiss_usingOutcomesV2() throws Ex
         trackerFactory.saveInfluenceParams(new OneSignalPackagePrivateHelper.RemoteOutcomeParams());
 
         final OSInAppMessageAction[] lastAction = new OSInAppMessageAction[1];
-        OneSignal.setInAppMessageClickHandler(new OneSignal.InAppMessageClickHandler() {
+        OneSignal.setInAppMessageClickHandler(new OneSignal.OSInAppMessageClickHandler() {
             @Override
             public void inAppMessageClicked(OSInAppMessageAction result) {
                 lastAction[0] = result;
@@ -1054,7 +1054,7 @@ public void testInAppMessageClickActionSendAndRemoveTag() throws Exception {
 
         OneSignalPackagePrivateHelper.onMessageActionOccurredOnMessage(message, actionRemove);
         threadAndTaskWait();
-        OneSignal.getTags(new OneSignal.GetTagsHandler() {
+        OneSignal.getTags(new OneSignal.OSGetTagsHandler() {
             @Override
             public void tagsAvailable(JSONObject tags) {
                 lastGetTags[0] = tags;

OneSignalSDK/unittest/src/test/java/com/test/onesignal/InAppMessagingUnitTests.java

@@ -554,7 +554,7 @@ private void OneSignalInit() {
     private static @Nullable OSInAppMessageAction lastAction;
     @Test
     public void testOnMessageActionOccurredOnMessage() throws Exception {
-        OneSignal.setInAppMessageClickHandler(new OneSignal.InAppMessageClickHandler() {
+        OneSignal.setInAppMessageClickHandler(new OneSignal.OSInAppMessageClickHandler() {
             @Override
             public void inAppMessageClicked(OSInAppMessageAction result) {
                 lastAction = result;

OneSignalSDK/unittest/src/test/java/com/test/onesignal/MainOneSignalClassRunner.java

@@ -56,7 +56,6 @@
 import com.onesignal.OSNotification;
 import com.onesignal.OSNotificationAction;
 import com.onesignal.OSNotificationOpenedResult;
-import com.onesignal.OSNotificationReceivedEvent;
 import com.onesignal.OSPermissionObserver;
 import com.onesignal.OSPermissionStateChanges;
 import com.onesignal.OSPermissionSubscriptionState;
@@ -1421,7 +1420,7 @@ public void shouldNotFireIdsAvailableWithoutUserId() throws Exception {
       ShadowOneSignalRestClient.failNext = true;
       ShadowPushRegistratorFCM.fail = true;
 
-      OneSignal.idsAvailable(new OneSignal.IdsAvailableHandler() {
+      OneSignal.idsAvailable(new OneSignal.OSIdsAvailableHandler() {
          @Override
          public void idsAvailable(String userId, String registrationId) {
             if (userId == null)
@@ -2209,7 +2208,7 @@ public void testOneSignalMethodsBeforeInit() throws Exception {
          OneSignal.sendTag("a" + a, String.valueOf(a));
       }
 
-      OneSignal.getTags(new OneSignal.GetTagsHandler() {
+      OneSignal.getTags(new OneSignal.OSGetTagsHandler() {
          @Override
          public void tagsAvailable(JSONObject tags) {
             //assert that the first 10 tags sent were available
@@ -2226,7 +2225,7 @@ public void tagsAvailable(JSONObject tags) {
       threadAndTaskWait();
 
       final AtomicBoolean callbackFired = new AtomicBoolean(false);
-      OneSignal.IdsAvailableHandler idsAvailableHandler = new OneSignal.IdsAvailableHandler() {
+      OneSignal.OSIdsAvailableHandler idsAvailableHandler = new OneSignal.OSIdsAvailableHandler() {
          @Override
          public void idsAvailable(String userId, String registrationId) {
             //Assert the userId being returned
@@ -2255,7 +2254,7 @@ public void idsAvailable(String userId, String registrationId) {
       OneSignal.sendTag("a495","1");
       OneSignal.syncHashedEmail("test1@test.com");
 
-      OneSignal.getTags(new OneSignal.GetTagsHandler() {
+      OneSignal.getTags(new OneSignal.OSGetTagsHandler() {
          @Override
          public void tagsAvailable(JSONObject tags) {
             try {
@@ -4731,7 +4730,7 @@ public void testGetTagsQueuesCallbacks() throws Exception {
       final BlockingQueue<Boolean> queue = new ArrayBlockingQueue<>(2);
 
       // Allows us to validate that both handlers get executed independently
-      class DebugGetTagsHandler implements OneSignal.GetTagsHandler {
+      class DebugGetTagsHandler implements OneSignal.OSGetTagsHandler {
          @Override
          public void tagsAvailable(JSONObject tags) {
             queue.offer(true);
@@ -4760,10 +4759,10 @@ public void testNestedGetTags() throws Exception {
       final BlockingQueue<Boolean> queue = new ArrayBlockingQueue<>(2);
 
       // Validates that nested getTags calls won't throw a ConcurrentModificationException
-      class DebugGetTagsHandler implements OneSignal.GetTagsHandler {
+      class DebugGetTagsHandler implements OneSignal.OSGetTagsHandler {
          @Override
          public void tagsAvailable(JSONObject tags) {
-            OneSignal.getTags(new OneSignal.GetTagsHandler() {
+            OneSignal.getTags(new OneSignal.OSGetTagsHandler() {
                @Override
                public void tagsAvailable(JSONObject tags) {
                   queue.offer(true);