locationservice_put_geofence: Stores a geofence geometry in a given geofence collection, or...

View source: R/locationservice_operations.R

locationservice_put_geofenceR Documentation

Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request

Description

Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.

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

Usage

locationservice_put_geofence(
  CollectionName,
  GeofenceId,
  GeofenceProperties = NULL,
  Geometry
)

Arguments

CollectionName

[required] The geofence collection to store the geofence in.

GeofenceId

[required] An identifier for the geofence. For example, ExampleGeofence-1.

GeofenceProperties

Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.

Format: "key" : "value"

Geometry

[required] Contains the details to specify the position of the geofence. Can be either a polygon or a circle. Including both will return a validation error.

Each geofence polygon can have a maximum of 1,000 vertices.


paws.application.integration documentation built on Sept. 12, 2023, 1:18 a.m.