This class was introduced in Esri::ArcGISRuntime 100.12.
|Esri::ArcGISRuntime::GeotriggerMonitor *||geotriggerMonitor() const|
A GeotriggerNotificationInfo is sent by a GeotriggerMonitor whenever the condition described by its Geotrigger is met. The Geotrigger also defines how the GeotriggerNotificationInfo should be displayed. For example, it describes what message should be displayed to the user.
Member Function Documentation
List Geotrigger Notification Info: : actions() const
Returns a set of strings describing recommended actions based on this notification.
Optionally, use these strings to determine whether your app will perform custom behavior, such as showing messages or starting/stopping tracking. 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. This property can be empty.
These actions are the result of evaluating the Geotrigger::messageExpression for the specific objects that triggered this notification. If the expression returns a dictionary containing a list of strings with the key "actions", they are shown in this property.
- "message" with the string "Hello world"
- "actions" with a list of action strings "startTracking","showMessage"
... then this property returns a list containing "startTracking" and "showMessage". The list of actions are simple strings so you can use them to control any custom action for your app.
The author of a Geotrigger can supply a set of all the possible Geotrigger::requestedActions when defining the Geotrigger. This property returns a list of strings indicating the actions that should be taken by your app, based on this GeotriggerNotificationInfo.
This function was introduced in Esri::ArcGISRuntime 100.14.
Notification Info: : feed Entity() const I d
Returns a unique ID for the entity within the feed that triggered the notification info.
This property is consistent for all notifications for a given feed entity. For example, use this ID to count the number of sites a team member visits.
If a feed uses an AbstractLocationDataSource, all location updates for that feed share the same ID.
With a FenceGeotrigger, you can combine this property with the FenceGeotriggerNotificationInfo::fenceId to create an ID that groups all notifications for a given feed entity and a specific fence. For example, use a concatenation of the two properties to display a list of areas of interest that are currently occupied and the details of who has entered them.
To group events by the geotrigger, use the Geotrigger::geotriggerId property.
This function was introduced in Esri::ArcGISRuntime 100.13.
: Geotrigger A r c GISRuntime: : Location Notification Info: : feed Location() const
The Location is set if a LocationGeotriggerFeed was used to create the Geotrigger that the GeotriggerMonitor is monitoring. This allows you to access the position and meta-data from the feed, such as the horizontal accuracy, velocity, and time stamp.
: *Geotrigger A r c GISRuntime: : Geotrigger Monitor Notification Info: : geotrigger Monitor() const
Returns the GeotriggerMonitor that sent this notification.
: Geotrigger A r c GISRuntime: : Geotrigger Notification Info Type Notification Info: : geotrigger Notification() const Info Type
Returns the type of geotrigger notification.
The type for a specific GeotriggerNotificationInfo object.
Notification Info: : message() const
Returns a message that describes the notification.
The notification message is the result of evaluating the Geotrigger::messageExpression for the specific feed and fence objects that triggered this notification. The message could be a hard-coded string or use attributes from an area of interest that was entered to display a custom message.
"You have entered " + $fencefeature.area_name
would return the message "You have entered Area A", where "area_name" is an attribute field on the FenceGeotriggerNotificationInfo::fenceGeoElement.
You can use this message to alert the user directly or in other business logic in your app.
Returns a dictionary of optional properties derived from the Geotrigger::messageExpression.