Merge branch 'master' of https://github.com/pedro-lb/react-onesignal

Author: pedro-lb

README.md

@@ -158,6 +158,22 @@ const events = [
 ReactOneSignal.initialize(applicationId, options, events);
 ```
 
+### OneSignal Tags and Audience Segmenting
+
+You can use `sendTag` and `sendTags` to set OneSignal tags for segment filtering.
+```js
+// Send a tag to OneSignal for the current player
+OneSignal.sendTag('tag', 'tagValue');
+
+// Send multiple tags to OneSignal for the current player
+const keyValues = {
+  'tag1': 'value1',
+  'tag2': 'value2',
+  'tag3': 'value3',
+};
+OneSignal.sendTags(keyValues);
+```
+
 ## Contributing
 
 Pull requests are welcome! If you have any feedback, issue or suggestion, feel free to open [a new issue](https://github.com/pedro-lb/react-onesignal/issues/new) so we can talk about it 💬.

package/src/oneSignal.ts

@@ -342,6 +342,51 @@ const getExternalUserId = () => new Promise<string>((resolve, reject) => {
   }
 });
 
+/**
+ * Sets a key/value "tag" pair on OneSignal.
+ *
+ * @param key string
+ * @param val string
+ */
+const sendTag = (key: string, val: string) => new Promise<string>((resolve, reject) => {
+  const oneSignal = getOneSignalInstance();
+
+  if (!oneSignal) {
+    reject();
+    return;
+  }
+
+  try {
+    oneSignal.sendTag(key, val)
+      .then((value) => resolve(value))
+      .catch((error) => reject(error));
+  } catch (error) {
+    reject(error);
+  }
+});
+
+/**
+ * Sets a collection of key/value "tag" pairs on OneSignal.
+ *
+ * @param keyValues obj
+ */
+const sendTags = (keyValues: object) => new Promise<string>((resolve, reject) => {
+  const oneSignal = getOneSignalInstance();
+
+  if (!oneSignal) {
+    reject();
+    return;
+  }
+
+  try {
+    oneSignal.sendTags(keyValues)
+      .then((value) => resolve(value))
+      .catch((error) => reject(error));
+  } catch (error) {
+    reject(error);
+  }
+});
+
 /**
  * Object for manipulating OneSignal.
  */
@@ -355,6 +400,8 @@ const ReactOneSignal = {
   getPlayerId,
   setExternalUserId,
   getExternalUserId,
+  sendTag,
+  sendTags,
 };
 
 export default ReactOneSignal;

package/src/oneSignal.types.ts

@@ -8,6 +8,8 @@ export interface IOneSignal {
   setExternalUserId: (externalUserId: string | number) => Promise<void>,
   getExternalUserId: () => Promise<any>,
   initialized: boolean,
+  sendTag: (key: string, val: string) => Promise<string>;
+  sendTags: (keyValues: object) => Promise<any>;
 }
 
 export interface OneSignalOptions {