Add SMS integration

Jeasmine · Jeasmine · commit 34423f8bacf6 · 2021-06-04T17:48:33.000-03:00
* Add setSMSNumber and logoutSMSNumber methods
* Add example app SMS Number input and buttons
diff --git a/android/src/main/java/com/onesignal/flutter/OneSignalPlugin.java b/android/src/main/java/com/onesignal/flutter/OneSignalPlugin.java
@@ -109,6 +109,10 @@ else if (call.method.contentEquals("OneSignal#setEmail"))
       this.setEmail(call, result);
     else if (call.method.contentEquals("OneSignal#logoutEmail"))
       this.logoutEmail(result);
+    else if (call.method.contentEquals("OneSignal#setSMSNumber"))
+      this.setSMSNumber(call, result);
+    else if (call.method.contentEquals("OneSignal#logoutSMSNumber"))
+      this.logoutSMSNumber(result);
     else if (call.method.contentEquals("OneSignal#setExternalUserId"))
       this.setExternalUserId(call, result);
     else if (call.method.contentEquals("OneSignal#removeExternalUserId"))
@@ -284,6 +288,51 @@ public void onFailure(EmailUpdateError error) {
     });
   }
 
+  private void setSMSNumber(MethodCall call, final Result reply) {
+    String smsNumber = call.argument("smsNumber");
+    String smsAuthHashToken = call.argument("smsAuthHashToken");
+
+    OneSignal.setSMSNumber(smsNumber, smsAuthHashToken, new OneSignal.OSSMSUpdateHandler() {
+      @Override
+      public void onSuccess(JSONObject result) {
+        try {
+          replySuccess(reply, OneSignalSerializer.convertJSONObjectToHashMap(result));
+        } catch (JSONException e) {
+          OneSignal.onesignalLog(OneSignal.LOG_LEVEL.ERROR,
+                  "Encountered an error attempting to deserialize server response for setSMSNumber: " + e.getMessage());
+        }
+      }
+
+      @Override
+      public void onFailure(OneSignal.OSSMSUpdateError error) {
+        replyError(reply, "OneSignal",
+                "Encountered an error setting SMS Number: " + error.getMessage(),
+                null);
+      }
+    });
+  }
+
+  private void logoutSMSNumber(final Result reply) {
+    OneSignal.logoutSMSNumber(new OneSignal.OSSMSUpdateHandler() {
+      @Override
+      public void onSuccess(JSONObject result) {
+        try {
+          replySuccess(reply, OneSignalSerializer.convertJSONObjectToHashMap(result));
+        } catch (JSONException e) {
+          OneSignal.onesignalLog(OneSignal.LOG_LEVEL.ERROR,
+                  "Encountered an error attempting to deserialize server response for logoutSMSNumber: " + e.getMessage());
+        }
+      }
+
+      @Override
+      public void onFailure(OneSignal.OSSMSUpdateError error) {
+        replyError(reply, "OneSignal",
+                "Encountered an error logging out SMS number: " + error.getMessage(),
+                null);
+      }
+    });
+  }
+
   private void setExternalUserId(MethodCall call, final Result result) {
     String externalUserId = call.argument("externalUserId");
     String authHashToken = call.argument("authHashToken");
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -14,6 +14,7 @@ class MyApp extends StatefulWidget {
 class _MyAppState extends State<MyApp> {
   String _debugLabelString = "";
   String? _emailAddress;
+  String? _smsNumber;
   String? _externalUserId;
   bool _enableConsentButton = false;
 
@@ -161,13 +162,36 @@ class _MyAppState extends State<MyApp> {
 
   void _handleLogoutEmail() {
     print("Logging out of email");
+
     OneSignal.shared.logoutEmail().then((v) {
       print("Successfully logged out of email");
     }).catchError((error) {
       print("Failed to log out of email: $error");
     });
   }
 
+    void _handleSetSMSNumber() {
+    if (_smsNumber == null) return;
+
+    print("Setting SMS Number");
+
+    OneSignal.shared.setSMSNumber(smsNumber: _smsNumber!).then((response) {
+      print("Successfully set SMSNumber with response $response");
+    }).catchError((error) {
+      print("Failed to set SMS Number with error: $error");
+    });
+  }
+
+  void _handleLogoutSMSNumber() {
+    print("Logging out of smsNumber");
+
+    OneSignal.shared.logoutSMSNumber().then((response) {
+      print("Successfully logoutEmail with response $response");
+    }).catchError((error) {
+      print("Failed to log out of SMSNumber: $error");
+    });
+  }
+
   void _handleConsent() {
     print("Setting consent to true");
     OneSignal.shared.consentGranted(true);
@@ -386,6 +410,34 @@ class _MyAppState extends State<MyApp> {
                     new OneSignalButton("Logout Email", _handleLogoutEmail,
                         !_enableConsentButton)
                   ]),
+                  new TableRow(children: [
+                    new TextField(
+                      textAlign: TextAlign.center,
+                      decoration: InputDecoration(
+                          hintText: "SMS Number",
+                          labelStyle: TextStyle(
+                            color: Color.fromARGB(255, 212, 86, 83),
+                          )),
+                      onChanged: (text) {
+                        this.setState(() {
+                          _smsNumber = text == "" ? null : text;
+                        });
+                      },
+                    )
+                  ]),
+                  new TableRow(children: [
+                    Container(
+                      height: 8.0,
+                    )
+                  ]),
+                  new TableRow(children: [
+                    new OneSignalButton(
+                        "Set SMS Number", _handleSetSMSNumber, !_enableConsentButton)
+                  ]),
+                  new TableRow(children: [
+                    new OneSignalButton("Logout SMS Number", _handleLogoutSMSNumber,
+                        !_enableConsentButton)
+                  ]),
                   new TableRow(children: [
                     new OneSignalButton("Provide GDPR Consent", _handleConsent,
                         _enableConsentButton)
diff --git a/ios/Classes/OneSignalPlugin.m b/ios/Classes/OneSignalPlugin.m
@@ -133,6 +133,10 @@ - (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#setSMSNumber" isEqualToString:call.method])
+        [self setSMSNumber:call withResult:result];
+    else if ([@"OneSignal#logoutSMSNumber" isEqualToString:call.method])
+        [self logoutSMSNumber:call withResult:result];
     else if ([@"OneSignal#setExternalUserId" isEqualToString:call.method])
         [self setExternalUserId:call withResult:result];
     else if ([@"OneSignal#removeExternalUserId" isEqualToString:call.method])
@@ -265,6 +269,28 @@ - (void)logoutEmail:(FlutterMethodCall *)call withResult:(FlutterResult)result {
     }];
 }
 
+- (void)setSMSNumber:(FlutterMethodCall *)call withResult:(FlutterResult)result {
+    NSString *smsNumber = call.arguments[@"smsNumber"];
+    NSString *smsAuthHashToken = call.arguments[@"smsAuthHashToken"];
+
+    if ([smsAuthHashToken isKindOfClass:[NSNull class]])
+        smsAuthHashToken = nil;
+
+    [OneSignal setSMSNumber:smsNumber withSMSAuthHashToken:smsAuthHashToken withSuccess:^(NSDictionary *results){
+        result(results);
+    } withFailure:^(NSError *error) {
+        result(error.flutterError);
+    }];
+}
+
+- (void)logoutSMSNumber:(FlutterMethodCall *)call withResult:(FlutterResult)result {
+    [OneSignal logoutSMSNumberWithSuccess:^(NSDictionary *results){
+        result(results);
+    } withFailure:^(NSError *error) {
+        result(error.flutterError);
+    }];
+}
+
 - (void)setExternalUserId:(FlutterMethodCall *)call withResult:(FlutterResult)result {
     id externalId = call.arguments[@"externalUserId"];
     id authHashToken = call.arguments[@"authHashToken"];
diff --git a/lib/onesignal_flutter.dart b/lib/onesignal_flutter.dart
@@ -285,6 +285,25 @@ class OneSignal {
     return await _channel.invokeMethod("OneSignal#logoutEmail");
   }
 
+  /// Sets the user's SMS number so you can send them SMSs through the OneSignal dashboard
+  /// and API. The `smsAuthHashToken` is optional (but highly recommended) as part of
+  /// Identity Verification. The SMS auth hash is a hash of your app's API key and the
+  /// user ID. We recommend you generate this token from your backend server, do NOT
+  /// store your API key in your app as this is highly insecure.
+  Future<Map<String, dynamic>> setSMSNumber({required String smsNumber, String? smsAuthHashToken}) async {
+    Map<dynamic, dynamic> results =
+        await _channel.invokeMethod("OneSignal#setSMSNumber", {'smsNumber': smsNumber, 'smsAuthHashToken': smsAuthHashToken});
+    return results.cast<String, dynamic>();
+  }
+
+  /// Dissociates the user's SMS number from OneSignal, akin to turning off push notifications
+  /// for SMS number.
+  Future<Map<String, dynamic>> logoutSMSNumber() async {
+    Map<dynamic, dynamic> results =
+        await _channel.invokeMethod("OneSignal#logoutSMSNumber");
+    return results.cast<String, dynamic>();
+  }
+
   /// OneSignal allows you to set a custom ID for your users. This makes it so that
   /// if your app has its own user ID's, you can use your own custom user ID's with
   /// our API instead of having to save their OneSignal user ID's.
