locationservice_forecast_geofence_events: Evaluates device positions against geofence geometries from a given geofence collection

Description

Evaluates device positions against geofence geometries from a given geofence collection. The event forecasts three states for which a device can be in relative to a geofence:

See https://www.paws-r-sdk.com/docs/locationservice_forecast_geofence_events/ for full documentation.

Usage

locationservice_forecast_geofence_events(
  CollectionName,
  DeviceState,
  TimeHorizonMinutes = NULL,
  DistanceUnit = NULL,
  SpeedUnit = NULL,
  NextToken = NULL,
  MaxResults = NULL
)

Arguments

CollectionName

[required] The name of the geofence collection.

DeviceState

[required] The device's state, including current position and speed.

TimeHorizonMinutes

Specifies the time horizon in minutes for the forecasted events.

DistanceUnit

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.

Default Value: Kilometers

SpeedUnit

The speed unit for the device captured by the device state. The measurement system must match for DistanceUnit and SpeedUnit; if Kilometers is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour.

Default Value: KilometersPerHour.

NextToken

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

MaxResults

An optional limit for the number of resources returned in a single call.

Default value: 20