FenceGeotrigger

let fenceGeotrigger = new FenceGeotrigger({
  name: "Example Geotrigger - Notify when I am within 50m of my target areas.",
  enterExitRule: "enter-intersects-and-exit-does-not-intersect",
  feed: {
    filterExpression: {
      title: "Location filter",
      expression: "return $locationupdate.horizontalaccuracy <= 20"
    }
  },
  fenceNotificationRule: "enter",
  feedAccuracyMode: "use-geometry-with-accuracy",
  fenceParameters: {
    bufferDistance: 50,
    fenceSource: {
      layerUrl: "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Recreation/MapServer/0"
    },
  },
  notificationOptions: {
    expressionInfo: {
      "title": "Expression",
      "expression": "'You have entered' + $fencefeature.AREA_NAME"
    }
  }
})

Property Overview

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

enterExitRule String

The rule that determines whether a fence polygon has been entered or exited by the geometry from a feed. The feedAccuracyMode must be set to use-geometry-with-accuracy for this property to have an effect.

Enter exit rule	Description
enter-intersects-and-exit-does-not-intersect	A fence polygon is entered when it intersects a feed geometry and exited when it no longer intersects.
enter-contains-and-exit-does-not-contain	A fence polygon is entered when it contains a feed geometry and exited when it is no longer contained.
enter-contains-and-exit-does-not-intersect	A fence polygon is entered when it contains a feed geometry and exited when it no longer intersects.

Possible Values:"enter-contains-and-exit-does-not-contain"|"enter-contains-and-exit-does-not-intersect"|"enter-intersects-and-exit-does-not-intersect"

Default Value:enter-contains-and-exit-does-not-intersect

feed DeviceLocationFeed

The feed for this Geotrigger.

Default Value:null

feedAccuracyMode String

Indicates how the geotrigger will use accuracy information from a feed.

Feed accuracy mode	Description
use-geometry	The reported geometry from a feed will be used.
use-geometry-with-accuracy	The feed geometry will be used in conjunction with accuracy information.

Possible Values:"use-geometry"|"use-geometry-with-accuracy"

Default Value:use-geometry

fenceNotificationRule String

Indicates the type of event that will trigger notifications for the Fence Geotrigger. For example, a value of enter will result in notifications when the geometry of the feed enters a fence polygon.

Possible Values:"enter"|"enter-or-exit"|"exit"

Default Value:null

fenceParameters FeatureFenceParameters

An object defining the fences to use for this Geotrigger.

Default Value:null

name String

The name for this Geotrigger.

Default Value:null

notificationOptions GeotriggerNotificationOptions

Options that control the notification information sent to a client app when a Geotrigger condition is met.

Default Value:null

type Stringreadonly

String indicating the Geotrigger condition type.

For FenceGeotrigger the type is always "fence".