[example app] observers, update bundle ID

nan-li · nan-li · commit d84070d6bcc7 · 2023-01-05T13:36:37.000-08:00
* Add push subscription observer and permission observer
* Missed this requirement for testing -&gt; update bundle ID to staging, needs to be `com.onesignal.example.staging`
* Move set log level up to capture logs earlier.
* Not making any structural changes to example app, but link some buttons to new methods like login, logout
diff --git a/iOS_SDK/OneSignalDevApp/OneSignalDevApp/AppDelegate.h b/iOS_SDK/OneSignalDevApp/OneSignalDevApp/AppDelegate.h
@@ -31,8 +31,7 @@
 #import <UIKit/UIKit.h>
 #import <OneSignalFramework/OneSignalFramework.h>
 
-// TODO: Add subscription observer
-@interface AppDelegate : UIResponder <UIApplicationDelegate, OSPermissionObserver, OSInAppMessageLifecycleHandler>
+@interface AppDelegate : UIResponder <UIApplicationDelegate, OSPermissionObserver, OSInAppMessageLifecycleHandler, OSPushSubscriptionObserver>
 
 @property (strong, nonatomic) UIWindow *window;
 
diff --git a/iOS_SDK/OneSignalDevApp/OneSignalDevApp/AppDelegate.m b/iOS_SDK/OneSignalDevApp/OneSignalDevApp/AppDelegate.m
@@ -50,11 +50,11 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
 //    [FIRApp configure];
     
     NSLog(@"Bundle URL: %@", [[NSBundle mainBundle] bundleURL]);
+    [OneSignal.Debug setLogLevel:ONE_S_LL_VERBOSE];
+    [OneSignal.Debug setVisualLevel:ONE_S_LL_NONE];
     
     [OneSignal initialize:[AppDelegate getOneSignalAppId] withLaunchOptions:launchOptions];
     
-    [OneSignal.Debug setLogLevel:ONE_S_LL_VERBOSE];
-    [OneSignal.Debug setVisualLevel:ONE_S_LL_NONE];
     _notificationDelegate = [OneSignalNotificationCenterDelegate new];
     
     id openNotificationHandler = ^(OSNotificationOpenedResult *result) {
@@ -94,6 +94,11 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
     [OneSignal.Notifications setNotificationWillShowInForegroundHandler:notificationReceiverBlock];
     [OneSignal.Notifications setNotificationOpenedHandler:openNotificationHandler];
 
+    OSPushSubscriptionState* state = [OneSignal.User.pushSubscription addObserver:self];
+    NSLog(@"OneSignal Demo App push subscription observer added, current state: %@", state);
+    
+    [OneSignal.Notifications addPermissionObserver:self];
+    
     NSLog(@"UNUserNotificationCenter.delegate: %@", UNUserNotificationCenter.currentNotificationCenter.delegate);
     
     return YES;
@@ -120,12 +125,11 @@ - (void) onOSPermissionChanged:(OSPermissionStateChanges*)stateChanges {
     NSLog(@"onOSPermissionChanged: %@", stateChanges);
 }
 
-// TODO: Add push sub observer
-//- (void) onOSSubscriptionChanged:(OSSubscriptionStateChanges*)stateChanges {
-//    NSLog(@"onOSSubscriptionChanged: %@", stateChanges);
-//    ViewController* mainController = (ViewController*) self.window.rootViewController;
-//    mainController.subscriptionSegmentedControl.selectedSegmentIndex = (NSInteger) stateChanges.to.isSubscribed;
-//}
+- (void)onOSPushSubscriptionChangedWithStateChanges:(OSPushSubscriptionStateChanges *)stateChanges {
+    NSLog(@"onOSPushSubscriptionChangedWithStateChanges: %@", stateChanges);
+    ViewController* mainController = (ViewController*) self.window.rootViewController;
+    mainController.subscriptionSegmentedControl.selectedSegmentIndex = (NSInteger) stateChanges.to.optedIn;
+}
 
 #pragma mark OSInAppMessageDelegate
 
diff --git a/iOS_SDK/OneSignalDevApp/OneSignalDevApp/Base.lproj/Main.storyboard b/iOS_SDK/OneSignalDevApp/OneSignalDevApp/Base.lproj/Main.storyboard
@@ -43,7 +43,7 @@
                                                     <constraint firstAttribute="width" constant="68" id="com-ja-CVD"/>
                                                 </constraints>
                                                 <color key="tintColor" red="1" green="0.1367101157" blue="0.01701983743" alpha="1" colorSpace="custom" customColorSpace="sRGB"/>
-                                                <state key="normal" title="Get Tags"/>
+                                                <state key="normal" title="INFO"/>
                                                 <connections>
                                                     <action selector="getTagsButton:" destination="BYZ-38-t0r" eventType="touchUpInside" id="Pp8-oA-Zrh"/>
                                                 </connections>
@@ -298,7 +298,7 @@
                                                 <rect key="frame" x="118" y="581" width="136" height="30"/>
                                                 <fontDescription key="fontDescription" name=".AppleSystemUIFont" family=".AppleSystemUIFont" pointSize="15"/>
                                                 <color key="tintColor" red="1" green="0.1367101157" blue="0.01701983743" alpha="1" colorSpace="custom" customColorSpace="sRGB"/>
-                                                <state key="normal" title="Set External User Id"/>
+                                                <state key="normal" title="Login to External User Id"/>
                                                 <connections>
                                                     <action selector="setExternalUserId:" destination="BYZ-38-t0r" eventType="touchUpInside" id="DXf-1K-Lkc"/>
                                                 </connections>
@@ -374,11 +374,11 @@
                                                 <fontDescription key="fontDescription" type="system" pointSize="14"/>
                                                 <textInputTraits key="textInputTraits"/>
                                             </textField>
-                                            <button opaque="NO" contentMode="scaleToFill" ambiguous="YES" misplaced="YES" selected="YES" contentHorizontalAlignment="center" contentVerticalAlignment="center" buttonType="system" lineBreakMode="middleTruncation" translatesAutoresizingMaskIntoConstraints="NO" id="OiG-L7-Ot2" userLabel="Remove External User Id">
+                                            <button opaque="NO" contentMode="scaleToFill" ambiguous="YES" misplaced="YES" selected="YES" contentHorizontalAlignment="center" contentVerticalAlignment="center" buttonType="system" lineBreakMode="middleTruncation" translatesAutoresizingMaskIntoConstraints="NO" id="OiG-L7-Ot2" userLabel="Logout">
                                                 <rect key="frame" x="103" y="619" width="168" height="30"/>
                                                 <fontDescription key="fontDescription" name=".AppleSystemUIFont" family=".AppleSystemUIFont" pointSize="15"/>
                                                 <color key="tintColor" red="1" green="0.1367101157" blue="0.01701983743" alpha="1" colorSpace="custom" customColorSpace="sRGB"/>
-                                                <state key="normal" title="Remove External User Id"/>
+                                                <state key="normal" title="Logout"/>
                                                 <connections>
                                                     <action selector="removeExternalUserId:" destination="BYZ-38-t0r" eventType="touchUpInside" id="F3N-HQ-tSv"/>
                                                 </connections>
diff --git a/iOS_SDK/OneSignalDevApp/OneSignalDevApp/OneSignalDevApp.entitlements b/iOS_SDK/OneSignalDevApp/OneSignalDevApp/OneSignalDevApp.entitlements
@@ -11,7 +11,7 @@
 	</array>
 	<key>com.apple.security.application-groups</key>
 	<array>
-		<string>group.com.onesignal.example.onesignal</string>
+		<string>group.com.onesignal.example.staging.onesignal</string>
 	</array>
 </dict>
 </plist>
diff --git a/iOS_SDK/OneSignalDevApp/OneSignalDevApp/ViewController.m b/iOS_SDK/OneSignalDevApp/OneSignalDevApp/ViewController.m
@@ -164,11 +164,14 @@ - (void)handleMessageAction:(NSString *)actionId {
 }
 
 - (IBAction)setExternalUserId:(UIButton *)sender {
-    NSLog(@"setExternalUserId is no longer supported. Please use login or addAlias.");
+    NSString* externalUserId = self.externalUserIdTextField.text;
+    NSLog(@"Dev App: Logging in to external user ID %@", externalUserId);
+    [OneSignal login:externalUserId];
 }
 
 - (IBAction)removeExternalUserId:(UIButton *)sender {
-    NSLog(@"setExternalUserId is no longer supported. Please use logout or removeAlias.");
+    NSLog(@"Dev App: Logout called.");
+    [OneSignal logout];
 }
 
 #pragma mark UITextFieldDelegate Methods
diff --git a/iOS_SDK/OneSignalDevApp/OneSignalDevAppClip/OneSignalDevAppClip.entitlements b/iOS_SDK/OneSignalDevApp/OneSignalDevAppClip/OneSignalDevAppClip.entitlements
@@ -11,7 +11,7 @@
 	</array>
 	<key>com.apple.developer.parent-application-identifiers</key>
 	<array>
-		<string>$(AppIdentifierPrefix)com.onesignal.example</string>
+		<string>$(AppIdentifierPrefix)com.onesignal.example.staging</string>
 	</array>
 </dict>
 </plist>
diff --git a/iOS_SDK/OneSignalDevApp/OneSignalExample.xcodeproj/project.pbxproj b/iOS_SDK/OneSignalDevApp/OneSignalExample.xcodeproj/project.pbxproj
@@ -745,7 +745,7 @@
 				);
 				MARKETING_VERSION = 1.4.4;
 				OTHER_LDFLAGS = "-ObjC";
-				PRODUCT_BUNDLE_IDENTIFIER = com.onesignal.example;
+				PRODUCT_BUNDLE_IDENTIFIER = com.onesignal.example.staging;
 				PRODUCT_NAME = OneSignalExample;
 				SUPPORTS_MACCATALYST = YES;
 				SWIFT_OBJC_BRIDGING_HEADER = "OneSignalDevApp/OneSignalExample-Bridging-Header.h";
@@ -776,7 +776,7 @@
 				);
 				MARKETING_VERSION = 1.4.4;
 				OTHER_LDFLAGS = "-ObjC";
-				PRODUCT_BUNDLE_IDENTIFIER = com.onesignal.example;
+				PRODUCT_BUNDLE_IDENTIFIER = com.onesignal.example.staging;
 				PRODUCT_NAME = OneSignalExample;
 				SUPPORTS_MACCATALYST = YES;
 				SWIFT_OBJC_BRIDGING_HEADER = "OneSignalDevApp/OneSignalExample-Bridging-Header.h";
@@ -804,7 +804,7 @@
 				);
 				MARKETING_VERSION = 1.4.4;
 				OTHER_LDFLAGS = "-ObjC";
-				PRODUCT_BUNDLE_IDENTIFIER = com.onesignal.example.OneSignalNotificationServiceExtensionA;
+				PRODUCT_BUNDLE_IDENTIFIER = com.onesignal.example.staging.OneSignalNotificationServiceExtensionA;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SKIP_INSTALL = YES;
 				SUPPORTS_MACCATALYST = YES;
@@ -832,7 +832,7 @@
 				);
 				MARKETING_VERSION = 1.4.4;
 				OTHER_LDFLAGS = "-ObjC";
-				PRODUCT_BUNDLE_IDENTIFIER = com.onesignal.example.OneSignalNotificationServiceExtensionA;
+				PRODUCT_BUNDLE_IDENTIFIER = com.onesignal.example.staging.OneSignalNotificationServiceExtensionA;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SKIP_INSTALL = YES;
 				SUPPORTS_MACCATALYST = YES;
@@ -877,7 +877,7 @@
 				MARKETING_VERSION = 1.4.4;
 				MTL_ENABLE_DEBUG_INFO = INCLUDE_SOURCE;
 				MTL_FAST_MATH = YES;
-				PRODUCT_BUNDLE_IDENTIFIER = com.onesignal.example.Clip;
+				PRODUCT_BUNDLE_IDENTIFIER = com.onesignal.example.staging.Clip;
 				PRODUCT_NAME = OneSignalExampleClip;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};
@@ -915,7 +915,7 @@
 				);
 				MARKETING_VERSION = 1.4.4;
 				MTL_FAST_MATH = YES;
-				PRODUCT_BUNDLE_IDENTIFIER = com.onesignal.example.Clip;
+				PRODUCT_BUNDLE_IDENTIFIER = com.onesignal.example.staging.Clip;
 				PRODUCT_NAME = OneSignalExampleClip;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};
diff --git a/iOS_SDK/OneSignalDevApp/OneSignalNotificationServiceExtension/OneSignalNotificationServiceExtension.entitlements b/iOS_SDK/OneSignalDevApp/OneSignalNotificationServiceExtension/OneSignalNotificationServiceExtension.entitlements
@@ -4,7 +4,7 @@
 <dict>
 	<key>com.apple.security.application-groups</key>
 	<array>
-		<string>group.com.onesignal.example.onesignal</string>
+		<string>group.com.onesignal.example.staging.onesignal</string>
 	</array>
 </dict>
 </plist>
diff --git a/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OSUserRequests.swift b/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OSUserRequests.swift
@@ -63,7 +63,7 @@ class OSUserExecutor {
     }
 
     /**
-     Used to parse Create User and Fetch User responses. The `originalPushToken` is the push token when the request was created, which may be different from the push token currently in the SDK (How again can that happen?). This is used to determine whether or not to hydrate the push subscription.
+     Used to parse Create User and Fetch User responses. The `originalPushToken` is the push token when the request was created, which may be different from the push token currently in the SDK. For example, when the request was created, there may be no push token yet, but soon after, the SDK receives a push token. This is used to determine whether or not to hydrate the push subscription.
      */
     static func parseFetchUserResponse(response: [AnyHashable:Any], identityModel: OSIdentityModel, originalPushToken: String?) {
         // On success, check if the current user is the same as the one in the request

Original file line number	Diff line number	Diff line change
`@@ -164,11 +164,14 @@ - (void)handleMessageAction:(NSString *)actionId {`
`164`	`164`	`}`
`165`	`165`
`166`	`166`	`- (IBAction)setExternalUserId:(UIButton *)sender {`
`167`		`- NSLog(@"setExternalUserId is no longer supported. Please use login or addAlias.");`
	`167`	`+ NSString* externalUserId = self.externalUserIdTextField.text;`
	`168`	`+ NSLog(@"Dev App: Logging in to external user ID %@", externalUserId);`
	`169`	`+ [OneSignal login:externalUserId];`
`168`	`170`	`}`
`169`	`171`
`170`	`172`	`- (IBAction)removeExternalUserId:(UIButton *)sender {`
`171`		`- NSLog(@"setExternalUserId is no longer supported. Please use logout or removeAlias.");`
	`173`	`+ NSLog(@"Dev App: Logout called.");`
	`174`	`+ [OneSignal logout];`
`172`	`175`	`}`
`173`	`176`
`174`	`177`	`#pragma mark UITextFieldDelegate Methods`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ class OSUserExecutor {`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`/**`
`66`		- Used to parse Create User and Fetch User responses. The `originalPushToken` is the push token when the request was created, which may be different from the push token currently in the SDK (How again can that happen?). This is used to determine whether or not to hydrate the push subscription.
	`66`	+ Used to parse Create User and Fetch User responses. The `originalPushToken` is the push token when the request was created, which may be different from the push token currently in the SDK. For example, when the request was created, there may be no push token yet, but soon after, the SDK receives a push token. This is used to determine whether or not to hydrate the push subscription.
`67`	`67`	`*/`
`68`	`68`	`static func parseFetchUserResponse(response: [AnyHashable:Any], identityModel: OSIdentityModel, originalPushToken: String?) {`
`69`	`69`	`// On success, check if the current user is the same as the one in the request`