DeviceLocationFeed

AMD: require(["esri/webdoc/geotriggersInfo/DeviceLocationFeed"], (DeviceLocationFeed) => { /* code goes here */ });
ESM: import DeviceLocationFeed from "@arcgis/core/webdoc/geotriggersInfo/DeviceLocationFeed";
Class: esri/webdoc/geotriggersInfo/DeviceLocationFeed
Inheritance: DeviceLocationFeed Accessor
Since: ArcGIS API for JavaScript 4.24

A Geotrigger feed which uses the device location to provide updates.

Example:
let feed = new DeviceLocationFeed({
  filterExpression: { // autocasts as new ExpressionInfo()
    title: "Location filter",
    expression: "return $locationupdate.horizontalaccuracy <= 20"
  }
})

Constructors

new DeviceLocationFeed(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
ExpressionInfomore details

An optional Arcade expression that controls whether a location update will be used by a geotrigger.

more detailsDeviceLocationFeed
Stringmore details

String indicating the type of Geotrigger feed.

more detailsDeviceLocationFeed

Property Details

declaredClass Stringreadonly inherited

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

filterExpression ExpressionInfo

An optional Arcade expression that controls whether a location update will be used by a geotrigger. For example, the expression could reject GPS updates with a poor horizontal accuracy. This expression uses the Location Update Constraint Arcade profile. The expression should return a Boolean where false indicates the location will not be used.

Default Value:null
type Stringreadonly

String indicating the type of Geotrigger feed.

For DeviceLocationFeed the type is always "device-location".

Method Overview

Name Return Type Summary Class
thismore details

Creates a deep clone of this object.

more detailsDeviceLocationFeed
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsDeviceLocationFeed
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsDeviceLocationFeed

Method Details

clone(){this}

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns:
Type Description
this A deep clone of the class instance that invoked this method.
fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
Type Description
* Returns a new instance of this class.
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

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