Merge pull request #647 from OneSignal/user_model/Session-namespace

fhboswell · web-flow · commit 2edf84276306 · 2023-02-14T18:00:53.000-08:00
[User Model] Session Namespace
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -41,28 +41,31 @@ class _MyAppState extends State<MyApp> with OneSignalPushSubscriptionObserver {
 
     OneSignal.User.pushSubscription.addObserver(this);
 
-    // OneSignal.shared.setRequiresUserPrivacyConsent(_requireConsent);
+    // Outcome Examples
+    oneSignalOutcomeExamples();
 
-    // OneSignal.shared
-    //     .setNotificationOpenedHandler((OSNotificationOpenedResult result) {
-    //       print('NOTIFICATION OPENED HANDLER CALLED WITH: ${result}');
-    //       this.setState(() {
-    //       _debugLabelString =
-    //           "Opened notification: \n${result.notification.jsonRepresentation().replaceAll("\\n", "\n")}";
-    //   });
-    // });
+    // OneSignal.shared.setRequiresUserPrivacyConsent(_requireConsent);
 
-    // OneSignal.shared
-    //     .setNotificationWillShowInForegroundHandler((OSNotificationReceivedEvent event) {
-    //        print('FOREGROUND HANDLER CALLED WITH: ${event}');
-    //        /// Display Notification, send null to not display
-    //        event.complete(null);
+    OneSignal.Notifications
+        .setNotificationOpenedHandler((OSNotificationOpenedResult result) {
+          print('NOTIFICATION OPENED HANDLER CALLED WITH: ${result}');
+          this.setState(() {
+          _debugLabelString =
+              "Opened notification: \n${result.notification.jsonRepresentation().replaceAll("\\n", "\n")}";
+      });
+    });
+
+    OneSignal.Notifications
+        .setNotificationWillShowInForegroundHandler((OSNotificationReceivedEvent event) {
+           print('FOREGROUND HANDLER CALLED WITH: ${event}');
+           /// Display Notification, send null to not display
+           event.complete(null);
           
-    //        this.setState(() {
-    //        _debugLabelString =
-    //           "Notification received in foreground notification: \n${event.notification.jsonRepresentation().replaceAll("\\n", "\n")}";
-    //   });
-    // });  
+           this.setState(() {
+           _debugLabelString =
+              "Notification received in foreground notification: \n${event.notification.jsonRepresentation().replaceAll("\\n", "\n")}";
+      });
+    });  
 
     // OneSignal.shared
     //     .setInAppMessageClickedHandler((OSInAppMessageAction action) {
@@ -330,32 +333,16 @@ class _MyAppState extends State<MyApp> with OneSignalPushSubscriptionObserver {
     // OneSignal.shared.pauseInAppMessages(false);
   }
 
-  oneSignalOutcomeEventsExamples() async {
-    // Await example for sending outcomes
-    outcomeAwaitExample();
+  oneSignalOutcomeExamples() async {
+ 
+    OneSignal.Session.addOutcome("normal_1");
+    OneSignal.Session.addOutcome("normal_2");
 
-    // Send a normal outcome and get a reply with the name of the outcome
-    // OneSignal.shared.sendOutcome("normal_1");
-    // OneSignal.shared.sendOutcome("normal_2").then((outcomeEvent) {
-    //   print(outcomeEvent.jsonRepresentation());
-    // });
-
-    // Send a unique outcome and get a reply with the name of the outcome
-    // OneSignal.shared.sendUniqueOutcome("unique_1");
-    // OneSignal.shared.sendUniqueOutcome("unique_2").then((outcomeEvent) {
-    //   print(outcomeEvent.jsonRepresentation());
-    // });
-
-    // Send an outcome with a value and get a reply with the name of the outcome
-    // OneSignal.shared.sendOutcomeWithValue("value_1", 3.2);
-    // OneSignal.shared.sendOutcomeWithValue("value_2", 3.9).then((outcomeEvent) {
-    //   print(outcomeEvent.jsonRepresentation());
-    // });
-  }
+    OneSignal.Session.addUniqueOutcome("unique_1");
+    OneSignal.Session.addUniqueOutcome("unique_2");
 
-  Future<void> outcomeAwaitExample() async {
-      // var outcomeEvent = await OneSignal.shared.sendOutcome("await_normal_1");
-      // print(outcomeEvent.jsonRepresentation());
+    OneSignal.Session.addOutcomeWithValue("value_1", 3.2);
+    OneSignal.Session.addOutcomeWithValue("value_2", 3.9);
   }
 
   void _handleOptIn() {
diff --git a/ios/Classes/OSFlutterNotifications.m b/ios/Classes/OSFlutterNotifications.m
@@ -75,6 +75,8 @@ - (void)handleMethodCall:(FlutterMethodCall*)call result:(FlutterResult)result {
         [self removePermissionObserver:call withResult:result];
     else if ([@"OneSignal#initNotificationWillShowInForegroundHandlerParams" isEqualToString:call.method])
         [self initNotificationWillShowInForegroundHandlerParams];
+    else if ([@"OneSignal#completeNotification" isEqualToString:call.method])
+        [self completeNotification:call withResult:result];
     else if ([@"OneSignal#initNotificationOpenedHandlerParams" isEqualToString:call.method])
         [self initNotificationOpenedHandlerParams];
     else
@@ -134,6 +136,28 @@ - (void)handleNotificationWillShowInForeground:(OSNotification *)notification co
     [self.channel invokeMethod:@"OneSignal#handleNotificationWillShowInForeground" arguments:notification.toJson];
 }
 
+- (void)completeNotification:(FlutterMethodCall *)call withResult:(FlutterResult)result {
+    NSString *notificationId = call.arguments[@"notificationId"];
+    BOOL shouldDisplay = [call.arguments[@"shouldDisplay"] boolValue];
+    OSNotificationDisplayResponse completion = self.notificationCompletionCache[notificationId];
+    
+    if (!completion) {
+        // TODO: log
+        //[OneSignal onesignalLog:ONE_S_LL_ERROR message:[NSString stringWithFormat:@"OneSignal (objc): could not find notification completion block with id: %@", notificationId]];
+        return;
+    }
+
+    if (shouldDisplay) {
+        OSNotification *notification = self.receivedNotificationCache[notificationId];
+        completion(notification);
+    } else {
+        completion(nil);
+    }
+
+    [self.notificationCompletionCache removeObjectForKey:notificationId];
+    [self.receivedNotificationCache removeObjectForKey:notificationId];
+}
+
 #pragma mark Opened Notification
 
 - (void)initNotificationOpenedHandlerParams {
diff --git a/ios/Classes/OSFlutterSession.h b/ios/Classes/OSFlutterSession.h
@@ -0,0 +1,36 @@
+/**
+ * Modified MIT License
+ *
+ * Copyright 2017 OneSignal
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * 1. The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * 2. All copies of substantial portions of the Software may only be used in connection
+ * with services provided by OneSignal.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+
+#import <Foundation/Foundation.h>
+#import <Flutter/Flutter.h>
+
+@interface OSFlutterSession : NSObject<FlutterPlugin>
+
+@property (strong, nonatomic) FlutterMethodChannel *channel;
+
+@end
diff --git a/ios/Classes/OSFlutterSession.m b/ios/Classes/OSFlutterSession.m
@@ -0,0 +1,75 @@
+/**
+ * Modified MIT License
+ *
+ * Copyright 2023 OneSignal
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * 1. The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * 2. All copies of substantial portions of the Software may only be used in connection
+ * with services provided by OneSignal.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#import "OSFlutterSession.h"
+#import <OneSignalFramework/OneSignalFramework.h>
+#import "OSFlutterCategories.h"
+
+@implementation OSFlutterSession
++ (void)registerWithRegistrar:(NSObject<FlutterPluginRegistrar>*)registrar {
+    OSFlutterSession *instance = [OSFlutterSession new];
+
+    instance.channel = [FlutterMethodChannel
+                        methodChannelWithName:@"OneSignal#session"
+                        binaryMessenger:[registrar messenger]];
+
+    [registrar addMethodCallDelegate:instance channel:instance.channel];
+}
+
+- (void)handleMethodCall:(FlutterMethodCall *)call result:(FlutterResult)result {
+    if ([@"OneSignal#addOutcome" isEqualToString:call.method]) {
+        [self addOutcome:call withResult:result];
+    } else if ([@"OneSignal#addUniqueOutcome" isEqualToString:call.method]) {
+        [self addUniqueOutcome:call withResult:result];
+    } else if ([@"OneSignal#addOutcomeWithValue" isEqualToString:call.method]) {
+        [self addOutcomeWithValue:call withResult:result];
+    } else {
+        result(FlutterMethodNotImplemented);
+    }
+}
+
+- (void)addOutcome:(FlutterMethodCall *)call withResult:(FlutterResult)result {
+    NSString *name = call.arguments;
+    [OneSignal.Session addOutcome:name];
+    result(nil);
+}
+
+- (void)addUniqueOutcome:(FlutterMethodCall *)call withResult:(FlutterResult)result {
+    NSString *name = call.arguments;
+    [OneSignal.Session addUniqueOutcome:name];
+    result(nil);
+}
+
+- (void)addOutcomeWithValue:(FlutterMethodCall *)call withResult:(FlutterResult)result {
+    NSString *name = call.arguments[@"outcome_name"];
+    NSNumber *value = call.arguments[@"outcome_value"];
+    [OneSignal.Session addOutcomeWithValue:name value:value];
+    result(nil);
+}
+
+
+@end
diff --git a/ios/Classes/OneSignalPlugin.m b/ios/Classes/OneSignalPlugin.m
@@ -30,6 +30,7 @@
 #import "OSFlutterDebug.h"
 #import "OSFlutterUser.h"
 #import "OSFlutterNotifications.h"
+#import "OSFlutterSession.h"
 
 
 @interface OneSignalPlugin ()
@@ -72,6 +73,7 @@ + (void)registerWithRegistrar:(NSObject<FlutterPluginRegistrar>*)registrar {
     [OSFlutterDebug registerWithRegistrar:registrar];
     [OSFlutterUser registerWithRegistrar:registrar];
     [OSFlutterNotifications registerWithRegistrar:registrar];
+    [OSFlutterSession registerWithRegistrar:registrar];
     
 }
 
diff --git a/lib/onesignal_flutter.dart b/lib/onesignal_flutter.dart
@@ -7,11 +7,13 @@ import 'package:onesignal_flutter/src/utils.dart';
 import 'package:onesignal_flutter/src/debug.dart';
 import 'package:onesignal_flutter/src/user.dart';
 import 'package:onesignal_flutter/src/notifications.dart';
+import 'package:onesignal_flutter/src/session.dart';
 
 export 'src/permission.dart';
 export 'src/defines.dart';
 export 'src/pushsubscription.dart';
 export 'src/subscription.dart';
+export 'src/notification.dart';
 
 class OneSignal {
   /// A singleton representing the OneSignal SDK.
@@ -22,6 +24,7 @@ class OneSignal {
   static OneSignalDebug Debug = new OneSignalDebug();
   static OneSignalUser User = new OneSignalUser();
   static OneSignalNotifications Notifications = new OneSignalNotifications();
+  static OneSignalSession Session = new OneSignalSession();
   
 
   // private channels used to bridge to ObjC/Java
diff --git a/lib/src/notification.dart b/lib/src/notification.dart
@@ -389,16 +389,14 @@ class OSNotificationReceivedEvent extends JSONStringRepresentable {
     notification = OSNotification(json);
   }
 
-  //TODO: remove
-
-//   void complete(OSNotification? notification) {
-//     print('OSNotificationReceivedEvent complete with notification: $notification');
-//     if (notification != null) {
-//         OneSignal.shared.completeNotification(notification.notificationId, true);
-//     } else {
-//         OneSignal.shared.completeNotification(this.notification.notificationId, false);
-//     }
-//   }
+  void complete(OSNotification? notification) {
+    print('OSNotificationReceivedEvent complete with notification: $notification');
+    if (notification != null) {
+        OneSignal.Notifications.completeNotification(notification.notificationId, true);
+    } else {
+        OneSignal.Notifications.completeNotification(this.notification.notificationId, false);
+    }
+  }
 
   String jsonRepresentation() {
     return convertToJsonString({
diff --git a/lib/src/notifications.dart b/lib/src/notifications.dart
@@ -101,6 +101,13 @@ class OneSignalNotifications {
     _channel.invokeMethod("OneSignal#initNotificationWillShowInForegroundHandlerParams");
   } 
 
+   /// The notification foreground handler is called whenever a notification arrives
+  /// and the application is in foreground
+  void completeNotification(String notificationId, bool shouldDisplay) {
+    _channel.invokeMethod("OneSignal#completeNotification",
+        {'notificationId': notificationId, 'shouldDisplay': shouldDisplay});
+  }
+
 
   /// The notification opened handler is called whenever the user opens a
   /// OneSignal push notification, or taps an action button on a notification.
diff --git a/lib/src/session.dart b/lib/src/session.dart
@@ -0,0 +1,28 @@
+import 'dart:async';
+import 'dart:io' show Platform;
+import 'package:flutter/services.dart';
+import 'package:onesignal_flutter/src/defines.dart';
+
+class OneSignalSession {
+
+  // private channels used to bridge to ObjC/Java
+  MethodChannel _channel = const MethodChannel('OneSignal#session');
+
+  /// Send a normal outcome event for the current session and notifications with the attribution window
+  /// Counted each time sent successfully, failed ones will be cached and reattempted in future
+  Future<void> addOutcome(String name) async {
+    await _channel.invokeMethod("OneSignal#addOutcome", name);
+  }
+
+  /// Send a unique outcome event for the current session and notifications with the attribution window
+  /// Counted once per notification when sent successfully, failed ones will be cached and reattempted in future
+  Future<void> addUniqueOutcome(String name) async {
+    _channel.invokeMethod("OneSignal#addUniqueOutcome", name);
+  }
+
+  /// Send an outcome event with a value for the current session and notifications with the attribution window
+  /// Counted each time sent successfully, failed ones will be cached and reattempted in future
+  Future<void> addOutcomeWithValue(String name, double value) async {
+    _channel.invokeMethod("OneSignal#addOutcomeWithValue", {"outcome_name" : name, "outcome_value" : value});
+  }
+}
