clevertap-react-native 0.5.1 → 0.8.0

package/docs/usage.md

@@ -1,40 +1,397 @@
 
-## Example JS Usage
+## Example Usage
+
 #### Grab a reference  
 ```javascript 
 const CleverTap = require('clevertap-react-native');
 ```
 
+## User Profiles
+
+#### Update User Profile(Push Profile)
+
+```javascript 
+CleverTap.profileSet({"Identity":11102008, "Name":"React-Test Profile","Email":"r@gmail.com","Gender":"Male","DOB":"1995-10-14", "custom":1.73});
+```
+
+#### Set Multi Values For Key 
+
+```javascript 
+CleverTap.profileSetMultiValuesForKey(['a', 'b', 'c'], 'letters');
+```
+
+#### Remove Multi Value For Key 
+
+```javascript 
+CleverTap.profileRemoveMultiValueForKey('b', 'letters');
+```
+
+#### Add Multi Value For Key
+
+```javascript 
+CleverTap.profileAddMultiValueForKey('d', 'letters');
+```
+
+#### Create a User profile when user logs in (On User Login)
+
+```javascript 
+CleverTap.onUserLogin({'Name': 'React-Test', 'Identity': '11102008', 'Email': 'r@gmail.com', 'custom1': 43});
+```
+
+#### Get CleverTap Reference id
+
+```javascript
+CleverTap.profileGetCleverTapID((err, res) => {
+         console.log('CleverTapID', res, err);
+});
+```
+
+#### Set Location to User Profile
+
+```javascript 
+CleverTap.setLocation(34.15, -118.20);
+```
+
+#### Increment a User Profile property
+
+```javascript 
+CleverTap.profileIncrementValueForKey(1, "score");
+```
+
+#### Decrement a User Profile property
+
+```javascript 
+CleverTap.profileDecrementValueForKey(1, "score");
+```
+
+-----------
+
+## User Events
+
 #### Record an event  
+
 ```javascript 
 CleverTap.recordEvent('testEvent');
 ```
 
 #### Record Charged event
+
 ```javascript 
 CleverTap.recordChargedEvent({'totalValue': 20, 'category': 'books'}, [{'title': 'book1'}, {'title': 'book2'}, {'title': 'book3'}]);
 ```
 
-#### Update a user profile 
-```javascript 
-CleverTap.onUserLogin({'Name': 'testUserA1', 'Identity': '123456', 'Email': 'test@test.com', 'custom1': 123});
-```
+-----------
 
-#### App Inbox
+## App Inbox
+
+#### Initialize the CleverTap App Inbox Method
 
-##### Initialize the CleverTap App Inbox Method
 ```javascript 
 CleverTap.initializeInbox();
 ```
 
-##### Show the App Inbox
+#### Show the App Inbox
+
 ```javascript
 CleverTap.showInbox({'tabs':['Offers','Promotions'],'navBarTitle':'My App Inbox','navBarTitleColor':'#FF0000','navBarColor':'#FFFFFF','inboxBackgroundColor':'#AED6F1','backButtonColor':'#00FF00'
                                 ,'unselectedTabColor':'#0000FF','selectedTabColor':'#FF0000','selectedTabIndicatorColor':'#000000',
                                 'noMessageText':'No message(s)','noMessageTextColor':'#FF0000'});
  ```
 
+#### Get Total message count
+
+```javascript 
+CleverTap.getInboxMessageCount((err, res) => {
+	console.log('Total Messages: ', res, err);
+});	
+```
+
+#### Get Total message count
+
+```javascript 
+CleverTap.getInboxMessageUnreadCount((err, res) => {
+	console.log('Unread Messages: ', res, err);
+});	
+```
+
+#### Get All Inbox Messages
+
+```javascript 
+CleverTap.getAllInboxMessages((err, res) => {
+	console.log('All Inbox Messages: ', res, err);
+});	
+```
+
+#### Get all Inbox unread messages
+
+```javascript 
+CleverTap.getUnreadInboxMessages((err, res) => {
+	console.log('Unread Inbox Messages: ', res, err);
+});	
+```
+
+#### Get inbox Id
+
+```javascript 
+CleverTap.getInboxMessageForId('Message Id',(err, res) => {
+        console.log("marking message read = "+res);
+});			
+```
+
+#### Delete message with id
+
+```javascript 
+CleverTap.deleteInboxMessageForId('Message Id');		
+```
+
+#### Mark a message as Read for inbox Id
+
+```javascript 
+CleverTap.markReadInboxMessageForId('Message Id');		
+```
+
+#### pushInbox Notification Viewed Event For Id
+
+```javascript 
+CleverTap.pushInboxNotificationViewedEventForId('Message Id');		
+```
+
+#### push Inbox Notification Clicked Event For Id
+
+```javascript 
+CleverTap.pushInboxNotificationClickedEventForId('Message Id');			
+```
+
+-----------
+
+## Push Notifications
+
+#### Creating Notification Channel
+
+```javascript 
+CleverTap.createNotificationChannel("CtRNS", "Clever Tap React Native Testing", "CT React Native Testing", 1, true);			
+```
+
+#### Delete Notification Channel
+
+```javascript 
+CleverTap.deleteNotificationChannel("RNTesting");		
+```
+
+#### Creating a group notification channel
+
+```javascript 
+CleverTap.createNotificationChannelGroup(String groupId, String groupName);		
+```
+
+#### Delete a group notification channel
+
+```javascript 
+CleverTap.deleteNotificationChannelGroup(String groupId);			
+```
+
+#### Registering Fcm Token
+
+```javascript 
+CleverTap.setPushToken("<Replace with FCM Token value>", CleverTap.FCM);
+```
+
+-----------
+ 
+## Native Display
+
+#### Get Display Unit for Id
+
+```javascript 
+CleverTap.getDisplayUnitForId('Unit Id', (err, res) => {
+        console.log('Get Display Unit for Id:', res, err);
+});
+```
+
+#### Get All Display Units
+
+```javascript 
+CleverTap.getAllDisplayUnits((err, res) => {
+        console.log('All Display Units: ', res, err);
+});
+```
+
+-----------
+
+## Product Config 
+
+#### Set Product Configuration to default
+
+```javascript 
+CleverTap.setDefaultsMap({'text_color': 'red', 'msg_count': 100, 'price': 100.50, 'is_shown': true, 'json': '{"key":"val"}'});
+```
+
+#### Fetching product configs
+
+```javascript 
+CleverTap.fetch();
+```
+
+#### Activate the most recently fetched product config
+
+```javascript 
+CleverTap.activate();
+```
+
+#### Fetch And Activate product config
+
+```javascript 
+CleverTap.fetchAndActivate();
+```
+
+#### Fetch Minimum Time Interval
+
+```javascript 
+CleverTap.fetchWithMinimumIntervalInSeconds(60);
+```
+
+#### Set Minimum Time Interval for Fetch 
+
+```javascript 
+CleverTap.setMinimumFetchIntervalInSeconds(60);
+```
+
+#### Get Boolean key
+
+```javascript 
+CleverTap.getProductConfigBoolean('is_shown', (err, res) => {
+	console.log('PC is_shown val in boolean :', res, err);
+});
+```
+#### Get Long
+
+```javascript 
+CleverTap.getNumber('msg_count', (err, res) => {
+	console.log('PC is_shown val in number(long)  :', res, err);
+});
+```
+#### Get Double
+
+```javascript 
+CleverTap.getNumber('price', (err, res) => {
+	console.log('PC price val in number :', res, err);
+});		
+```
+#### Get String
+
+```javascript 
+CleverTap.getProductConfigString('text_color', (err, res) => {
+        console.log('PC text_color val in string :', res, err);
+});	
+```
+#### Get String (JSON)
+
+```javascript 
+CleverTap.getProductConfigString('json', (err, res) => {
+	console.log('PC json val in string :', res, err);
+});	
+```
+
+#### Delete all activated, fetched and defaults configs
+
+```javascript 
+CleverTap.resetProductConfig();
+```
+
+#### Get last fetched timestamp in millis
+
+```javascript 
+CleverTap.getLastFetchTimeStampInMillis((err, res) => {
+        console.log('LastFetchTimeStampInMillis in string: ', res, err);
+});		
+```
+
+## Feature Flag
+
+#### Get Feature Flag
+
+```javascript 
+CleverTap.getFeatureFlag('is_dark_mode', false, (err, res) => {
+	console.log('FF is_dark_mode val in boolean :', res, err);
+});
+```
+
+## CleverTap ID
+
+#### Get CleverTap ID
+
+```javascript 
+CleverTap.getCleverTapID((err, res) => {
+        console.log('CleverTapID', res, err);
+});
+```
+
+-----------
+
+## App Personalisation
+
+#### Enable Personalization
+
+```javascript 
+CleverTap.enablePersonalization();		
+```
+
+#### Disable Personalization
+
+```javascript 
+CleverTap.disablePersonalization();
+```
+
+#### Get Profile Name
+
+```javascript 
+CleverTap.profileGetProperty('Name', (err, res) => {
+	console.log('CleverTap Profile Name: ', res, err);
+});
+```
+
+-----------
+
+## Debugging
+
+```javascript 
+CleverTap.setDebugLevel(3);
+```
+
+## Attributions
+
+#### Get CleverTap Attribution Identifier
+
+```javascript 
+CleverTap.profileGetCleverTapAttributionIdentifier((err, res) => {
+         console.log('CleverTapAttributionIdentifier', res, err);
+});
+```
+
+-----------
+
+## InApp Notification Controls
+
+#### Suspend InApp Notifications
+
+```javascript 
+CleverTap.suspendInAppNotifications();
+```
+
+#### Discard InApp Notifications
+
+```javascript 
+CleverTap.discardInAppNotifications();
+```
+
+#### Resume InApp Notifications
+
+```javascript 
+CleverTap.resumeInAppNotifications();
+```
+
+
 ### For more information,
- - [see included Starter Application](https://github.com/CleverTap/clevertap-react-native/blob/master/Starter/App.js) 
- - [see CleverTap JS interface](https://github.com/CleverTap/clevertap-react-native/blob/master/index.js)
- - [see CleverTap TS interface](https://github.com/CleverTap/clevertap-react-native/blob/master/index.d.ts)
+ - [See included Example Application](/Example/App.js) 
+ - [See CleverTap JS interface](/index.js)
+ - [See CleverTap TS interface](/index.d.ts)

package/index.d.ts

@@ -274,17 +274,26 @@
   export function profileGetProperty(propertyName: string, callback: Callback): void;
 
   /**
+   * Deprecated - Since version 0.6.0. Use getCleverTapID(callback) instead
    * Get a unique CleverTap identifier suitable for use with install attribution providers.
    * calls back with unique CleverTap attribution identifier
    */
   export function profileGetCleverTapAttributionIdentifier(callback: Callback): void;
 
   /**
+   * Deprecated - Since version 0.6.0. Use getCleverTapID(callback) instead
    * Get User Profile CleverTapID
    * calls back with CleverTapID or false
    */
   export function profileGetCleverTapID(callback: Callback): void;
 
+  /**
+   * Returns a unique identifier through callback by which CleverTap identifies this user
+   *
+   * @param {function(err, res)} non-null callback to retrieve identifier
+   */
+  export function getCleverTapID(callback: Callback): void;
+
   /**
    * Remove the property specified by key from the user profile
    * @param key {string}
@@ -325,6 +334,26 @@
    */
   export function profileRemoveMultiValuesForKey(values: any, key: string): void;
 
+  /*******************************
+   * Increment/Decrement Operators
+   *******************************/
+
+   /**
+   * This method is used to increment the given value
+   *
+   * @param value {Number} can be int,double or float only (NaN,Infinity etc not supported)
+   * @param key   {string} profile property
+   */
+  export function profileIncrementValueForKey(value:number, key:string): void;
+
+  /**
+   * This method is used to decrement the given value
+   *
+   * @param value {Number} can be int,double or float only (NaN,Infinity etc not supported)
+   * @param key   {string} profile property
+   */
+  export function profileDecrementValueForKey(value:number, key:string): void;
+
   /*******************
    * Session
    ******************/
@@ -543,6 +572,37 @@
     defaultValue: boolean,
     callback: Callback): void;
 
+
+  /*******************
+   * InApp Controls
+   ******************/
+
+  /**
+   * Suspends display of InApp Notifications.
+   * The InApp Notifications are queued once this method is called
+   * and will be displayed once resumeInAppNotifications() is called.
+   */
+  export function suspendInAppNotifications(): void;
+
+  /**
+   * Suspends the display of InApp Notifications and discards any new InApp Notifications to be shown
+   * after this method is called.
+   * The InApp Notifications will be displayed only once resumeInAppNotifications() is called.
+   */
+  export function discardInAppNotifications(): void;
+
+  /**
+   * Resumes display of InApp Notifications.
+   *
+   * If suspendInAppNotifications() was called previously, calling this method will instantly show
+   * all queued InApp Notifications and also resume InApp Notifications on events raised after this
+   * method is called.
+   *
+   * If discardInAppNotifications() was called previously, calling this method will only resume
+   * InApp Notifications on events raised after this method is called.
+   */
+  export function resumeInAppNotifications(): void;
+
   /*******************
    * Developer Options
    ******************/

package/index.js

@@ -78,7 +78,7 @@ var CleverTap = {
     },
 
     /**
-    *  Deprecated - Since version 5.0.0. Use removeListener(eventName) instead
+    *  Deprecated - Since version 0.5.0. Use removeListener(eventName) instead
     *  Remove all event listeners
     */
     removeListeners: function () {
@@ -323,6 +323,7 @@ var CleverTap = {
     },
 
     /**
+     * Deprecated - Since version 0.6.0. Use getCleverTapID(callback) instead
     * Get a unique CleverTap identifier suitable for use with install attribution providers
     * @param {function(err, res)} callback that returns a string res
     */
@@ -331,6 +332,7 @@ var CleverTap = {
     },
 
     /**
+     * Deprecated - Since version 0.6.0. Use getCleverTapID(callback) instead
     * Get the user profile's CleverTap identifier value
     * @param {function(err, res)} callback that returns a string res
     */
@@ -429,6 +431,26 @@ var CleverTap = {
         CleverTapReact.profileRemoveMultiValues(values, key);
     },
 
+    /**
+    * This method is used to increment the given value
+    *
+    * @param value {Number} can be int,double or float only (NaN,Infinity etc not supported)
+    * @param key   {string} profile property
+    */
+    profileIncrementValueForKey: function (value, key) {
+        CleverTapReact.profileIncrementValueForKey(value, key);
+    },
+
+    /**
+     * This method is used to decrement the given value
+     *
+     * @param value {Number} can be int,double or float only (NaN,Infinity etc not supported)
+     * @param key   {string} profile property
+     */
+    profileDecrementValueForKey: function (value, key) {
+        CleverTapReact.profileDecrementValueForKey(value, key);
+    },
+
     /**
     * Manually track the utm app install referrer
     * @param {string} the utm referrer source
@@ -697,6 +719,47 @@ var CleverTap = {
         callWithCallback('getFeatureFlag', [name, defaultValue], callback);
     },
 
+    /**
+     * Returns a unique identifier through callback by which CleverTap identifies this user
+     *
+     * @param {function(err, res)} non-null callback to retrieve identifier
+     */
+    getCleverTapID: function (callback) {
+        callWithCallback('getCleverTapID', null, callback);
+    },
+
+    /**
+     * Suspends display of InApp Notifications.
+     * The InApp Notifications are queued once this method is called
+     * and will be displayed once resumeInAppNotifications() is called.
+     */
+    suspendInAppNotifications: function () {
+        CleverTapReact.suspendInAppNotifications();
+    },
+
+    /**
+     * Suspends the display of InApp Notifications and discards any new InApp Notifications to be shown
+     * after this method is called.
+     * The InApp Notifications will be displayed only once resumeInAppNotifications() is called.
+     */
+    discardInAppNotifications: function () {
+        CleverTapReact.discardInAppNotifications();
+    },
+
+    /**
+     * Resumes display of InApp Notifications.
+     *
+     * If suspendInAppNotifications() was called previously, calling this method will instantly show
+     * all queued InApp Notifications and also resume InApp Notifications on events raised after this
+     * method is called.
+     *
+     * If discardInAppNotifications() was called previously, calling this method will only resume
+     * InApp Notifications on events raised after this method is called.
+     */
+    resumeInAppNotifications: function () {
+        CleverTapReact.resumeInAppNotifications();
+    },
+
     /**
     * Set the SDK debug level
     * @param {int} 0 = off, 1 = on

package/ios/CleverTapReact/CleverTapReact.m

@@ -13,6 +13,7 @@
 #import "CleverTap+DisplayUnit.h"
 #import "CleverTap+FeatureFlags.h"
 #import "CleverTap+ProductConfig.h"
+#import "CleverTap+InAppNotifications.h"
 
 static NSDateFormatter *dateFormatter;
 
@@ -200,6 +201,12 @@ RCT_EXPORT_METHOD(profileGetCleverTapID:(RCTResponseSenderBlock)callback) {
     [self returnResult:result withCallback:callback andError:nil];
 }
 
+RCT_EXPORT_METHOD(getCleverTapID:(RCTResponseSenderBlock)callback) {
+    RCTLogInfo(@"[CleverTap getCleverTapID]");
+    NSString *result = [[CleverTap sharedInstance] profileGetCleverTapID];
+    [self returnResult:result withCallback:callback andError:nil];
+}
+
 RCT_EXPORT_METHOD(onUserLogin:(NSDictionary*)profile) {
     RCTLogInfo(@"[CleverTap onUserLogin: %@]", profile);
     NSDictionary *_profile = [self formatProfile:profile];
@@ -248,6 +255,15 @@ RCT_EXPORT_METHOD(profileRemoveMultiValues:(NSArray<NSString*>*)values forKey:(N
     [[CleverTap sharedInstance] profileRemoveMultiValues:values forKey:key];
 }
 
+RCT_EXPORT_METHOD(profileIncrementValueForKey:(NSNumber* _Nonnull)value forKey:(NSString* _Nonnull)key) {
+    RCTLogInfo(@"[CleverTap profileIncrementValueBy: %@ forKey: %@]", value, key);
+    [[CleverTap sharedInstance] profileIncrementValueBy:value forKey:key];
+}
+
+RCT_EXPORT_METHOD(profileDecrementValueForKey:(NSNumber* _Nonnull)value forKey:(NSString* _Nonnull)key) {
+    RCTLogInfo(@"[CleverTap profileDecrementValueBy: %@ forKey: %@]", value, key);
+    [[CleverTap sharedInstance] profileDecrementValueBy:value forKey:key];
+}
 
 #pragma mark - Session API
 
@@ -686,4 +702,21 @@ RCT_EXPORT_METHOD(reset) {
     [[[CleverTap sharedInstance] productConfig] reset];
 }
 
+#pragma mark - InApp Notification Controls
+
+RCT_EXPORT_METHOD(suspendInAppNotifications) {
+    RCTLogInfo(@"[CleverTap suspendInAppNotifications");
+    [[CleverTap sharedInstance] suspendInAppNotifications];
+}
+
+RCT_EXPORT_METHOD(discardInAppNotifications) {
+    RCTLogInfo(@"[CleverTap discardInAppNotifications");
+    [[CleverTap sharedInstance] discardInAppNotifications];
+}
+
+RCT_EXPORT_METHOD(resumeInAppNotifications) {
+    RCTLogInfo(@"[CleverTap resumeInAppNotifications");
+    [[CleverTap sharedInstance] resumeInAppNotifications];
+}
+
 @end

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clevertap-react-native",
-  "version": "0.5.1",
+  "version": "0.8.0",
   "description": "CleverTap React Native SDK.",
   "main": "index.js",
   "types": "index.d.ts",

package/ios/CleverTapReact.xcodeproj/project.xcworkspace/contents.xcworkspacedata

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Workspace
-   version = "1.0">
-   <FileRef
-      location = "self:">
-   </FileRef>
-</Workspace>

package/ios/CleverTapReact.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-	<key>IDEDidComputeMac32BitWarning</key>
-	<true/>
-</dict>
-</plist>

package/ios/CleverTapReact.xcodeproj/xcuserdata/aditi.xcuserdatad/xcdebugger/Breakpoints_v2.xcbkptlist

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Bucket
-   uuid = "1BD6870F-EA57-44A4-9956-6DD1E1A08361"
-   type = "1"
-   version = "2.0">
-</Bucket>