From d9792fee6da9752b84d7a729d3f1fa124c3a3478 Mon Sep 17 00:00:00 2001 From: Nan Date: Sun, 10 Dec 2023 15:14:40 -0800 Subject: [PATCH] Add in-code documentation on user state observer * Add a callout on the usage of the user state observer. * App developers should be checking the `externalId` when they retreive the `onesignalId`. This is to make sure they are grabbing the onesignalId for the user that they expect. --- .../OneSignalUser/Source/OneSignalUserManagerImpl.swift | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OneSignalUserManagerImpl.swift b/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OneSignalUserManagerImpl.swift index e158992b2..a662ed19a 100644 --- a/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OneSignalUserManagerImpl.swift +++ b/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OneSignalUserManagerImpl.swift @@ -50,7 +50,10 @@ import OneSignalNotifications var pushSubscription: OSPushSubscription { get } var onesignalId: String? { get } var externalId: String? { get } - // User State Observer + /** + Add an observer to the user state, allowing the provider to be notified when the user state has changed. + Important: When using the observer to retreieve the `onesignalId`, check the `externalId` as well to confirm the values are associated with the expected user. + */ func addObserver(_ observer: OSUserStateObserver) func removeObserver(_ observer: OSUserStateObserver) // Aliases