clevertap-react-native 3.1.0 → 3.2.0

package/src/index.d.ts

@@ -224,6 +224,8 @@ export function isPushPermissionGranted(callback: CallbackString): void;
   ): void;
 
   /**
+   * @deprecated
+   * Since version 3.2.0. Use `getUserEventLog()` instead.
    * Get Event First Time
    * @param eventName {string}
    * callback returns epoch seconds or -1
@@ -231,6 +233,8 @@ export function isPushPermissionGranted(callback: CallbackString): void;
   export function eventGetFirstTime(eventName: string, callback: Callback): void;
 
   /**
+   * @deprecated
+   * Since version 3.2.0. Use `getUserEventLog()` instead.
    * Get Event Last Time
    * @param eventName {string}
    * callback returns epoch seconds or -1
@@ -238,6 +242,8 @@ export function isPushPermissionGranted(callback: CallbackString): void;
   export function eventGetLastTime(eventName: string, callback: Callback): void;
 
   /**
+   * @deprecated
+   * Since version 3.2.0. Use `getUserEventLogCount()` instead.
    * Get Event Number of Occurrences
    * @param eventName {string}
    * calls back with int or -1
@@ -245,6 +251,9 @@ export function isPushPermissionGranted(callback: CallbackString): void;
   export function eventGetOccurrences(eventName: string, callback: Callback): void;
 
   /**
+   * @deprecated
+   * Since version 3.2.0. Use `getUserEventLog()` instead.
+   *
    * Get Event Details
    * @param eventName {string}
    * calls back with object {"eventName": <string>, "firstTime":<epoch seconds>, "lastTime": <epoch seconds>, "count": <int>} or empty object
@@ -252,10 +261,32 @@ export function isPushPermissionGranted(callback: CallbackString): void;
   export function eventGetDetail(eventName: string, callback: Callback): void;
 
   /**
+   * @deprecated
+   * Since version 3.2.0. Use `getUserEventLogHistory()` instead.
    * Get Event History
    * calls back with object {"eventName1":<event1 details object>, "eventName2":<event2 details object>}
    */
   export function getEventHistory(callback: Callback): void;
+  /**
+   *
+   * Get Event Details
+   * @param eventName {string}
+   * calls back with object {"eventName": <string>, "firstTime":<epoch seconds>, "lastTime": <epoch seconds>, "count": <int>, "deviceID": <string>, "normalizedEventName": <string>} or empty object
+   */
+  export function getUserEventLog(eventName: string, callback: Callback): void;
+    
+  /**
+   * Get count of times an event occured
+   * @param eventName {string}
+   * calls back with int or -1
+   */
+  export function getUserEventLogCount(eventName: string, callback: Callback): void;
+
+  /**
+   * Get Event History
+   * calls back with object {"eventName1":<event1 details object>, "eventName2":<event2 details object>}
+   */
+  export function getUserEventLogHistory(callback: Callback): void;
 
   /**
    * Set location
@@ -395,11 +426,25 @@ export function isPushPermissionGranted(callback: CallbackString): void;
   export function sessionGetTimeElapsed(callback: Callback): void;
 
   /**
-   * Get Session Total Visits
+   * Get timestamp of user's last app visit
+   * calls back with epoch seconds or -1
+   */
+  export function getUserLastVisitTs(callback: Callback): void;
+
+  /**
+   * Get total number of times user has lanched the app
    * calls back with int or -1
    */
-  export function sessionGetTotalVisits(callback: Callback): void;
+  export function getUserAppLaunchCount(callback: Callback): void;
 
+  /**
+   * @deprecated
+   * Since version 3.2.0. Use `getUserAppLaunchCount()` instead.
+   * Get Session Total Visits
+   * calls back with int or -1
+   */
+    export function sessionGetTotalVisits(callback: Callback): void;
+  
   /**
    * Get Session Screen Count
    * calls back with with int
@@ -407,6 +452,8 @@ export function isPushPermissionGranted(callback: CallbackString): void;
   export function sessionGetScreenCount(callback: Callback): void;
 
   /**
+   * @deprecated
+   * Since version 3.2.0. Use `getUserLastVisits()` instead.
    * Get Session Previous Visit Time
    * calls back with epoch seconds or -1
    */

package/src/index.js

@@ -12,7 +12,7 @@ const EventEmitter = Platform.select({
 * @param {int} libVersion - The updated library version. If current version is 1.1.0 then pass as 10100  
 */
 const libName = 'React-Native';
-const libVersion = 30100;
+const libVersion = 30200;
 CleverTapReact.setLibrary(libName,libVersion);
 
 function defaultCallback(method, err, res) {
@@ -338,6 +338,7 @@ var CleverTap = {
 
     /**
     * Get the time of the first occurrence of an event
+    * @deprecated - Since version 3.2.0. Use getUserEventLog() instead
     * @param {string} eventName - the name of the event
     * @param {function(err, res)} callback that returns a res of epoch seconds or -1
     */
@@ -347,6 +348,7 @@ var CleverTap = {
 
     /**
     * Get the time of the most recent occurrence of an event
+    * @deprecated - Since version 3.2.0. Use getUserEventLog() instead
     * @param {string} eventName - the name of the event
     * @param {function(err, res)} callback that returns a res of epoch seconds or -1
     */
@@ -356,6 +358,7 @@ var CleverTap = {
 
     /**
     * Get the number of occurrences of an event
+    * @deprecated - Since version 3.2.0. Use getUserEventLogCount() instead
     * @param {string} eventName - the name of the event
     * @param {function(err, res)} callback that returns a res of int
     */
@@ -365,6 +368,7 @@ var CleverTap = {
 
     /**
     * Get the summary details of an event
+    * @deprecated - Since version 3.2.0. Use getUserEventLog() instead
     * @param {string} eventName - the name of the event
     * @param {function(err, res)} callback that returns a res of object {"eventName": <string>, "firstTime":<epoch seconds>, "lastTime": <epoch seconds>, "count": <int>} or empty object
     */
@@ -374,11 +378,37 @@ var CleverTap = {
 
     /**
     * Get the user's event history
+    * @deprecated - Since version 3.2.0. Use getUserEventLogHistory() instead
     * @param {function(err, res)} callback that returns a res of object {"eventName1":<event1 details object>, "eventName2":<event2 details object>}
     */
     getEventHistory: function (callback) {
         callWithCallback('getEventHistory', null, callback);
     },
+    /**
+    * Get the details of a specific event
+    * @param {string} eventName - the name of the event
+    * @param {function(err, res)} callback that returns a res of object {"eventName": <string>, "firstTime":<epoch seconds>, "lastTime": <epoch seconds>, "count": <int>, "deviceID": <string>, "normalizedEventName": <string>} or empty object
+    */
+    getUserEventLog: function (eventName, callback) {
+        callWithCallback('getUserEventLog', [eventName], callback);
+    },
+    
+    /**
+    * Get the count of times an event occured
+    * @param {string} eventName - the name of the event
+    * @param {function(err, res)} callback that returns a res of int
+    */
+    getUserEventLogCount: function (eventName, callback) {
+        callWithCallback('getUserEventLogCount', [eventName], callback);
+    },
+
+    /**
+    * Get full event hostory for current user
+    * @param {function(err, res)} callback that returns a res of object {"eventName1":<event1 details object>, "eventName2":<event2 details object>}
+    */
+    getUserEventLogHistory: function (callback) {
+        callWithCallback('getUserEventLogHistory', null, callback);
+    },
 
     /**
     * Set the user's location as a latitude,longitude coordinate
@@ -539,12 +569,29 @@ var CleverTap = {
 
     /**
     * Get the total number of vists by the user
+    * @deprecated - Since version 3.2.0. Use getUserAppLaunchCount() instead
     * @param {function(err, res)} callback that returns a res of int
     */
     sessionGetTotalVisits: function (callback) {
         callWithCallback('sessionGetTotalVisits', null, callback);
     },
 
+    /**
+    * Get timestamp of user's last app visit
+    * @param {function(err, res)} callback that returns a res of epoch seconds or -1
+    */
+    getUserLastVisitTs: function (callback) {
+        callWithCallback('getUserLastVisitTs', null, callback);
+    },
+    
+    /**
+    * Get the total number of times user has launched the app
+    * @param {function(err, res)} callback that returns a res of int
+    */
+    getUserAppLaunchCount: function (callback) {
+        callWithCallback('getUserAppLaunchCount', null, callback);
+    },
+
     /**
     * Get the number of screens viewed by the user during the session
     * @param {function(err, res)} callback that returns a res of int
@@ -555,6 +602,7 @@ var CleverTap = {
 
     /**
     * Get the most recent previous visit time of the user
+    * @deprecated - Since version 3.2.0. Use getUserLastVisits() instead
     * @param {function(err, res)} callback that returns a res of epoch seconds or -1
     */
     sessionGetPreviousVisitTime: function (callback) {