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

package/README.md

@@ -33,12 +33,14 @@ For iOS
   </array>
 
   ```
+
 - **Podfile**: configure to use ```use_frameworks!``` and ```platform :ios, '12.0'```
 if you are using **M1 Mac** Update pod post installation like
+
 ```
   post_install do |installer|
-	installer.pods_project.targets.each do |target|
-  		target.build_configurations.each do |config|
+ installer.pods_project.targets.each do |target|
+    target.build_configurations.each do |config|
           config.build_settings["ONLY_ACTIVE_ARCH"] = "NO"
           config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '12.0'
       end
@@ -46,27 +48,28 @@ if you are using **M1 Mac** Update pod post installation like
   end
 ```
 
-For Android
-- ToDo: Please update for Android
-
 ### Supported Platforms ###
+
 ---
+
 - iOS
 - Android
 
 ### Modules
+
 ---
-* **WoosmapGeofencing**: Woosmap contains methods to monitor location, regions.
+- **WoosmapGeofencing**: Woosmap contains methods to monitor location, regions.
 
 ### Objects(Read Only)
+
 ---
-* **Location**: Represents the location object
-* **POI**: Represents Point of Interest
-* **Region**: Represents a geographical region/geofence
-* **Visit**: Represents a visit to a location/POI
-* **ZOI**: Represents Zone of Interest
-* **Airship**: Contains custom data related to Airship implementation
-* **MarketingCloud**: Contains custom data related to third party marketing cloud implementation
+- **Location**: Represents the location object
+- **POI**: Represents Point of Interest
+- **Region**: Represents a geographical region/geofence
+- **Visit**: Represents a visit to a location/POI
+- **ZOI**: Represents Zone of Interest
+- **Airship**: Contains custom data related to Airship implementation
+- **MarketingCloud**: Contains custom data related to third party marketing cloud implementation
 
 ## Usage
 
@@ -78,6 +81,7 @@ import WoosmapGeofencing from 'react-native-plugin-geofencing';
 ```
 
 ### Check and request permissions
+
 ---
 Before initializing the SDK it is required that you request for required location permissions.
 
@@ -94,9 +98,10 @@ WoosmapGeofencing.getPermissionsStatus()
 ```
 
 Parameter status will be a string, one of:
-* `GRANTED_BACKGROUND` : User has granted location access even when app is not running in the foreground
-* `GRANTED_FOREGROUND` : Location access is granted only while user is using the app
-* `DENIED`: Location access is denied
+- `GRANTED_BACKGROUND` : User has granted location access even when app is not running in the foreground.
+- `GRANTED_FOREGROUND` : Location access is granted only while user is using the app.
+- `DENIED`: Location access is denied.
+- `UNKNOWN`: Without providing or denying any permission then it will return unknown.
 
 **_Please note_**: Plugin will not work as expected if location access is denied.
 
@@ -115,6 +120,7 @@ WoosmapGeofencing.requestPermissions(props.background)
 ```
 
 ### Initializing the plugin
+
 ---
 
 Plugin can be initialized by simply calling `initialize` method.
@@ -152,11 +158,13 @@ WoosmapGeofencing.setWoosmapApiKey(<privateKeyWoosmapAPI>)
 ```
 
 ### Tracking
+
 ---
 
 Once you have initialized the plugin and the user has authorized location permissions, you can start tracking the user’s location.
 
 To start tracking, call:
+
 ``` javascript
 WoosmapGeofencing.startTracking('liveTracking')
       .then((result: string) => {
@@ -169,6 +177,7 @@ WoosmapGeofencing.startTracking('liveTracking')
 ```
 
 To stop tracking, call:
+
 ``` javascript
 WoosmapGeofencing.stopTracking()
       .then((value: any) => {
@@ -181,11 +190,12 @@ WoosmapGeofencing.stopTracking()
 
 Method `startTracking` accepts only following tracking profiles
 
-* **liveTracking**
-* **passiveTracking**
-* **visitsTracking**
+- **liveTracking**
+- **passiveTracking**
+- **visitsTracking**
 
 ### Tracking profile properties
+
 ---
 
 | Property | liveTracking | passiveTracking | visitsTracking
@@ -211,6 +221,7 @@ Method `startTracking` accepts only following tracking profiles
 | DOUBLEOfDayDataDuration | 30 | 30 | 30
 
 ### Listening to events
+
 ---
 
 **Location**
@@ -247,6 +258,7 @@ WoosmapGeofencing.clearLocationWatch(watchID)
 **Define the radius value**
 
 When you create a Geofence around a POI (previously imported from Woosmap), manually define the radius value:
+
 ```javascript
 WoosmapGeofencing.setPoiRadius("100")
       .then((value: string) => {
@@ -256,7 +268,9 @@ WoosmapGeofencing.setPoiRadius("100")
         alert('message: ' + error.message);
       });
 ```
+
 or choose the user_properties subfield that corresponds to radius value of the Geofence:
+
 ```javascript
 WoosmapGeofencing.setPoiRadius("radiusPOI")
       .then((value: string) => {
@@ -293,7 +307,9 @@ WoosmapGeofencing.clearRegionsWatch(watchID)
         alert('message: ' + error.message);
       });
 ```
+
 ### Initialize Salesforce MarketingCloud Connector
+
 ---
 
 The SDK needs some input like credentials and object key to perform the API call to Salesforce Marketing Cloud API.
@@ -314,7 +330,155 @@ The SDK needs some input like credentials and object key to perform the API call
 | zoiClassifiedExitedEventDefinitionKey  | Set the EventDefinitionKey that you want to use for the Woosmap event `woos_zoi_classified_exited_event`  |          |
 | visitEventDefinitionKey                | Set the EventDefinitionKey that you want to use for the Woosmap event `woos_Visit_event`                  |
 
-**Initialize the connector implementation**
+### Adding and removing regions
+
+---
+
+Call `addRegion` method to add a region that you want to monitor.
+Region type can be 'circle' or 'isochrone' only.
+Method will accept an object with the following attributes:
+
+- **regionId** - Id of the region
+- **lat** - Latitude
+- **lng** - Longitude
+- **radius** - Radius in meters
+- **type** - type of region
+
+##### Create a custom circle region
+
+``` javascript
+var regionData = {
+      lat: 51.50998,
+      lng: -0.1337,
+      regionId: '7F91369E-467C-4CBD-8D41-6509815C4780',
+      radius: 100,
+      type: 'circle',
+    };
+    WoosmapGeofencing.addRegion(regionData)
+      .then((value: string) => {
+        console.log(value);
+      })
+      .catch((error: any) => {
+        console.error(error);
+      });
+  };
+```
+
+##### Create a custom isochrone region
+
+``` javascript
+var regionData = {
+      lat: 51.50998,
+      lng: -0.1337,
+      regionId: '7F91369E-467C-4CBD-8D41-6509815C4780',
+      radius: 180,
+      type: 'isochrone',
+    };
+    WoosmapGeofencing.addRegion(regionData)
+      .then((value: string) => {
+        console.log(value);
+      })
+      .catch((error: any) => {
+        console.error(error);
+      });
+  };
+```
+
+Call ```removeRegions``` method to remove a region that you are monitoring. Method will accept the following parameter, and passing a null value will remove all the regions.
+
+``` javascript
+  const request = "7F91369E-467C-4CBD-8D41-6509815C4780";
+  WoosmapGeofencing.removeRegions(request)
+    .then((value: string) => {
+      console.log(value);
+    })
+    .catch((error: any) => {
+      console.error(error);
+    });
+```
+
+Or To Delete all Regions
+
+``` javascript
+  WoosmapGeofencing.removeRegions()
+    .then((value: string) => {
+      console.log(value);
+    })
+    .catch((error: any) => {
+      console.error(error);
+    });
+```
+
+### Local database operations
+
+---
+
+- **Get POIs**: Call `getPois` method to get an array of POIs from the local db
+
+``` javascript
+
+WoosmapGeofencing.getPois(optional locationid)
+  .then((value: Location[]) => {
+    console.log(String(value.length));
+  })
+  .catch((error: any) => {
+    console.error(error);
+  });
+```
+
+- **Delete POIs**: Call `removePois` method to clear all POIs from the local db.
+
+``` javascript
+WoosmapGeofencing.removePois()
+  .then((value: string) => {
+    console.log(value);
+  })
+  .catch((error: any) => {
+    console.error(error);
+  });
+```
+
+- **Get Locations**: Call `getLocations` method to get an array of Locations from the local db.
+
+``` javascript
+
+WoosmapGeofencing.getLocations(optional locationid)
+  .then((value: Location[]) => {
+    console.log(String(value.length));
+  })
+  .catch((error: any) => {
+    console.error(error);
+  });
+```
+
+- **Delete Locations**: Call `removeLocations` method to clear all Locations info from the local db.
+
+``` javascript
+WoosmapGeofencing.removeLocations()
+  .then((value: string) => {
+    console.log(value);
+  })
+  .catch((error: any) => {
+    console.error(error);
+  });
+```
+
+- **Get Regions**: Call `getRegions` method to get an array of Regions from the local db. specify region id to retrieve specific region info
+
+``` javascript
+  WoosmapGeofencing.getRegions(optional regionid).
+      .then((value: Region[]) => {
+        Toast.show(String(value.length));
+      })
+      .catch((error: any) => {
+        console.error(error);
+      });
+```
+
+### Initialize the connector implementation
+
+---
+
 ``` javascript
     var sfmcCredentials = {
         authenticationBaseURI: "https://xxxxxxxxxx.auth.marketingcloudapis.com",
@@ -334,6 +498,41 @@ The SDK needs some input like credentials and object key to perform the API call
       });
 ```
 
+### Custom tracking profile
+
+---
+
+If preset tracking profiles don’t fit with your use cases, you can build your own profile and uses the startCustomTracking() method. There are two way to host the json file:
+
+- Include json file in the client application (local) for ios.
+- For local mode put json file in assets folder in android.
+- Host externally in a file folder in your information system (external)
+
+``` javascript
+WoosmapGeofencing.startCustomTracking('local', 'localProfile.json')
+      .then((value: any) => {
+        console.log(value);
+      })
+      .catch((error: any) => {
+        alert('message: ' + error.message);
+      });
+```
+
+or
+
+``` javascript
+WoosmapGeofencing.startCustomTracking('external', 'https://raw.githubusercontent.com/lpernelle-wgs/files/master/customProfileLeo.json')
+      .then((value: any) => {
+        console.log(value);
+      })
+      .catch((error: any) => {
+        alert('message: ' + error.message);
+      });
+```
+
+#### Build a custom tracking profile
+
+Define tracking properties in a Json file that respect the Json Schema in the [Tracking properties page](https://deploy-preview-457--developers-woosmap.netlify.app/products/geofencing-sdk/tracking-profiles/tracking-properties/).
 
 ## License
 

package/android/build.gradle

@@ -57,4 +57,11 @@ dependencies {
     //noinspection GradleDynamicVersion
     implementation "com.facebook.react:react-native:+"  // From node_modules
     implementation("com.webgeoservices.woosmapgeofencing:woosmap-mobile-sdk:1.2.1")
+    implementation 'com.google.android.gms:play-services-maps:17.0.0'
+    implementation 'androidx.room:room-runtime:2.2.4'
+    annotationProcessor 'androidx.room:room-compiler:2.2.4'
+    implementation 'androidx.room:room-rxjava2:2.2.4'
+    implementation 'androidx.room:room-guava:2.2.4'
+
+
 }