A GeotriggerMonitor monitors a Geotrigger condition and, when it is met, results in a GeotriggerNotificationInfo. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.12 |
| Inherits: |
Properties
- geotrigger : Geotrigger
- status : Enums.GeotriggerMonitorStatus
- warning : Error
Signals
- geotriggerChanged()
- geotriggerNotification(GeotriggerNotificationInfo geotriggerNotificationInfo)
- statusChanged()
- warningChanged()
Methods
Detailed Description
A Geotrigger defines a query that is evaluated against GIS data as it changes in real time. For example, "Notify me when my device location enters one of my target areas" or "Notify me when my device location is within 50 m of my destination". The process of monitoring a Geotrigger is also known as "Geofencing".
A GeotriggerMonitor is created with a Geotrigger that it continually checks to determine whether the condition has been met.
Once a GeotriggerMonitor is created, you begin checking the condition by calling start. Once you are finished, call stop. When a Geotrigger evaluates to true, a geotriggerNotification is sent. You can subscribe to the notification info to receive details of where the Geotrigger was activated and the condition that was met.
Property Documentation
geotrigger : Geotrigger |
The Geotrigger that will be monitored.
The current monitoring status of the GeotriggerMonitor (read-only).
A GeotriggerMonitor begins with a monitoring status of Enums.GeotriggerMonitorStatusStopped and changes to Enums.GeotriggerMonitorStatusStarted when you call start. When you call stop, the monitoring status changes to Enums.GeotriggerMonitorStatusStopped.
warning : Error |
An error that describes a problem encountered while monitoring the Geotrigger (read-only).
A warning can occur at various stages of monitoring a Geotrigger:
- when starting the GeotriggerMonitor
- when accessing the components of the Geotrigger such as the GeotriggerFeed
- when performing ongoing monitoring
If the problem is resolved, this property will be cleared.
Problems that occur when starting the GeotriggerMonitor result in a status of Enums.GeotriggerMonitorStatusFailedToStart. These issues must be fixed and start called again before you will receive any notifications. For example, if the Geotrigger::messageExpression is an invalid ArcadeExpression, monitoring cannot be carried out.
Problems that occur when accessing the components of the Geotrigger will not prevent the GeotriggerMonitor from starting. However, until the problem is resolved, you will not receive any notifications. For example, if a LocationGeotriggerFeed uses a AbstractLocationDataSource that is not started, you will not receive any notifications. After the AbstractLocationDataSource is successfully started, monitoring will resume. If a FenceParameters has no valid data for a fence, you will not receive any notifications.
Problems that occur during ongoing monitoring relate to issues with individual objects, such as the graphics that make up the fences for a GraphicFenceParameters. These warnings do not prevent notifications from being sent for other valid fences. For example, a fence is considered invalid if it has:
- an empty Geometry
- a missing SpatialReference
- a point or polyline Geometry and a buffer distance of
0
Signal Documentation
Emitted when the geotrigger property changes.
Note: The corresponding handler is onGeotriggerChanged.
geotriggerNotification(GeotriggerNotificationInfo geotriggerNotificationInfo) |
Indicates that the GeotriggerMonitor condition has been meet.
- geotriggerNotificationInfo. The GeotriggerNotificationInfo object.
To handle notifications, connect to this signal and inspect the geotriggerNotificationInfo.
onGeotriggerNotification: {
// Print the message from the notification
console.log(geotriggerNotificationInfo.message);
}
Note: You must use the exact type name "geotriggerNotificationInfo" for the argument in your connection code.
Note: The corresponding handler is onGeotriggerNotification.
Indicates that the status property has changed.
Note: The corresponding handler is onStatusChanged.
Indicates that the warning property has changed.
Note: The corresponding handler is onWarningChanged.
Method Documentation
Starts evaluating the GeotriggerMonitor.
When the GeotriggerMonitor is successfully performing checks, the status will be Enums.GeotriggerMonitorStatusStarted.
Stops evaluating the GeotriggerMonitor.
Stopping the GeotriggerMonitor prevents the condition from being evaluated and notifications from being sent. If you are using a LocationGeotriggerFeed created from a AbstractLocationDataSource, the data source must also be stopped to turn off GPS receivers etc.
When the GeotriggerMonitor is stopped, the status will be Enums.GeotriggerMonitorStatusStopped.