import GeotriggerNotificationOptions from "@arcgis/core/webdoc/geotriggersInfo/GeotriggerNotificationOptions.js";const GeotriggerNotificationOptions = await $arcgis.import("@arcgis/core/webdoc/geotriggersInfo/GeotriggerNotificationOptions.js");- Inheritance:
- GeotriggerNotificationOptions→
Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.24
Options that control the notification information sent to a client app client when a Geotrigger condition is met.
Example
let notificationOptions = new GeotriggerNotificationOptions({ expressionInfo: { // autocasts as new ExpressionInfo() title: "Notice", expression: "'You have entered' + $fencefeature.AREA_NAME" }), requestedActions: [ "showMessage" ]})Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
declaredClass readonly inherited | ||
| | ||
| |
expressionInfo
- Type
- ExpressionInfo | null | undefined
An optional Arcade expression which can be used to configure notification information when the Geotrigger condition is met. The expression uses the Geotrigger Notification Arcade profile. The expression can return either a String that will be used for a user facing message or a Dictionary that can include a user facing message with the key 'message', and a recommended list of app actions using the key 'actions'.
requestedActions
An optional list of strings indicating the set of possible actions resulting from this Geotrigger. This property shows the full list of recommended actions that the author intends to be taken for this Geotrigger. Note that there is no requirement to take any action when a notification is delivered, but these provide a way to understand the intention of the author of the Geotrigger. These strings can be displayed to a user to make them aware of the Geotrigger's expected behavior, or used by client apps to determine whether the desired actions are supported. If a client app receives notification information containing an unrecognized action they should ignore it. Actions can be any strings that are supported by geotrigger enabled apps in your organization and should cover all possible 'action' values returned from evaluation of expressionInfo.expression.
Example
// Some actions a client app can consume and define behavior foroptions.requestedActions = [ "someAction", "someOtherAction", "aThirdAction" ]
// A more realistic example: actions a client app can consume and define (likely tracking-related) behavior foroptions.requestedActions = [ "startTracking", "stopTracking" ]Methods
fromJSON
- Signature
-
fromJSON (json: any): any
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.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| json | 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
- any
Returns a new instance of this class.
clone
- Signature
-
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
- this
A deep clone of the class instance that invoked this method.
toJSON
- Signature
-
toJSON (): any
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
- Returns
- any
The ArcGIS portal JSON representation of an instance of this class.