Add SMS SubscriptionObserver

* Add setSMSSubscriptionObserver method
* Add example app setSMSSubscriptionObserver logger

Author: Jeasmine

android/src/main/java/com/onesignal/flutter/OneSignalPlugin.java

@@ -11,6 +11,8 @@
 import com.onesignal.OSNotificationReceivedEvent;
 import com.onesignal.OSPermissionObserver;
 import com.onesignal.OSPermissionStateChanges;
+import com.onesignal.OSSMSSubscriptionObserver;
+import com.onesignal.OSSMSSubscriptionStateChanges;
 import com.onesignal.OSSubscriptionObserver;
 import com.onesignal.OSSubscriptionStateChanges;
 import com.onesignal.OneSignal;
@@ -39,6 +41,7 @@ public class OneSignalPlugin
         OneSignal.OSInAppMessageClickHandler,
         OSSubscriptionObserver,
         OSEmailSubscriptionObserver,
+        OSSMSSubscriptionObserver,
         OSPermissionObserver,
         OneSignal.OSNotificationWillShowInForegroundHandler {
 
@@ -157,6 +160,7 @@ private void setAppId(MethodCall call, Result reply) {
   private void addObservers() {
     OneSignal.addSubscriptionObserver(this);
     OneSignal.addEmailSubscriptionObserver(this);
+    OneSignal.addSMSSubscriptionObserver(this);
     OneSignal.addPermissionObserver(this);
     OneSignal.setNotificationWillShowInForegroundHandler(this);
   }
@@ -438,6 +442,11 @@ public void onOSEmailSubscriptionChanged(OSEmailSubscriptionStateChanges stateCh
     invokeMethodOnUiThread("OneSignal#emailSubscriptionChanged", OneSignalSerializer.convertEmailSubscriptionStateChangesToMap(stateChanges));
   }
 
+  @Override
+  public void onSMSSubscriptionChanged(OSSMSSubscriptionStateChanges stateChanges) {
+    invokeMethodOnUiThread("OneSignal#smsSubscriptionChanged", OneSignalSerializer.convertSMSSubscriptionStateChangesToMap(stateChanges));
+  }
+
   @Override
   public void onOSPermissionChanged(OSPermissionStateChanges stateChanges) {
     invokeMethodOnUiThread("OneSignal#permissionChanged", OneSignalSerializer.convertPermissionStateChangesToMap(stateChanges));
@@ -483,4 +492,5 @@ public void notificationWillShowInForeground(OSNotificationReceivedEvent notific
               "Encountered an error attempting to convert OSNotificationReceivedEvent object to hash map: " + e.getMessage());
     }
   }
+
 }

android/src/main/java/com/onesignal/flutter/OneSignalSerializer.java

@@ -13,6 +13,8 @@
 import com.onesignal.OSOutcomeEvent;
 import com.onesignal.OSPermissionState;
 import com.onesignal.OSPermissionStateChanges;
+import com.onesignal.OSSMSSubscriptionState;
+import com.onesignal.OSSMSSubscriptionStateChanges;
 import com.onesignal.OSSubscriptionState;
 import com.onesignal.OSSubscriptionStateChanges;
 import com.onesignal.OSOutcomeEvent;
@@ -56,6 +58,16 @@ private static HashMap<String, Object> convertEmailSubscriptionStateToMap(OSEmai
         return hash;
     }
 
+    private static HashMap<String, Object> convertSMSSubscriptionStateToMap(OSSMSSubscriptionState state) {
+        HashMap<String, Object> hash = new HashMap<>();
+
+        hash.put("smsUserId", state.getSMSNumber());
+        hash.put("smsNumber", state.getSMSNumber());
+        hash.put("isSubscribed", state.isSubscribed());
+
+        return hash;
+    }
+
     static HashMap<String, Object> convertDeviceStateToMap(OSDeviceState state) {
         HashMap<String, Object> hash = new HashMap<>();
 
@@ -92,6 +104,15 @@ static HashMap<String, Object> convertEmailSubscriptionStateChangesToMap(OSEmail
         return hash;
     }
 
+    static HashMap<String, Object> convertSMSSubscriptionStateChangesToMap(OSSMSSubscriptionStateChanges changes) {
+        HashMap<String, Object> hash = new HashMap<>();
+
+        hash.put("to", convertSMSSubscriptionStateToMap(changes.getTo()));
+        hash.put("from", convertSMSSubscriptionStateToMap(changes.getFrom()));
+
+        return hash;
+    }
+
     static HashMap convertPermissionStateChangesToMap(OSPermissionStateChanges changes) {
         HashMap<String, Object> hash = new HashMap<>();
 

example/lib/main.dart

@@ -78,6 +78,11 @@ class _MyAppState extends State<MyApp> {
       print("EMAIL SUBSCRIPTION STATE CHANGED ${changes.jsonRepresentation()}");
     });
 
+    OneSignal.shared.setSMSSubscriptionObserver(
+        (OSSMSSubscriptionStateChanges changes) {
+      print("SMS SUBSCRIPTION STATE CHANGED ${changes.jsonRepresentation()}");
+    });
+
     // NOTE: Replace with your own app ID from https://www.onesignal.com
     await OneSignal.shared
         .setAppId("380dc082-5231-4cc2-ab51-a03da5a0e4c2");

ios/Classes/OneSignalPlugin.m

@@ -99,6 +99,7 @@ - (void)addObservers {
     [OneSignal addSubscriptionObserver:self];
     [OneSignal addPermissionObserver:self];
     [OneSignal addEmailSubscriptionObserver:self];
+    [OneSignal addSMSSubscriptionObserver:self];
     [OneSignal setNotificationWillShowInForegroundHandler:^(OSNotification *notification, OSNotificationDisplayResponse completion) {
         [OneSignalPlugin.sharedInstance handleNotificationWillShowInForeground:notification completion:completion];
     }];
@@ -399,4 +400,9 @@ - (void)onOSEmailSubscriptionChanged:(OSEmailSubscriptionStateChanges *)stateCha
     [self.channel invokeMethod:@"OneSignal#emailSubscriptionChanged" arguments:stateChanges.toDictionary];
 }
 
+#pragma mark OSSMSSubscriptionObserver
+- (void)onOSSMSSubscriptionChanged:(OSSMSSubscriptionStateChanges *)stateChanges {
+    [self.channel invokeMethod:@"OneSignal#smsSubscriptionChanged" arguments:stateChanges.toDictionary];
+}
+
 @end

lib/onesignal_flutter.dart

@@ -22,6 +22,7 @@ typedef void ReceivedNotificationHandler(OSNotification notification);
 typedef void OpenedNotificationHandler(OSNotificationOpenedResult openedResult);
 typedef void SubscriptionChangedHandler(OSSubscriptionStateChanges changes);
 typedef void EmailSubscriptionChangeHandler(OSEmailSubscriptionStateChanges changes);
+typedef void SMSSubscriptionChangeHandler(OSSMSSubscriptionStateChanges changes);
 typedef void PermissionChangeHandler(OSPermissionStateChanges changes);
 typedef void InAppMessageClickedHandler(OSInAppMessageAction action);
 typedef void NotificationWillShowInForegroundHandler(OSNotificationReceivedEvent event);
@@ -43,6 +44,7 @@ class OneSignal {
   OpenedNotificationHandler? _onOpenedNotification;
   SubscriptionChangedHandler? _onSubscriptionChangedHandler;
   EmailSubscriptionChangeHandler? _onEmailSubscriptionChangedHandler;
+  SMSSubscriptionChangeHandler? _onSMSSubscriptionChangedHandler;
   PermissionChangeHandler? _onPermissionChangedHandler;
   InAppMessageClickedHandler? _onInAppMessageClickedHandler;
   NotificationWillShowInForegroundHandler? _onNotificationWillShowInForegroundHandler;
@@ -98,6 +100,13 @@ class OneSignal {
     _onEmailSubscriptionChangedHandler = handler;
   }
 
+  /// The SMS subscription handler will be called whenever the user's SMS
+  /// subscription changes (OneSignal can also send SMSs in addition to push
+  /// notifications). For example, if you call setSMSNumber() or logoutSMSNumber().
+  void setSMSSubscriptionObserver(SMSSubscriptionChangeHandler handler) {
+    _onSMSSubscriptionChangedHandler = 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) {
@@ -405,6 +414,10 @@ class OneSignal {
         this._onEmailSubscriptionChangedHandler != null) {
       this._onEmailSubscriptionChangedHandler!(
           OSEmailSubscriptionStateChanges(call.arguments.cast<String, dynamic>()));
+    } else if (call.method == 'OneSignal#smsSubscriptionChanged' &&
+        this._onSMSSubscriptionChangedHandler != null) {
+      this._onSMSSubscriptionChangedHandler!(
+          OSSMSSubscriptionStateChanges(call.arguments.cast<String, dynamic>()));
     } else if (call.method == 'OneSignal#handleClickedInAppMessage' &&
         this._onInAppMessageClickedHandler != null) {
       this._onInAppMessageClickedHandler!(

lib/src/subscription.dart

@@ -105,3 +105,50 @@ class OSEmailSubscriptionStateChanges extends JSONStringRepresentable {
     });
   }
 }
+
+/// Represents the user's OneSignal SMS subscription state,
+class OSSMSSubscriptionState extends JSONStringRepresentable {
+  bool subscribed = false;
+  String? smsUserId;
+  String? smsNumber;
+
+  OSSMSSubscriptionState(Map<String, dynamic> json) {
+    this.subscribed = false;
+    if (json.containsKey('smsNumber') && json['smsNumber'] != null)
+      this.smsNumber = json['smsNumber'] as String?;
+
+    if (json.containsKey('smsUserId') && json['smsUserId'] != null) {
+      this.smsUserId = json['smsUserId'] as String?;
+      this.subscribed = true;
+    }
+  }
+
+  String jsonRepresentation() {
+    return convertToJsonString({
+      'subscribed': this.subscribed,
+      'smsUserId': this.smsUserId,
+      'smsNumber': this.smsNumber
+    });
+  }
+}
+
+/// An instance of this class describes a change in the user's
+/// email subscription state with OneSignal
+class OSSMSSubscriptionStateChanges extends JSONStringRepresentable {
+  late OSSMSSubscriptionState from;
+  late OSSMSSubscriptionState to;
+
+  OSSMSSubscriptionStateChanges(Map<String, dynamic> json) {
+    if (json.containsKey('from'))
+      this.from = OSSMSSubscriptionState(json['from'].cast<String, dynamic>());
+    if (json.containsKey('to'))
+      this.to = OSSMSSubscriptionState(json['to'].cast<String, dynamic>());
+  }
+
+  String jsonRepresentation() {
+    return convertToJsonString(<String, dynamic>{
+      'from': this.from.jsonRepresentation(),
+      'to': this.to.jsonRepresentation()
+    });
+  }
+}