Prerequisites

To use location triggered (Geofence) push, your app must request the following:

ACCESS_FINE_LOCATION
ACCESS_BACKGROUND_LOCATION if your app targets Android 10 (API level 29) or later.

For location triggered push to work, ensure your Application has the following enabled: Location permission, Play Services location library, and device’s location.

For more information, refer to Android Request Geofences.

SDK Installation

Installing using BOM

Integration using BOM is the recommended way of integration; refer to the Install Using BOM document. Once you have configured the BOM add the dependency in the app/build.gradle file as shown below

dependencies {
    ...
    implementation("com.moengage:geofence")
}

Once the BOM is configured, include the specific MoEngage modules required for the application.
Note: Version numbers are not required for these dependencies; the BOM automatically manages them.

Configure Geofence

By default, the geofence feature is not enabled. To enable the feature, call the below API.

MoEGeofenceHelper.getInstance().startGeofenceMonitoring(context)

MoEGeofenceHelper.getInstance().startGeofenceMonitoring(context);

At any time if you want to stop the geofence monitoring or feature, use the below API. This API will remove the existing geofences.

MoEGeofenceHelper.getInstance().stopGeofenceMonitoring(context)

MoEGeofenceHelper.getInstance().stopGeofenceMonitoring(context);

Callback

The MoEngage SDK can notify your application whenever a geofence is triggered. If the listener returns true, your application consumes the trigger and the SDK doesn’t process it further. Returning false lets the SDK process the trigger as usual, so the listener can be used purely for logging or analytics. Implement OnGeofenceHitListener and register it in your Application class onCreate() using MoEGeofenceHelper.getInstance().addListener().

class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()

        MoEGeofenceHelper.getInstance().addListener(OnGeofenceHitListener { geofenceData ->
            // Log or analytics for the triggered geofence.
            // Return true to consume the trigger; false lets the SDK process it.
            false
        })
    }
}

public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();

        MoEGeofenceHelper.getInstance().addListener(geofenceData -> {
            // Log or analytics for the triggered geofence.
            // Return true to consume the trigger; false lets the SDK process it.
            return false;
        });
    }
}

SDKs

Location Triggered

Prerequisites

SDK Installation

Installing using BOM

Configure Geofence

Callback

​Prerequisites

​SDK Installation

​Installing using BOM

​Configure Geofence

​Callback

Prerequisites

SDK Installation

Installing using BOM

Configure Geofence

Callback