clevertap-react-native 0.5.0 → 0.7.0

package/index.d.ts

@@ -266,18 +266,6 @@
    */
   export function profileSet(profile: any): void;
 
-  /**
-   * Set profile attributes from facebook user
-   * @param profile {any} facebook graph user object
-   */
-  export function profileSetGraphUser(profile: any): void;
-
-  /**
-   * Set profile attributes rom google plus user
-   * @param profile {any} google plus user object
-   */
-  export function profileGooglePlusUser(profile: any): void;
-
   /**
    * Get User Profile Property
    * @param propertyName {string}
@@ -286,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}
@@ -337,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
    ******************/
@@ -466,218 +483,6 @@
    */
   export function pushDisplayUnitClickedEventForID(unitID: string): void;
 
-  /****************************
-  * AB Tests Methods
-  ****************************/
-  /**
-   * Disables/Enables the ability to send Dynamic Variables to the CleverTap Dashboard
-   * Disabled by default
-   */
-  export function setUIEditorConnectionEnabled(enabled: boolean): void;
-  /**
-   * Registers an ABTesting variable of type Boolean for ease of editing on the CleverTap Dashboard
-   * @param name {string} name of the variable
-   */
-  export function registerBooleanVariable(name: string): void;
-
-  /**
-   * Registers an ABTesting variable of type Double for ease of editing on the CleverTap Dashboard
-   * @param name {string} name of the variable
-   */
-  export function registerDoubleVariable(name: string): void;
-
-  /**
-   * Registers an ABTesting variable of type Integer for ease of editing on the CleverTap Dashboard
-   * @param name {string} name of the variable
-   */
-  export function registerIntegerVariable(name: string): void;
-
-  /**
-   * Registers an ABTesting variable of type String for ease of editing on the CleverTap Dashboard
-   * @param name {string} name of the variable
-   */
-  export function registerStringVariable(name: string): void;
-
-  /**
-   * Registers an ABTesting variable of type List of Boolean for ease of editing on the CleverTap Dashboard
-   * @param name {string} name of the variable
-   */
-  export function registerListOfBooleanVariable(name: string): void;
-
-  /**
-   * Registers an ABTesting variable of type List of Double for ease of editing on the CleverTap Dashboard
-   * @param name {string} name of the variable
-   */
-  export function registerListOfDoubleVariable(name: string): void;
-
-  /**
-   * Registers an ABTesting variable of type List of Integer for ease of editing on the CleverTap Dashboard
-   * @param name {string} name of the variable
-   */
-  export function registerListOfIntegerVariable(name: string): void;
-
-  /**
-   * Registers an ABTesting variable of type List of String for ease of editing on the CleverTap Dashboard
-   * @param name {string} name of the variable
-   */
-  export function registerListOfStringVariable(name: string): void;
-
-  /**
-   * Registers an ABTesting variable of type Map of Boolean for ease of editing on the CleverTap Dashboard
-   * @param name {string} name of the variable
-   */
-  export function registerMapOfBooleanVariable(name: string): void;
-
-  /**
-   * Registers an ABTesting variable of type Map of Double for ease of editing on the CleverTap Dashboard
-   * @param name {string} name of the variable
-   */
-  export function registerMapOfDoubleVariable(name: string): void;
-
-  /**
-   * Registers an ABTesting variable of type Map of Integer for ease of editing on the CleverTap Dashboard
-   * @param name {string} name of the variable
-   */
-  export function registerMapOfIntegerVariable(name: string): void;
-
-  /**
-   * Registers an ABTesting variable of type Map of String for ease of editing on the CleverTap Dashboard
-   * @param name {string} name of the variable
-   */
-  export function registerMapOfStringVariable(name: string): void;
-
-  /**
-    * Returns the Boolean value of the named variable set via an AB Testing Experiment or the default value if unset
-    * @param name - the name of the variable
-    * @param defaultValue - the default value to return if the value has not been set via an AB Testing Experiment
-    * calls back with Boolean, the value set by the Experiment or the default value if unset
-    */
-   export function getBooleanVariable(
-     name: string,
-     defaultValue: any,
-     callback: Callback): void;
-
-   /**
-    * Returns the Double value of the named variable set via an AB Testing Experiment or the default value if unset
-    * @param name - the name of the variable
-    * @param defaultValue - the default value to return if the value has not been set via an AB Testing Experiment
-    * calls back with Double, the value set by the Experiment or the default value if unset
-    */
-   export function getDoubleVariable(
-     name: string,
-     defaultValue: any,
-     callback: Callback): void;
-
-   /**
-    * Returns the Integer value of the named variable set via an AB Testing Experiment or the default value if unset
-    * @param name - the name of the variable
-    * @param defaultValue - the default value to return if the value has not been set via an AB Testing Experiment
-    * calls back with Integer, the value set by the Experiment or the default value if unset
-    */
-   export function getIntegerVariable(
-     name: string,
-     defaultValue: any,
-     callback: Callback): void;
-
-   /**
-    * Returns the String value of the named variable set via an AB Testing Experiment or the default value if unset
-    * @param name - the name of the variable
-    * @param defaultValue - the default value to return if the value has not been set via an AB Testing Experiment
-    * calls back with string, the value set by the Experiment or the default value if unset
-    */
-   export function getStringVariable(
-     name: string,
-     defaultValue: any,
-     callback: Callback): void;
-
-   /**
-    * Returns the List of Boolean value of the named variable set via an AB Testing Experiment or the default value if unset
-    * @param name - the name of the variable
-    * @param defaultValue - the default value to return if the value has not been set via an AB Testing Experiment
-    * calls back with List of Boolean, the value set by the Experiment or the default value if unset
-    */
-   export function getListOfBooleanVariable(
-     name: string,
-     defaultValue: any,
-     callback: Callback): void;
-
-   /**
-    * Returns the List of Double value of the named variable set via an AB Testing Experiment or the default value if unset
-    * @param name - the name of the variable
-    * @param defaultValue - the default value to return if the value has not been set via an AB Testing Experiment
-    * calls back with List of Double, the value set by the Experiment or the default value if unset
-    */
-   export function getListOfDoubleVariable(
-     name: string,
-     defaultValue: any,
-     callback: Callback): void;
-
-   /**
-    * Returns the List of Integer value of the named variable set via an AB Testing Experiment or the default value if unset
-    * @param name - the name of the variable
-    * @param defaultValue - the default value to return if the value has not been set via an AB Testing Experiment
-    * calls back with List of Integer, the value set by the Experiment or the default value if unset
-    */
-   export function getListOfIntegerVariable(
-     name: string,
-     defaultValue: any,
-     callback: Callback): void;
-
-   /**
-    * Returns the List of String value of the named variable set via an AB Testing Experiment or the default value if unset
-    * @param name - the name of the variable
-    * @param defaultValue - the default value to return if the value has not been set via an AB Testing Experiment
-    * calls back with List of String, the value set by the Experiment or the default value if unset
-    */
-   export function getListOfStringVariable(
-     name: string,
-     defaultValue: any,
-     callback: Callback): void;
-
-   /**
-    * Returns the Map of Boolean value of the named variable set via an AB Testing Experiment or the default value if unset
-    * @param name - the name of the variable
-    * @param defaultValue - the default value to return if the value has not been set via an AB Testing Experiment
-    * calls back with Map of Boolean, the value set by the Experiment or the default value if unset
-    */
-   export function getMapOfBooleanVariable(
-     name: string,
-     defaultValue: any,
-     callback: Callback): void;
-
-   /**
-    * Returns the Map of Double value of the named variable set via an AB Testing Experiment or the default value if unset
-    * @param name - the name of the variable
-    * @param defaultValue - the default value to return if the value has not been set via an AB Testing Experiment
-    * calls back with Map of Double, the value set by the Experiment or the default value if unset
-    */
-   export function getMapOfDoubleVariable(
-     name: string,
-     defaultValue: any,
-     callback: Callback): void;
-
-   /**
-    * Returns the Map of Integer value of the named variable set via an AB Testing Experiment or the default value if unset
-    * @param name - the name of the variable
-    * @param defaultValue - the default value to return if the value has not been set via an AB Testing Experiment
-    * calls back withMap of Integer, the value set by the Experiment or the default value if unset
-    */
-   export function getMapOfIntegerVariable(
-     name: string,
-     defaultValue: any,
-     callback: Callback): void;
-
-   /**
-    * Returns the Map of String value of the named variable set via an AB Testing Experiment or the default value if unset
-    * @param name - the name of the variable
-    * @param defaultValue - the default value to return if the value has not been set via an AB Testing Experiment
-    * calls back withMap of String, the value set by the Experiment or the default value if unset
-    */
-   export function getMapOfStringVariable(
-     name: string,
-     defaultValue: any,
-     callback: Callback): void;
-
   /*******************
    * Product Configs
    ******************/ 
@@ -767,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
    ******************/