Merge pull request #105 from OneSignal/in_app_messaging_and_bug_fixes

jkasten2 · web-flow · commit cd764e413dbd · 2019-07-19T18:27:58.000-07:00
Flutter SDK updates for IAM and bug fixes
diff --git a/android/build.gradle b/android/build.gradle
@@ -34,7 +34,7 @@ android {
 }
 
 dependencies {
-    compile('com.onesignal:OneSignal:3.10.5')
+    compile('com.onesignal:OneSignal:3.11.1')
 }
 
 // Adds required manifestPlaceholders keys to allow mainifest merge gradle step to complete
diff --git a/android/src/main/java/com/onesignal/flutter/OneSignalPlugin.java b/android/src/main/java/com/onesignal/flutter/OneSignalPlugin.java
diff --git a/android/src/main/java/com/onesignal/flutter/OneSignalSerializer.java b/android/src/main/java/com/onesignal/flutter/OneSignalSerializer.java
@@ -11,8 +11,8 @@
 import java.util.Iterator;
 import java.util.List;
 
-public class OneSignalSerializer {
-    static private HashMap<String, Object> convertSubscriptionStateToMap(OSSubscriptionState state) {
+class OneSignalSerializer {
+    private static HashMap<String, Object> convertSubscriptionStateToMap(OSSubscriptionState state) {
         HashMap<String, Object> hash = new HashMap<>();
 
         hash.put("subscribed", state.getSubscribed());
@@ -23,15 +23,15 @@ static private HashMap<String, Object> convertSubscriptionStateToMap(OSSubscript
         return hash;
     }
 
-    static private HashMap<String, Object> convertPermissionStateToMap(OSPermissionState state) {
+    private static HashMap<String, Object> convertPermissionStateToMap(OSPermissionState state) {
         HashMap<String, Object> permission = new HashMap<>();
 
         permission.put("enabled", state.getEnabled());
 
         return permission;
     }
 
-    static private HashMap<String, Object> convertEmailSubscriptionStateToMap(OSEmailSubscriptionState state) {
+    private static HashMap<String, Object> convertEmailSubscriptionStateToMap(OSEmailSubscriptionState state) {
         HashMap<String, Object> hash = new HashMap<>();
 
         hash.put("emailUserId", state.getEmailUserId());
@@ -41,7 +41,7 @@ static private HashMap<String, Object> convertEmailSubscriptionStateToMap(OSEmai
         return hash;
     }
 
-    static public HashMap<String, Object> convertPermissionSubscriptionStateToMap(OSPermissionSubscriptionState state) {
+    static HashMap<String, Object> convertPermissionSubscriptionStateToMap(OSPermissionSubscriptionState state) {
         HashMap<String, Object> hash = new HashMap<>();
 
         OSSubscriptionState subState = state.getSubscriptionStatus();
@@ -60,7 +60,7 @@ static public HashMap<String, Object> convertPermissionSubscriptionStateToMap(OS
         return hash;
     }
 
-    static public HashMap<String, Object> convertSubscriptionStateChangesToMap(OSSubscriptionStateChanges changes) {
+    static HashMap<String, Object> convertSubscriptionStateChangesToMap(OSSubscriptionStateChanges changes) {
         HashMap<String, Object> hash = new HashMap<>();
 
         hash.put("to", convertSubscriptionStateToMap(changes.getTo()));
@@ -69,7 +69,7 @@ static public HashMap<String, Object> convertSubscriptionStateChangesToMap(OSSub
         return hash;
     }
 
-    static public HashMap<String, Object> convertEmailSubscriptionStateChangesToMap(OSEmailSubscriptionStateChanges changes) {
+    static HashMap<String, Object> convertEmailSubscriptionStateChangesToMap(OSEmailSubscriptionStateChanges changes) {
        HashMap<String, Object> hash = new HashMap<>();
 
         hash.put("to", convertEmailSubscriptionStateToMap(changes.getTo()));
@@ -78,7 +78,7 @@ static public HashMap<String, Object> convertEmailSubscriptionStateChangesToMap(
         return hash;
     }
 
-    static public HashMap convertPermissionStateChangesToMap(OSPermissionStateChanges changes) {
+    static HashMap convertPermissionStateChangesToMap(OSPermissionStateChanges changes) {
        HashMap<String, Object> hash = new HashMap<>();
 
         hash.put("to", convertPermissionStateToMap(changes.getTo()));
@@ -87,7 +87,7 @@ static public HashMap convertPermissionStateChangesToMap(OSPermissionStateChange
         return hash;
     }
 
-    static private HashMap<String, Object> convertNotificationPayloadToMap(OSNotificationPayload payload) throws JSONException {
+    private static HashMap<String, Object> convertNotificationPayloadToMap(OSNotificationPayload payload) throws JSONException {
        HashMap<String, Object> hash = new HashMap<>();
 
         hash.put("notificationId", payload.notificationID);
@@ -140,7 +140,7 @@ static private HashMap<String, Object> convertNotificationPayloadToMap(OSNotific
         return hash;
     }
 
-    static public HashMap<String, Object> convertNotificationToMap(OSNotification notification) throws JSONException {
+    static HashMap<String, Object> convertNotificationToMap(OSNotification notification) throws JSONException {
         HashMap<String, Object> hash = new HashMap<>();
 
         hash.put("payload", convertNotificationPayloadToMap(notification.payload));
@@ -161,7 +161,7 @@ static public HashMap<String, Object> convertNotificationToMap(OSNotification no
         return hash;
     }
 
-    static public HashMap<String, Object> convertNotificationOpenResultToMap(OSNotificationOpenResult openResult) throws JSONException {
+    static HashMap<String, Object> convertNotificationOpenResultToMap(OSNotificationOpenResult openResult) throws JSONException {
         HashMap<String, Object> hash = new HashMap<>();
 
         hash.put("notification", convertNotificationToMap(openResult.notification));
@@ -170,7 +170,7 @@ static public HashMap<String, Object> convertNotificationOpenResultToMap(OSNotif
         return hash;
     }
 
-    static private HashMap<String, Object> convertNotificationActionToMap(OSNotificationAction action) {
+    private static HashMap<String, Object> convertNotificationActionToMap(OSNotificationAction action) {
         HashMap<String, Object> hash = new HashMap<>();
 
         hash.put("id", action.actionID);
@@ -186,7 +186,18 @@ static private HashMap<String, Object> convertNotificationActionToMap(OSNotifica
         return hash;
     }
 
-    static private HashMap<String, Object> convertAndroidBackgroundImageLayoutToMap(BackgroundImageLayout layout) {
+    static HashMap<String, Object> convertInAppMessageClickedActionToMap(OSInAppMessageAction action) {
+        HashMap<String, Object> hash = new HashMap<>();
+
+        hash.put("click_name", action.clickName);
+        hash.put("click_url", action.clickUrl);
+        hash.put("first_click", action.firstClick);
+        hash.put("closes_message", action.closesMessage);
+
+        return hash;
+    }
+
+    private static HashMap<String, Object> convertAndroidBackgroundImageLayoutToMap(BackgroundImageLayout layout) {
         HashMap<String, Object> hash = new HashMap<>();
 
         hash.put("image", layout.image);
@@ -196,7 +207,7 @@ static private HashMap<String, Object> convertAndroidBackgroundImageLayoutToMap(
         return hash;
     }
 
-    static public HashMap<String, Object> convertJSONObjectToHashMap(JSONObject object) throws JSONException {
+    static HashMap<String, Object> convertJSONObjectToHashMap(JSONObject object) throws JSONException {
         HashMap<String, Object> hash = new HashMap<>();
 
         if (object == null || object == JSONObject.NULL)
@@ -224,7 +235,7 @@ static public HashMap<String, Object> convertJSONObjectToHashMap(JSONObject obje
         return hash;
     }
 
-    static private List<Object> convertJSONArrayToList(JSONArray array) throws JSONException {
+    private static List<Object> convertJSONArrayToList(JSONArray array) throws JSONException {
         List<Object> list = new ArrayList<>();
 
         for (int i = 0; i < array.length(); i++) {
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -39,7 +39,7 @@ class _MyAppState extends State<MyApp> {
       OSiOSSettings.promptBeforeOpeningPushUrl: true
     };
 
-    OneSignal.shared.setNotificationReceivedHandler((notification) {
+    OneSignal.shared.setNotificationReceivedHandler((OSNotification notification) {
       this.setState(() {
         _debugLabelString =
             "Received notification: \n${notification.jsonRepresentation().replaceAll("\\n", "\n")}";
@@ -54,6 +54,14 @@ class _MyAppState extends State<MyApp> {
       });
     });
 
+    OneSignal.shared
+    .setInAppMessageClickedHandler((OSInAppMessageAction action) {
+      this.setState(() {
+        _debugLabelString =
+            "In App Message Clicked: \n${action.jsonRepresentation().replaceAll("\\n", "\n")}";
+      });
+    });
+
     OneSignal.shared
         .setSubscriptionObserver((OSSubscriptionStateChanges changes) {
       print("SUBSCRIPTION STATE CHANGED: ${changes.jsonRepresentation()}");
@@ -80,6 +88,9 @@ class _MyAppState extends State<MyApp> {
     this.setState(() {
       _enableConsentButton = requiresConsent;
     });
+
+    // Some examples of how to use In App Messaging public methods with OneSignal SDK
+    oneSignalInAppMessagingTriggerExamples();
   }
 
   void _handleGetTags() {
@@ -222,6 +233,38 @@ class _MyAppState extends State<MyApp> {
     });
   }
 
+  oneSignalInAppMessagingTriggerExamples() async {
+    /// Example addTrigger call for IAM
+    /// This will add 1 trigger so if there are any IAM satisfying it, it
+    /// will be shown to the user
+    OneSignal.shared.addTrigger("trigger_1", "value_1");
+
+    /// Example addTriggers call for IAM
+    /// This will add 2 triggers so if there are any IAM satisfying these, they
+    /// will be shown to the user
+    Map<String, Object> triggers = new Map<String, Object>();
+    triggers["trigger_2"] = "value_2";
+    triggers["trigger_3"] = "value_3";
+    OneSignal.shared.addTriggers(triggers);
+
+    // Removes a trigger by its key so if any future IAM are pulled with
+    // these triggers they will not be shown until the trigger is added back
+    OneSignal.shared.removeTriggerForKey("trigger_2");
+
+    // Get the value for a trigger by its key
+    Object triggerValue = await OneSignal.shared.getTriggerValueForKey("trigger_3");
+    print("'trigger_3' key trigger value: " + triggerValue);
+
+    // Create a list and bulk remove triggers based on keys supplied
+    List<String> keys = new List<String>();
+    keys.add("trigger_1");
+    keys.add("trigger_3");
+    OneSignal.shared.removeTriggerForKeys(keys);
+
+    // Toggle pausing (displaying or not) of IAMs
+    OneSignal.shared.pauseInAppMessages(true);
+  }
+
   @override
   Widget build(BuildContext context) {
     return new MaterialApp(
diff --git a/ios/Classes/OneSignalPlugin.m b/ios/Classes/OneSignalPlugin.m
@@ -124,8 +124,8 @@ - (void)handleMethodCall:(FlutterMethodCall*)call result:(FlutterResult)result {
         [self setEmail:call withResult:result];
     } else if ([@"OneSignal#logoutEmail" isEqualToString:call.method]) {
         [self logoutEmail:call withResult:result];
-    } else if ([@"OneSignal#didSetNotificationOpenedHandler" isEqualToString:call.method]) {
-        [self didSetNotificationOpenedHandler];
+    } else if ([@"OneSignal#initNotificationOpenedHandlerParams" isEqualToString:call.method]) {
+        [self initNotificationOpenedHandlerParams];
     } else if ([@"OneSignal#setExternalUserId" isEqualToString:call.method]) {
         [OneSignal setExternalUserId:call.arguments[@"externalUserId"]];
     } else if ([@"OneSignal#removeExternalUserId" isEqualToString:call.method]) {
@@ -229,7 +229,7 @@ - (void)oneSignalLog:(FlutterMethodCall *)call withResult:(FlutterResult)result
     [OneSignal onesignal_Log:(ONE_S_LOG_LEVEL)[call.arguments[@"logLevel"] integerValue] message:(NSString *)call.arguments[@"message"]];
 }
 
-- (void)didSetNotificationOpenedHandler {
+- (void)initNotificationOpenedHandlerParams {
     if (self.coldStartOpenResult) {
         [self handleNotificationOpened:self.coldStartOpenResult];
         self.coldStartOpenResult = nil;
diff --git a/lib/onesignal.dart b/lib/onesignal.dart
@@ -6,20 +6,23 @@ import 'package:onesignal/src/defines.dart';
 import 'package:onesignal/src/utils.dart';
 import 'package:onesignal/src/notification.dart';
 import 'package:onesignal/src/create_notification.dart';
+import 'package:onesignal/src/in_app_message.dart';
 
 export 'src/notification.dart';
 export 'src/subscription.dart';
 export 'src/permission.dart';
 export 'src/defines.dart';
 export 'src/create_notification.dart';
+export 'src/in_app_message.dart';
 
 // Handlers for various events
 typedef void ReceivedNotificationHandler(OSNotification notification);
 typedef void OpenedNotificationHandler(OSNotificationOpenedResult openedResult);
 typedef void SubscriptionChangedHandler(OSSubscriptionStateChanges changes);
 typedef void EmailSubscriptionChangeHandler(
-    OSEmailSubscriptionStateChanges changes);
+  OSEmailSubscriptionStateChanges changes);
 typedef void PermissionChangeHandler(OSPermissionStateChanges changes);
+typedef void InAppMessageClickedHandler(OSInAppMessageAction action);
 
 class OneSignal {
   /// A singleton representing the OneSignal SDK.
@@ -38,6 +41,7 @@ class OneSignal {
   SubscriptionChangedHandler _onSubscriptionChangedHandler;
   EmailSubscriptionChangeHandler _onEmailSubscriptionChangedHandler;
   PermissionChangeHandler _onPermissionChangedHandler;
+  InAppMessageClickedHandler _onInAppMessageClickedHandler;
 
   // constructor method
   OneSignal() {
@@ -75,7 +79,7 @@ class OneSignal {
   /// OneSignal push notification, or taps an action button on a notification.
   void setNotificationOpenedHandler(OpenedNotificationHandler handler) {
     _onOpenedNotification = handler;
-    _channel.invokeMethod("OneSignal#didSetNotificationOpenedHandler");
+    _channel.invokeMethod("OneSignal#initNotificationOpenedHandlerParams");
   }
 
   /// The subscription handler will be called whenever the user's OneSignal
@@ -99,6 +103,13 @@ class OneSignal {
     _onEmailSubscriptionChangedHandler = handler;
   }
 
+  /// The in app message clicked handler is called whenever the user clicks a
+  /// OneSignal IAM button or image with an action event attacthed to it
+  void setInAppMessageClickedHandler(InAppMessageClickedHandler handler) {
+    _onInAppMessageClickedHandler = handler;
+    _channel.invokeMethod("OneSignal#initInAppMessageClickedHandlerParams");
+  }
+
   /// Allows you to completely disable the SDK until your app calls the
   /// OneSignal.consentGranted(true) function. This is useful if you want
   /// to show a Terms and Conditions or privacy popup for GDPR.
@@ -274,6 +285,40 @@ class OneSignal {
     return await _channel.invokeMethod("OneSignal#removeExternalUserId");
   }
 
+  /// Adds a single key, value trigger, which will trigger an in app message
+  /// if one exists matching the specific trigger added
+  Future<void> addTrigger(String key, Object value) async {
+    return await _channel.invokeMethod("OneSignal#addTrigger", {key : value});
+  }
+
+  /// Adds one or more key, value triggers, which will trigger in app messages
+  /// (one at a time) if any exist matching the specific triggers added
+  Future<void> addTriggers(Map<String, Object> triggers) async {
+    return await _channel.invokeMethod("OneSignal#addTriggers", triggers);
+  }
+
+  /// Remove a single key, value trigger to prevent an in app message from
+  /// showing with that trigger
+  Future<void> removeTriggerForKey(String key) async {
+    return await _channel.invokeMethod("OneSignal#removeTriggerForKey", key);
+  }
+
+  /// Remove one or more key, value triggers to prevent any in app messages
+  /// from showing with those triggers
+  Future<void> removeTriggerForKeys(List<String> keys) async {
+    return await _channel.invokeMethod("OneSignal#removeTriggerForKeys", keys);
+  }
+
+  /// Get the trigger value associated with the key provided
+  Future<Object> getTriggerValueForKey(String key) async {
+    return await _channel.invokeMethod("OneSignal#getTriggerValueForKey", key);
+  }
+
+  /// Toggles the showing of all in app messages
+  Future<void> pauseInAppMessages(bool pause) async {
+    return await _channel.invokeMethod("OneSignal#pauseInAppMessages", pause);
+  }
+
   // Private function that gets called by ObjC/Java
   Future<Null> _handleMethod(MethodCall call) async {
     if (call.method == 'OneSignal#handleReceivedNotification' &&
@@ -297,8 +342,11 @@ class OneSignal {
       this._onEmailSubscriptionChangedHandler(
           OSEmailSubscriptionStateChanges(
               call.arguments.cast<String, dynamic>()));
+    } else if (call.method == 'OneSignal#handleClickedInAppMessage' &&
+        this._onInAppMessageClickedHandler != null) {
+      this._onInAppMessageClickedHandler(
+          OSInAppMessageAction(call.arguments.cast<String, dynamic>()));
     }
-
     return null;
   }
 
diff --git a/lib/src/in_app_message.dart b/lib/src/in_app_message.dart
@@ -0,0 +1,36 @@
+import 'package:onesignal/src/utils.dart';
+
+/// When a click action is defined on an In App Message form the dashboard,
+/// the handler returns an OSInAppMessageAction object so the Dart code can act accordingly
+/// This allows for custom action events within Dart
+class OSInAppMessageAction extends JSONStringRepresentable {
+
+  // Name of the action event defined for the IAM element
+  String clickName;
+
+  // URL given to the IAM element defined in the dashboard
+  String clickUrl;
+
+  // Determines if a first click has occurred or not on the IAM element
+  bool firstClick;
+
+  // Whether or not the click action should dismiss the IAM
+  bool closesMessage;
+
+  OSInAppMessageAction(Map<String, dynamic> json) {
+    this.clickName = json["click_name"];
+    this.clickUrl = json["click_url"];
+    this.firstClick = json["first_click"] as bool;
+    this.closesMessage = json["closes_message"] as bool;
+  }
+
+  String jsonRepresentation() {
+    return convertToJsonString({
+      'click_name': this.clickName,
+      'click_url': this.clickUrl,
+      'first_click': this.firstClick,
+      'closes_message': this.closesMessage,
+    });
+  }
+
+}

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ android {`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`dependencies {`
`37`		`- compile('com.onesignal:OneSignal:3.10.5')`
	`37`	`+ compile('com.onesignal:OneSignal:3.11.1')`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`// Adds required manifestPlaceholders keys to allow mainifest merge gradle step to complete`