@woosmap/react-native-plugin-geofencing 0.1.3 → 0.1.4

package/android/src/main/java/com/reactnativeplugingeofencing/PluginGeofencingModule.java

@@ -30,6 +30,9 @@ import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.Iterator;
 
+/**
+ * This is a React native plugin exposing Woosmap Geofencing SDK methods.
+ */
 @ReactModule(name = PluginGeofencingModule.NAME)
 public class PluginGeofencingModule extends ReactContextBaseJavaModule implements PermissionListener, LifecycleEventListener {
   public static final String NAME = "PluginGeofencing";
@@ -47,6 +50,10 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     this.reactContext.addLifecycleEventListener(this);
   }
 
+  /***
+   * Return plugin name.
+   * @return woosmap native plugin name.which is constant for android and ios.
+   */
   @Override
   @NonNull
   public String getName() {
@@ -62,6 +69,12 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
   }
 
 
+  /***
+   * Initializes Woosmap object with given parameters.
+   * @param map     ReadableMap may contain privateKeyWoosmapAPI with Woosmap API key,
+   *                trackingProfile with tracking profile info.
+   * @param promise React native callback context.
+   */
   @ReactMethod
   public void initialize(ReadableMap map, Promise promise) {
     String trackingProfile = "";
@@ -106,6 +119,10 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
 
   }
 
+  /***
+   * Checks if Woosmap object is instantiated.
+   * @return true if woosmap sdk is initialized else false.
+   */
   private boolean isWoosmapInitialized() {
     if (woosmap == null) {
       return false;
@@ -113,6 +130,10 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     return true;
   }
 
+  /***
+   * Requests permissions. If the background permission is required then ACCESS_BACKGROUND_LOCATION is requested for devices above Android 9.
+   * @param data Readable Array containing a boolean parameter to check if the background permission is required.
+   */
   @ReactMethod
   private void requestPermissions(ReadableArray data, Promise promise) {
     try {
@@ -146,6 +167,10 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     return true;
   }
 
+  /***
+   * Provide status of foreground and background location permission.
+   * @param promise React native callback context.
+   */
   private void providePermissionStatus(final Promise promise) {
     try {
       if (promise == null) {
@@ -179,11 +204,23 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     }
   }
 
+  /***
+   * Checks if the required location permissions are granted or not.
+   * Returns PERMISSION_STATUS_DENIED is no permissions are granted.
+   * Returns PERMISSION_STATUS_GRANTED_FOREGROUND if foreground location permission is granted.
+   * Returns PERMISSION_STATUS_GRANTED_BACKGROUND if background location permission is granted.
+   * Returns UNKNOWN is plugin is unable to determine.
+   */
   @ReactMethod
   public void getPermissionsStatus(final Promise promise) {
     providePermissionStatus(promise);
   }
 
+  /***
+   * Check if the user has given location permission.
+   * @param isBackground Pass true if the background permission needs to be checked.
+   * @return boolean
+   */
   private boolean hasPermission(boolean isBackground) {
     try {
       Activity activity = getCurrentActivity();
@@ -225,6 +262,11 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     }
   }
 
+  /***
+   * Sets the Woosmap private API key for calling Woosmap APIs.
+   * @param data accepts Woosmap API key in a Readable array.
+   * @param promise React native callback context.
+   */
   @ReactMethod
   public void setWoosmapApiKey(ReadableArray data, Promise promise) {
     try {
@@ -248,6 +290,11 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     }
   }
 
+  /***
+   * Starts Woosmap Geofencing tracking.
+   * @param data Accepts tracking profile. Value can be either liveTracking, passiveTracking or stopsTracking.
+   * @param promise React native callback context.
+   */
   @ReactMethod
   public void startTracking(ReadableArray data, Promise promise) {
     try {
@@ -273,6 +320,10 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     }
   }
 
+  /***
+   * Stops tracking
+   * @param promise React native callback context.
+   */
   @ReactMethod
   public void stopTracking(Promise promise) {
     try {
@@ -288,6 +339,11 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     }
   }
 
+  /***
+   * Add watch to woosmap location data.
+   * @param watchID Unique String value for location listener.
+   * @param promise React native callback context.
+   */
   @ReactMethod
   public void watchLocation(String watchID, Promise promise) {
     try {
@@ -307,6 +363,11 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     }
   }
 
+  /***
+   * Clear woosmap location watch.
+   * @param watchID Unique String value for location listener.
+   * @param promise React native callback context.
+   */
   @ReactMethod
   public void clearLocationWatch(String watchID, Promise promise) {
     try {
@@ -322,6 +383,11 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     }
   }
 
+  /***
+   * Sets Sales Force Marketing Cloud credentials.
+   * @param map accepts Sales Force Marketing Cloud credentials key in a ReadableMap.
+   * @param promise React native callback context.
+   */
   @ReactMethod
   private void setSFMCCredentials(ReadableMap map, Promise promise) {
     try {
@@ -365,6 +431,11 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     }
   }
 
+  /***
+   * Add watch to woosmap region data.
+   * @param watchID Unique String value for region listener.
+   * @param promise React native callback context.
+   */
   @ReactMethod
   public void watchRegions(String watchID, Promise promise) {
     try {
@@ -385,6 +456,12 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     }
   }
 
+  /***
+   * Clear woosmap region watch.
+   * @param watchID Unique String value for region listener.Which is getting
+   * @param promise React native callback context.
+   */
+
   @ReactMethod
   public void clearRegionsWatch(String watchID, Promise promise) {
     try {
@@ -401,35 +478,39 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     }
   }
 
+  /***
+   * Set radius of POI
+   * @param radius  A string containing POI radius value in number,string,double format.
+   * @param promise React native callback context.
+   */
   @ReactMethod
-  public void setPoiRadius(String radius,Promise promise){
-    try{
-      if (isWoosmapInitialized()){
-        if (radius.isEmpty()){
+  public void setPoiRadius(String radius, Promise promise) {
+    try {
+      if (isWoosmapInitialized()) {
+        if (radius.isEmpty()) {
           throw new Exception(WoosmapMessageAndKey.radiusEmptyMessage);
         }
-        if(onlyContainsNumbers(radius)){
-          WoosmapSettings.poiRadius=Integer.parseInt(radius);
+        if (onlyContainsNumbers(radius)) {
+          WoosmapSettings.poiRadius = Integer.parseInt(radius);
           promise.resolve(WoosmapMessageAndKey.successMessage);
-        }else if(onlyContainsDouble(radius)){
-          double d=Double.parseDouble(radius);
-          WoosmapSettings.poiRadius=(int) Math.round(d);
+        } else if (onlyContainsDouble(radius)) {
+          double d = Double.parseDouble(radius);
+          WoosmapSettings.poiRadius = (int) Math.round(d);
           promise.resolve(WoosmapMessageAndKey.successMessage);
-        }else {
-          WoosmapSettings.poiRadiusNameFromResponse=radius;
+        } else {
+          WoosmapSettings.poiRadiusNameFromResponse = radius;
           promise.resolve(WoosmapMessageAndKey.successMessage);
         }
-      }else {
+      } else {
         promise.reject(WoosmapMessageAndKey.errorCode, WoosmapMessageAndKey.woosmapNotInitialized);
       }
-    }
-    catch (Exception ex){
-      promise.reject(WoosmapMessageAndKey.errorCode,ex.getMessage());
+    } catch (Exception ex) {
+      promise.reject(WoosmapMessageAndKey.errorCode, ex.getMessage());
     }
   }
 
-  /**
-   *
+  /***
+   * Its check string is integer or not.
    * @param text string for checking if it contains only number or not.
    * @return true boolean value if string is only number else false.
    */
@@ -442,6 +523,11 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
     }
   }
 
+  /***
+   * Its check string is double or not.
+   * @param text String for checking if it contain double or not.
+   * @return true boolean value if string is double else false.
+   */
   private boolean onlyContainsDouble(String text) {
     try {
       Double.parseDouble(text);
@@ -450,6 +536,6 @@ public class PluginGeofencingModule extends ReactContextBaseJavaModule implement
       return false;
     }
   }
-  
+
 
 }

package/android/src/main/java/com/reactnativeplugingeofencing/WoosLocationReadyListener.java

@@ -10,6 +10,9 @@ import com.facebook.react.bridge.ReactContext;
 import com.facebook.react.modules.core.DeviceEventManagerModule;
 import com.webgeoservices.woosmapgeofencing.Woosmap;
 
+/***
+ * Implements Woosmap Location Ready callbacks
+ */
 public class WoosLocationReadyListener implements Woosmap.LocationReadyListener {
   private ReactNativeHost reactNativeHost;
   private Context context;

package/android/src/main/java/com/reactnativeplugingeofencing/WoosRegionReadyListener.java

@@ -11,6 +11,9 @@ import com.webgeoservices.woosmapgeofencing.Woosmap;
 import com.webgeoservices.woosmapgeofencing.database.Region;
 import com.webgeoservices.woosmapgeofencing.database.RegionLog;
 
+/***
+ * Implements Woosmap Region callbacks
+ */
 public class WoosRegionReadyListener implements Woosmap.RegionReadyListener,Woosmap.RegionLogReadyListener {
 
   private ReactNativeHost reactNativeHost;

package/android/src/main/java/com/reactnativeplugingeofencing/WoosmapMessageAndKey.java

@@ -1,5 +1,6 @@
 package com.reactnativeplugingeofencing;
 
+
 public class WoosmapMessageAndKey {
   protected static String errorCode = "1001";
   protected static String successMessage="OK";

package/android/src/main/java/com/reactnativeplugingeofencing/WoosmapUtil.java

@@ -16,6 +16,9 @@ import org.json.JSONObject;
 
 import java.util.Iterator;
 
+/***
+ * Contains misc. utility functions.
+ */
 public class WoosmapUtil {
   private static final String TAG="WoosmapUtil";
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@woosmap/react-native-plugin-geofencing",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "This react-native plugin extends the functionality offered by the Woosmap Geofencing Mobile SDKs. Find more about the Woosmap Geofencing SDK",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",