MoEngage Docs

Geofence Triggers

VersionVersion

📘

IMPORTANT:

  • Starting from iOS 14.0, Apple has provided user control to choose the level of precision of location to be shared in App. Now because of this region monitoring(Geofence feature) will not work in cases where the precise location is disabled by the user. Refer link for more info.

  • Region monitoring is only supported with Always authorization. When-in-use authorization doesn't support this feature. Refer link for more info.

  • Dwell trigger is not supported in iOS, hence the SDK supports only Enter and Exit triggers.

  • From MoEngage-iOS-SDK version 4.3.0 Geofence module is separated from the SDK to a separate module MOGeofence and hence has to be added separately.

How to enable Geofence ?

Required Permissions:

Region Monitoring(Geofences) requires Always Authorization and Precise location accuracy to be enabled to work. Therefore make sure that the app is configured to get these permissions and also it's a good practice to let the user know the context in which these permissions are needed, this will also encourage the user to provide these permissions.

MOGeofence Integration:

Include the MOGeofence module in the pod file as shown below and run pod install

pod 'MOGeofence','~> 2.0.0'

📘

MANUAL INTEGRATION

To integrate the MOGeofence SDK manually to your project follow this doc.

Start Geofence Monitoring:

After integrating the MOGeofence module call startGeofenceMonitoring() method to initiate the geofence module. This will fetch the geofences around the current location of the user.

MOGeofenceHandler.sharedInstance()?.startGeofenceMonitoring()
[[MOGeofenceHandler sharedInstance] startGeofenceMonitoring];

Geofence Handler also has callbacks for didEnterRegion and didExitRegion. You can get these by confirming to the MOGeoDelegate.

class ViewController: UIViewController, MOGeoDelegate
      ----
      ----
        func locManager(_ locationManager: CLLocationManager!, didEnter region: CLRegion!) {
            print("GeoFence Entered")
        }
        func locManager(_ locationManager: CLLocationManager!, didExitRegion region: CLRegion!) {
            print("GeoFence Exit")      
        }
@interface MyViewController ()<MOGeoDelegate>
---
-(void)locManager:(CLLocationManager *)locationManager didEnterRegion:(CLRegion *)region{
    NSLog(@"GeoFence Entered");
}
-(void)locManager:(CLLocationManager *)locationManager didExitRegion:(CLRegion *)region{
    NSLog(@"GeoFence Exit");
}

Testing Geofencing

First, create a geofencing campaign on your MoEngage dashboard. You can test geofencing in the following ways:

  1. On the simulator:
    a). You can simulate location as shown below.
b). Simulate the location which for which you have created the campaign on the dashboard.

If you get the respective call back (the delegate methods in MOGeofenceHandler), you are good to go. On simulator you will not receive push notifications.

  1. On the device:
    a) You can simulate location for real device from the bar above the console as shown below:

b) You can add a gpx file with the locations configured. A sample gpx file looks like this:

<?xml version=“1.0”?>
<gpx version=“1.0”>
    <wpt lat=“12.9719” lon=“77.6412”><name>CustomName</name></wpt>
    <wpt lat=“12.9619” lon=“77.6312”></wpt>
    <wpt lat=“12.9519” lon=“77.6112”></wpt>
</gpx>

On the device, once you get the delegate callback for enter or exit in a region, a notification will be sent to the device. This happens instantly, but the notification might take upto 10 minutes.

Geo Notifications

Once you have received the notification, to identify geo notifications, there is a custom param “cType” = “geo” in the param app_extra, as shown below:

{
    "app_extra" = {
            cType = geo;
            screenData = {
                "" = "";
                };
            screenName = "";
        };
        aps = {
            alert = "exit london- single fence";
            badge = 1;
        };
        moengage = {
            cid = "55a628bcf4c4073bb66a368b_GEO:55a628bcf4c4073bb66a368c_ABab1:2015-07-15_14:11:33.704706";
        };
}

Updated about a month ago


What's Next

In-App NATIV

Geofence Triggers


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.