Merge pull request #804 from OneSignal/feat/getTags

[Feature] Get tags

Author: shepherd-l

MIGRATION_GUIDE.md

@@ -221,7 +221,7 @@ The User name space is accessible via `OneSignal.User` and provides access to us
 | `OneSignal.User.addTags({"KEY_01": "VALUE_01", "KEY_02": "VALUE_02"});` | *Add multiple tags for the current user. Tags are key:value pairs used as building blocks for targeting specific users and/or personalizing messages. If the tag key already exists, it will be replaced with the value provided here.* |
 | `OneSignal.User.removeTag("KEY");` | *Remove the data tag with the provided key from the current user.* |
 | `OneSignal.User.removeTags(["KEY_01", "KEY_02"]);` | *Remove multiple tags with the provided keys from the current user.* |
-
+| `OneSignal.User.getTags();` | *Returns the local tags for the current user.* |
 
 
 ## Push Subscription Namespace

android/build.gradle

@@ -38,5 +38,5 @@ android {
 }
 
 dependencies {
-    implementation 'com.onesignal:OneSignal:5.0.4'
+    implementation 'com.onesignal:OneSignal:5.0.5'
 }

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

@@ -48,6 +48,8 @@ else if (call.method.contentEquals("OneSignal#addTags"))
             this.addTags(call, result);
         else if (call.method.contentEquals("OneSignal#removeTags"))
             this.removeTags(call, result);
+        else if (call.method.contentEquals("OneSignal#getTags"))
+            this.getTags(call, result);
         else
             replyNotImplemented(result);
     }
@@ -124,4 +126,8 @@ private void removeTags(MethodCall call, Result result) {
             replyError(result, "OneSignal", "deleteTags failed with error: " + e.getMessage() + "\n" + e.getStackTrace(), null);
         }
     }
+
+    private void getTags(MethodCall call, Result result) {
+        replySuccess(result, OneSignal.getUser().getTags());
+    }
 }

example/lib/main.dart

@@ -140,6 +140,13 @@ class _MyAppState extends State<MyApp> {
     OneSignal.User.removeTags(['test']);
   }
 
+  void _handleGetTags() async {
+    print("Get tags");
+
+    var tags = await OneSignal.User.getTags();
+    print(tags);
+  }
+
   void _handlePromptForPushPermission() {
     print("Prompting for Permission");
     OneSignal.Notifications.requestPermission(true);
@@ -270,6 +277,10 @@ class _MyAppState extends State<MyApp> {
                     new OneSignalButton(
                         "Send Tags", _handleSendTags, !_enableConsentButton)
                   ]),
+                  new TableRow(children: [
+                    new OneSignalButton(
+                        "Get Tags", _handleGetTags, !_enableConsentButton)
+                  ]),
                   new TableRow(children: [
                     new OneSignalButton("Prompt for Push Permission",
                         _handlePromptForPushPermission, !_enableConsentButton)

ios/Classes/OSFlutterUser.m

@@ -55,6 +55,8 @@ - (void)handleMethodCall:(FlutterMethodCall*)call result:(FlutterResult)result {
         [self addTags:call withResult:result];
     else if ([@"OneSignal#removeTags" isEqualToString:call.method])
         [self removeTags:call withResult:result];
+    else if ([@"OneSignal#getTags" isEqualToString:call.method])
+        [self getTags:call withResult:result];
     else if ([@"OneSignal#addEmail" isEqualToString:call.method])
         [self addEmail:call withResult:result];
     else if ([@"OneSignal#removeEmail" isEqualToString:call.method])
@@ -102,6 +104,10 @@ - (void)removeTags:(FlutterMethodCall *)call withResult:(FlutterResult)result {
     result(nil);
 }
 
+- (void)getTags:(FlutterMethodCall *)call withResult:(FlutterResult)result {
+    result([OneSignal.User getTags]);
+}
+
 - (void)addEmail:(FlutterMethodCall *)call withResult:(FlutterResult)result {
     NSString *email = call.arguments;
     [OneSignal.User addEmail:email];

ios/onesignal_flutter.podspec

@@ -13,7 +13,7 @@ Pod::Spec.new do |s|
   s.source_files = 'Classes/**/*'
   s.public_header_files = 'Classes/**/*.h'
   s.dependency 'Flutter'
-  s.dependency 'OneSignalXCFramework', '5.0.4'
+  s.dependency 'OneSignalXCFramework', '5.0.5'
   s.ios.deployment_target = '11.0'
   s.static_framework = true
 end

lib/src/user.dart

@@ -77,6 +77,13 @@ class OneSignalUser {
     return await _channel.invokeMethod("OneSignal#removeTags", tags);
   }
 
+  /// Returns the local tags of the current user.
+  Future<Map<String, String>> getTags() async {
+    Map<dynamic, dynamic> tags =
+        await _channel.invokeMethod("OneSignal#getTags");
+    return tags.cast<String, String>();
+  }
+
   /// Add a new [email] subscription to the current user.
   Future<void> addEmail(String email) async {
     return await _channel.invokeMethod("OneSignal#addEmail", email);