Add getTags method

OneSignal · Nov 17, 2023 · 7db3f30 · 7db3f30
1 parent 1fbcdc8
commit 7db3f30
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 0 deletions.
diff --git a/MIGRATION_GUIDE.md b/MIGRATION_GUIDE.md
@@ -168,6 +168,7 @@ All user functions are synchronous.
 | `addTags`       | Adds multiple tags for the current user.       | `tags: { [key: string]: string }`    |
 | `removeTag`     | Removes a tag for the current user.            | `key: string`                        |
 | `removeTags`    | Removes multiple tags for the current user.    | `keys: string[]`                     |
+| `getTags`       | Gets the current user's tags.                  |                                      |
 
 ### Notifications Namespace
 

diff --git a/api.json b/api.json
@@ -450,6 +450,12 @@
           }
         ],
         "returnType": "void"
+      },
+      {
+        "name": "getTags",
+        "isAsync": false,
+        "args": [],
+        "returnType": "{ [key: string]: string }"
       }
     ],
     "namespaces": ["PushSubscription"]

diff --git a/src/onesignal/User.ts b/src/onesignal/User.ts
@@ -335,4 +335,10 @@ export default class User {
       propertiesModel?.set('tags', tagsCopy);
     }
   }
+
+  public getTags(): { [key: string]: string } {
+    logMethodCall('getTags');
+
+    return OneSignal.coreDirector.getPropertiesModel()?.data?.tags;
+  }
 }
diff --git a/src/onesignal/UserNamespace.ts b/src/onesignal/UserNamespace.ts
@@ -70,4 +70,8 @@ export default class UserNamespace {
   public removeTags(keys: string[]): void {
     this._currentUser?.removeTags(keys);
   }
+
+  public getTags(): { [key: string]: string } {
+    return this._currentUser?.getTags() ? this._currentUser.getTags() : {};
+  }
 }