ForecastGeofenceEventsRequest
Types
Properties
The name of the geofence collection.
Represents the device's state, including its current position and speed. When speed is omitted, this API performs a containment check. The containment check operation returns IDLE
events for geofences where the device is currently inside of, but no other events.
The distance unit used for the NearestDistance
property returned in a forecasted event. The measurement system must match for DistanceUnit
and SpeedUnit
; if Kilometers
is specified for DistanceUnit
, then SpeedUnit
must be KilometersPerHour
.
An optional limit for the number of resources returned in a single call.
The forward-looking time window for forecasting, specified in minutes. The API only returns events that are predicted to occur within this time horizon. When no value is specified, this API performs a containment check. The containment check operation returns IDLE
events for geofences where the device is currently inside of, but no other events.