Remove public getPermissionSubscriptionState

* Replace getPermissionSubscriptionState with getDeviceState
* Add isEmaiSubscribed method to OSDeviceState
* Delete OSPermissionSubscriptionState class

Author: Jeasmine

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

@@ -19,6 +19,7 @@
 import android.widget.Switch;
 import android.widget.TextView;
 
+import com.onesignal.OSDeviceState;
 import com.onesignal.OSEmailSubscriptionStateChanges;
 import com.onesignal.OSPermissionStateChanges;
 import com.onesignal.OSSubscriptionStateChanges;
@@ -299,11 +300,8 @@ public void onOSEmailSubscriptionChanged(OSEmailSubscriptionStateChanges stateCh
 
     @Override
     public void onOSPermissionChanged(OSPermissionStateChanges stateChanges) {
-        final boolean isSubscribed = OneSignal.getPermissionSubscriptionState() != null &&
-                OneSignal
-                        .getPermissionSubscriptionState()
-                        .getSubscriptionStatus()
-                        .isSubscribed();
+        OSDeviceState deviceState = OneSignal.getDeviceState();
+        final boolean isSubscribed = deviceState != null && deviceState.isSubscribed();
 
         boolean isPermissionEnabled = stateChanges.getTo().areNotificationsEnabled();
         subscriptionSwitch.setEnabled(isPermissionEnabled);
@@ -459,19 +457,9 @@ public void setupSettingsLayout() {
     }
 
     private void setupSubscriptionSwitch() {
-        boolean isPermissionEnabled = OneSignal
-                .getPermissionSubscriptionState() != null &&
-                OneSignal
-                        .getPermissionSubscriptionState()
-                        .getPermissionStatus()
-                        .areNotificationsEnabled();
-
-        final boolean isSubscribed = OneSignal
-                .getPermissionSubscriptionState() != null &&
-                OneSignal
-                        .getPermissionSubscriptionState()
-                        .getSubscriptionStatus()
-                        .isSubscribed();
+        OSDeviceState deviceState = OneSignal.getDeviceState();
+        boolean isPermissionEnabled = deviceState != null && deviceState.areNotificationsEnabled();
+        final boolean isSubscribed = deviceState != null && deviceState.isSubscribed();
 
         subscriptionSwitch.setEnabled(isPermissionEnabled);
         subscriptionSwitch.setChecked(isSubscribed);

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

@@ -2,7 +2,7 @@
 
 import android.util.Log;
 
-import com.onesignal.OSPermissionSubscriptionState;
+import com.onesignal.OSDeviceState;
 import com.onesignal.OneSignal;
 import com.onesignal.sdktest.constant.Tag;
 import com.onesignal.sdktest.type.Notification;
@@ -14,9 +14,9 @@ public class OneSignalNotificationSender {
 
     public static void sendDeviceNotification(final Notification notification) {
         new Thread(() -> {
-            OSPermissionSubscriptionState status = OneSignal.getPermissionSubscriptionState();
-            String userId = status.getSubscriptionStatus().getUserId();
-            boolean isSubscribed = status.getSubscriptionStatus().isSubscribed();
+            OSDeviceState deviceState = OneSignal.getDeviceState();
+            String userId = deviceState != null ? deviceState.getUserId() : null;
+            boolean isSubscribed = deviceState != null && deviceState.isSubscribed();
 
             if (!isSubscribed)
                 return;

Examples/OneSignalDemo/app/src/main/java/com/onesignal/sdktest/user/CurrentUser.java

@@ -3,6 +3,7 @@
 import android.content.Context;
 import android.util.Log;
 
+import com.onesignal.OSDeviceState;
 import com.onesignal.OneSignal;
 import com.onesignal.sdktest.callback.EmailUpdateCallback;
 import com.onesignal.sdktest.constant.Tag;
@@ -13,11 +14,9 @@ public class CurrentUser {
     private static CurrentUser currentUser;
 
     public String getEmail() {
-        if (OneSignal.getPermissionSubscriptionState() != null)
-            return OneSignal
-                .getPermissionSubscriptionState()
-                .getEmailSubscriptionStatus()
-                .getEmailAddress();
+        OSDeviceState deviceState = OneSignal.getDeviceState();
+        if (deviceState != null)
+            return deviceState.getEmailAddress();
         return null;
     }
 
@@ -53,10 +52,8 @@ public void removeEmail(final EmailUpdateCallback callback) {
     }
 
     public boolean isEmailSet() {
-        return OneSignal
-                .getPermissionSubscriptionState() != null && OneSignal
-                .getPermissionSubscriptionState().getEmailSubscriptionStatus()
-                .getEmailAddress() != null;
+        OSDeviceState deviceState = OneSignal.getDeviceState();
+        return deviceState != null && deviceState.getEmailAddress() != null;
     }
 
     public boolean isExternalUserIdSet(Context context) {

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

@@ -34,23 +34,21 @@ public class OSDeviceState {
     private final boolean areNotificationsEnabled;
     private final boolean pushDisabled;
     private final boolean subscribed;
+    private final boolean emailSubscribed;
     private final String userId;
     private final String pushToken;
     private final String emailUserId;
     private final String emailAddress;
 
-    public OSDeviceState(OSPermissionSubscriptionState permissionSubscriptionState) {
-        OSSubscriptionState subscriptionStatus = permissionSubscriptionState.subscriptionStatus;
-        OSPermissionState permissionStatus = permissionSubscriptionState.permissionStatus;
-        OSEmailSubscriptionState emailSubscriptionStatus = permissionSubscriptionState.emailSubscriptionStatus;
-
+    public OSDeviceState(OSSubscriptionState subscriptionStatus, OSPermissionState permissionStatus, OSEmailSubscriptionState emailSubscriptionStatus) {
         areNotificationsEnabled = permissionStatus.areNotificationsEnabled();
         pushDisabled = subscriptionStatus.isPushDisabled();
         subscribed = subscriptionStatus.isSubscribed();
         userId = subscriptionStatus.getUserId();
         pushToken = subscriptionStatus.getPushToken();
         emailUserId = emailSubscriptionStatus.getEmailUserId();
         emailAddress = emailSubscriptionStatus.getEmailAddress();
+        emailSubscribed = emailSubscriptionStatus.getSubscribed();
     }
 
     /**
@@ -98,6 +96,15 @@ public String getPushToken() {
         return pushToken;
     }
 
+    /**
+     * Get whether the user email is subscribed
+     *
+     * @return true if {@link #getEmailUserId} and {@link #getEmailAddress} are not null, otherwise false
+     */
+    public boolean isEmailSubscribed() {
+        return emailSubscribed;
+    }
+
     /**
      * Get the user email id
      *
@@ -125,6 +132,7 @@ public JSONObject toJSONObject() {
             mainObj.put("isSubscribed", subscribed);
             mainObj.put("userId", userId);
             mainObj.put("pushToken", pushToken);
+            mainObj.put("isEmailSubscribed", emailSubscribed);
             mainObj.put("emailUserId", emailUserId);
             mainObj.put("emailAddress", emailAddress);
         } catch (Throwable t) {

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

@@ -462,6 +462,9 @@ private static OSEmailSubscriptionState getCurrentEmailSubscriptionState(Context
 
       return currentEmailSubscriptionState;
    }
+   static OSEmailSubscriptionState getEmailSubscriptionState() {
+      return getCurrentEmailSubscriptionState(appContext);
+   }
 
    static OSEmailSubscriptionState lastEmailSubscriptionState;
    private static OSEmailSubscriptionState getLastEmailSubscriptionState(Context context) {
@@ -482,11 +485,20 @@ static OSObservable<OSEmailSubscriptionObserver, OSEmailSubscriptionStateChanges
    }
    // End EmailSubscriptionState
 
+   /**
+    * Get the current user data, notification and permissions state.
+    */
    @Nullable
    public static OSDeviceState getDeviceState() {
-      if (getPermissionSubscriptionState() == null)
+      if (appContext == null) {
+         logger.error("OneSignal.initWithContext has not been called. Could not get OSDeviceState");
          return null;
-      return new OSDeviceState(getPermissionSubscriptionState());
+      }
+
+      OSSubscriptionState subscriptionStatus = getCurrentSubscriptionState(appContext);
+      OSPermissionState permissionStatus = getCurrentPermissionState(appContext);
+      OSEmailSubscriptionState emailSubscriptionStatus = getCurrentEmailSubscriptionState(appContext);
+      return new OSDeviceState(subscriptionStatus, permissionStatus, emailSubscriptionStatus);
    }
 
    private static class IAPUpdateJob {
@@ -2685,35 +2697,6 @@ public static void removeEmailSubscriptionObserver(@NonNull OSEmailSubscriptionO
       getEmailSubscriptionStateChangesObserver().removeObserver(observer);
    }
 
-   /**
-    * Get the current notification and permission state.
-    *<br/><br/>
-    * {@code permissionStatus} - {@link OSPermissionState} - Android Notification Permissions State
-    * <br/>
-    * {@code subscriptionStatus} - {@link OSSubscriptionState} - Google and OneSignal subscription state
-    * <br/>
-    * {@code emailSubscriptionStatus} - {@link OSEmailSubscriptionState} - Email subscription state
-    * @return a {@link OSPermissionSubscriptionState} as described above
-    */
-   public static OSPermissionSubscriptionState getPermissionSubscriptionState() {
-
-      // If applicable, check if the user provided privacy consent
-      if (shouldLogUserPrivacyConsentErrorMessageForMethodName("getPermissionSubscriptionState()"))
-         return null;
-
-      if (appContext == null) {
-         logger.error("OneSignal.initWithContext has not been called. Could not get OSPermissionSubscriptionState");
-         return null;
-      }
-
-      OSPermissionSubscriptionState status = new OSPermissionSubscriptionState();
-      status.subscriptionStatus = getCurrentSubscriptionState(appContext);
-      status.permissionStatus = getCurrentPermissionState(appContext);
-      status.emailSubscriptionStatus = getCurrentEmailSubscriptionState(appContext);
-
-      return status;
-   }
-
    /** In-App Message Triggers */
 
    /**

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

@@ -142,7 +142,7 @@ void logoutEmail() {
         toSyncUserState.syncValues.remove("external_user_id");
         toSyncUserState.persistState();
 
-        OneSignal.getPermissionSubscriptionState().emailSubscriptionStatus.clearEmailAndId();
+        OneSignal.getEmailSubscriptionState().clearEmailAndId();
     }
 
     @Override