GeotriggerNotificationOptions

AMD: require(["esri/webdoc/geotriggersInfo/GeotriggerNotificationOptions"], (GeotriggerNotificationOptions) => { /* code goes here */ });
ESM: import GeotriggerNotificationOptions from "@arcgis/core/webdoc/geotriggersInfo/GeotriggerNotificationOptions";
Class: esri/webdoc/geotriggersInfo/GeotriggerNotificationOptions
Inheritance: GeotriggerNotificationOptions Accessor
Since: ArcGIS API 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

new GeotriggerNotificationOptions(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
String

The name of the class.

more details
Accessor
ExpressionInfo

An optional Arcade expression which can be used to configure notification information when the Geotrigger condition is met.

more details
GeotriggerNotificationOptions
String[]

An optional list of strings indicating the set of possible actions resulting from this Geotrigger.

more details
GeotriggerNotificationOptions

Property Details

declaredClass Stringreadonly inherited

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

expressionInfo ExpressionInfo

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'.

Default Value:null
requestedActions String[]

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.

Default Value:null
Example
// Some actions a client app can consume and define behavior for
options.requestedActions = [ "someAction", "someOtherAction", "aThirdAction" ]

// A more realistic example: actions a client app can consume and define (likely tracking-related) behavior for
options.requestedActions = [ "startTracking", "stopTracking" ]

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
this

Creates a deep clone of this object.

more details
GeotriggerNotificationOptions
*

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

more details
GeotriggerNotificationOptions
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

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

more details
GeotriggerNotificationOptions

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

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.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
removeHandles(groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
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.