Set up location driven Geotriggers

View on GitHub
Sample viewer app

Create a notification every time a given location data source has entered and/or exited a set of features or graphics.

Screenshot of set up location driven geotriggers

Use case

Geotriggers can be used to notify users when they have entered or exited a geofence by monitoring a given set of features or graphics. They could be used to display contextual information to museum visitors about nearby exhibits, notify hikers when they have wandered off their desired trail, notify dispatchers when service workers arrive at a scene, or more.

How to use the sample

Observe a virtual walking tour of the Santa Barbara Botanic Garden. Information about the user's current Garden Section, as well as information about nearby points of interest within 10 meters will display or be removed from the UI when the user enters or exits the buffer of each feature.

How it works

  1. Create a LocationGeotriggerFeed with an AndroidLocationDataSource class (in this case, a SimulatedLocationDataSource).
  2. Create a FeatureFenceParameters with a ServiceFeatureTable and a buffer distance at which to monitor each feature.
  3. Create a FenceGeotrigger with the geotrigger feed, a FenceRuleType, the fence parameters, an Arcade Expression, and a name for the specific geotrigger.
  4. Create a GeotriggerMonitor with the fence geotrigger and call GeotriggerMonitor.startAsync() to begin listening for events that meet the FenceRuleType.
  5. When GeotriggerMonitor.addGeotriggerMonitorNotificationEventListener emits, capture the GeotriggerNotificationInfo to retrieve information about the geotrigger and the feature.
  6. Retrieve the feature information from the GeoElement passed by the geotrigger notification for later querying and display.
  7. Depending on the FenceGeotriggerNotificationInfo.fenceNotificationType display or hide information on the UI from the GeoElement's attributes.

Relevant API

  • ArcadeExpression
  • FeatureFenceParameters
  • FenceGeotrigger
  • FenceGeotriggerNotificationInfo
  • FenceRuleType
  • GeoElement
  • Geotrigger
  • GeotriggerFeed
  • GeotriggerMonitor
  • GeotriggerNotificationInfo
  • ServiceFeatureTable
  • SimulatedLocationDataSource

About the data

This sample uses the Santa Barbara Botanic Garden Geotriggers Sample ArcGIS Online Web Map which includes a geo-referenced map of the garden as well as select polygon and point features to denote garden sections and points of interest. Description text and attachment images in the feature layers were provided by the Santa Barbara Botanic Garden and more information can be found on the Garden Sections & Displays portion of their website. All assets are used with permission from the Santa Barbara Botanic Garden. For more information, visit the Santa Barbara Botanic Garden website.

Tags

alert, arcade, fence, geofence, geotrigger, location, navigation, notification, notify, routing, trigger

Sample Code

GardenDescriptionFragment.ktGardenSection.ktListAdapter.ktMainActivity.kt
Use dark colors for code blocks
                                                    
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
package com.esri.arcgisruntime.sample.setuplocationdrivengeotriggers

import android.graphics.BitmapFactory
import android.os.Bundle
import android.view.LayoutInflater
import android.view.View
import android.view.ViewGroup
import androidx.core.text.HtmlCompat
import androidx.fragment.app.DialogFragment
import kotlinx.android.synthetic.main.dialog_fragment.*

/**
 * Class to display a dialog with the title, image and description of the [GardenSection]
 */
class GardenDescriptionFragment(
    // Garden section to display
    private val gardenSection: GardenSection,
    private val mainActivity: MainActivity
) : DialogFragment() {

    override fun onCreateView(
        inflater: LayoutInflater,
        container: ViewGroup?,
        savedInstanceState: Bundle?
    ): View {
        // Bind inflater to the layout view.
        return inflater.inflate(R.layout.dialog_fragment, container, false)
    }

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)
        // Set title, description and image view of the mGardenSection
        view.apply {
            gardenContentTitle.text = gardenSection.title
            gardenContentTextView.text =
                HtmlCompat.fromHtml(gardenSection.description, HtmlCompat.FROM_HTML_MODE_LEGACY)

            // Retrieves the image using a callback from [MainActivity]
            mainActivity.retrieveImage(gardenSection) {
                val bitmap = BitmapFactory.decodeFile(it)
                gardenContentImageView.setImageBitmap(bitmap)
            }
        }
    }

    override fun onStart() {
        super.onStart()
        //Set the width of the Dialog Fragment
        val width = (resources.displayMetrics.widthPixels * 0.85).toInt()
        dialog?.window?.setLayout(width, ViewGroup.LayoutParams.WRAP_CONTENT)
    }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.