Add geofences in android

Geofences is a virtual circle created around specified location with specified radius. It is the awareness of users current location with his proximity location. If you want to notify user for particular location you can do this with Geofence. Get location details for that location and add geofence with certain radius. You can listen enter, exit and wait ( or dwell) event for that location and based on that you can notify user

Create Geofence client and Add

private var geofenceList: ArrayList<geofence> = ArrayList()
geofencingClient = LocationServices.getGeofencingClient(this)

Create list for geofences

private var geofenceList: ArrayList<geofence> = ArrayList()
geofenceList.add(Geofence.Builder().setRequestId(requestId.toString()).setCircularRegion(latitude, longitude, distance)
                        .setLoiteringDelay(60000).setExpirationDuration(-1).setTransitionTypes(Geofence.GEOFENCE_TRANSITION_DWELL or Geofence.GEOFENCE_TRANSITION_ENTER or Geofence.GEOFENCE_TRANSITION_EXIT).build())

you can check all parametersĀ here

Create Geofences request

private fun getGeofencingRequest(): GeofencingRequest {
        return GeofencingRequest.Builder().apply {

Create pending Intent for Geofences

private val geofencePendingIntent: PendingIntent by lazy {
        val intent = Intent(this,
        // We use FLAG_UPDATE_CURRENT so that we get the same pending intent back when calling
        // addGeofences() and removeGeofences().
        PendingIntent.getService(this, 0, intent, PendingIntent.FLAG_UPDATE_CURRENT)

You need to create one Intent Service to receive events from Geofence. In this MyGeoFencingTransition is that one. You must need to register this service in Manifest.xml file.

Add geofences now

geofencingClient.addGeofences(getGeofencingRequest(), geofencePendingIntent)?.run {
            addOnSuccessListener {
                Toast.makeText(baseContext, "Geofence successfully added", Toast.LENGTH_SHORT).show()

            addOnFailureListener {
                Toast.makeText(baseContext, "Geofence exception occurs -->  ${it.localizedMessage}", Toast.LENGTH_SHORT).show()

And the final one MyGeoFencingTransition

class MyGeoFencingTransition : IntentService("MyGeoFencingTransition") {
    override fun onHandleIntent(intent: Intent?) {
        val geofencingEvent = GeofencingEvent.fromIntent(intent)
        if (geofencingEvent.hasError()) {
//            Log.e("Geofence", geofencingEvent.errorCode.toString())

        // Get the transition type.
        val geofenceTransition = geofencingEvent.geofenceTransition
        sendNotification(geofencingEvent.triggeringGeofences, geofenceTransition, geofencingEvent.triggeringLocation)


    private fun sendNotification(triggeringGeofences: List<geofence>, geofenceTransition: Int, triggeringLocation: Location) {

        //You can receive this broadcast by creating broadcast receiver in activity.
        val geofenceIds: ArrayList<string> = ArrayList()
        triggeringGeofences.forEach {
        val intent = Intent("$packageName.GeofenceTriggered")
        intent.putExtra(ParamsUtils.geofenceIds, geofenceIds) //geofence Ids for which event occurs
        intent.putExtra(ParamsUtils.geofenceTransition, geofenceTransition) // geofence event can be Geofence.GEOFENCE_TRANSITION_ENTER || Geofence.GEOFENCE_TRANSITION_EXIT || Geofence.GEOFENCE_TRANSITION_DWELL
        intent.putExtra(ParamsUtils.latitude, triggeringLocation)

Now you can receive broadcast in activity and perform any task. Please always checkĀ best practices

Share this content:


More Posts

How does data persistence work in Android?

Data persistence in Android is the ability to save data to the device so that it can be accessed later, even if the app is closed or the device is restarted. There are several ways to achieve data persistence in Android

Fragments and Activities: Two Pillars of Android Development

Fragments and Activities are both important components of Android development. Fragments are a good choice for creating reusable and dynamic UIs, while Activities are a good choice for managing the lifecycle of an app’s UI and implementing core features.

Table of Contents

Send Us A Message