Move UserState and related classes into the user directory

Author: jinliu9508

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/IUserManager.kt

@@ -138,4 +138,15 @@ interface IUserManager {
      * Return a copy of all local tags from the current user.
      */
     fun getTags() : Map<String, String>
+
+    /**
+    * Add an observer to the user state, allowing the provider to be
+    * notified whenever the user state has changed.
+    */
+    fun addObserver(observer: IUserStateObserver)
+
+    /**
+     * Remove an observer from the user state.
+     */
+    fun removeObserver(observer: IUserStateObserver)
 }

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/IUserStateObserver.kt

@@ -0,0 +1,15 @@
+package com.onesignal.user
+
+/**
+ * A user state changed handler. Implement this interface and provide the implementation
+ * to be notified when the user has changed.
+ */
+interface IUserStateObserver {
+    /**
+     * Called when the user state this change handler was added to, has changed. A
+     * user state can change when user has logged in or out
+     *
+     * @param state The user changed state.
+     */
+    fun onUserStateChange(state: UserChangedState)
+}

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/UserChangedState.kt

@@ -0,0 +1,16 @@
+package com.onesignal.user
+
+import org.json.JSONObject
+
+class UserChangedState(
+        val previous: UserState,
+        val current: UserState,
+        val switchedUsers: Boolean,
+) {
+    fun toJSONObject(): JSONObject {
+        return JSONObject()
+                .put("previous", previous.toJSONObject())
+                .put("current", current.toJSONObject())
+                .put("switchedUsers", switchedUsers)
+    }
+}

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/UserState.kt

@@ -0,0 +1,30 @@
+package com.onesignal.user
+
+import org.json.JSONObject
+
+/**
+ * A user state.
+ */
+class UserState (
+        /**
+         * The unique identifier for OneSignal account. This will be a null string until
+         * the user has been successfully logged in on the backend and assigned an ID.
+         * Use [addObserver] to be notified when the [onesignalId] has been successfully
+         * assigned.
+         */
+        val onesignalId: String?,
+
+        /**
+         * The unique external identifier. This will be a null string until the id has
+         * been successfully assigned and retrieved from the server.
+         * Use [addObserver] to be notified when the [externalId] has been successfully
+         * assigned.
+         */
+        val externalId: String?,
+) {
+    fun toJSONObject(): JSONObject {
+        return JSONObject()
+                .put("onesignalId", onesignalId)
+                .put("externalId", externalId)
+    }
+}

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/UserManager.kt

@@ -1,10 +1,12 @@
 package com.onesignal.user.internal
 
 import com.onesignal.common.OneSignalUtils
+import com.onesignal.common.events.EventProducer
 import com.onesignal.core.internal.language.ILanguageContext
 import com.onesignal.debug.LogLevel
 import com.onesignal.debug.internal.logging.Logging
 import com.onesignal.user.IUserManager
+import com.onesignal.user.IUserStateObserver
 import com.onesignal.user.internal.backend.IdentityConstants
 import com.onesignal.user.internal.identity.IdentityModel
 import com.onesignal.user.internal.identity.IdentityModelStore
@@ -29,6 +31,8 @@ internal open class UserManager(
     val subscriptions: SubscriptionList
         get() = _subscriptionManager.subscriptions
 
+    val changeHandlersNotifier = EventProducer<IUserStateObserver>()
+
     override val pushSubscription: IPushSubscription
         get() = _subscriptionManager.subscriptions.push
 
@@ -219,4 +223,8 @@ internal open class UserManager(
     override fun getTags(): Map<String, String> {
         return _propertiesModel.tags.toMap()
     }
+
+    override fun addObserver(observer: IUserStateObserver) = changeHandlersNotifier.subscribe(observer)
+
+    override fun removeObserver(observer: IUserStateObserver) = changeHandlersNotifier.unsubscribe(observer)
 }

OneSignalSDK/onesignal/notifications/consumer-rules.pro

@@ -20,6 +20,9 @@
     void onPushSubscriptionChange(com.onesignal.user.subscriptions.PushSubscriptionChangedState);
 }
 
+-keep class ** implements com.onesignal.user.IUserStateObserver {
+    void onUserChange(com.onesignal.user.UserChangedState);
+}
 -keep class ** implements com.onesignal.notifications.INotificationServiceExtension{
    void onNotificationReceived(com.onesignal.notifications.INotificationReceivedEvent);
 }