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.

Usage¶

locationservice_put_geofence(CollectionName, GeofenceId, Geometry,
  GeofenceProperties)

Arguments¶

• CollectionName

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

• GeofenceId

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

• Geometry

  [required] Contains the details to specify the position of the geofence. Can be a circle, a polygon, or a multipolygon. Polygon and MultiPolygon geometries can be defined using their respective parameters, or encoded in Geobuf format using the Geobuf parameter. Including multiple geometry types in the same request will return a validation error.

  The geofence Polygon and MultiPolygon formats support a maximum of 1,000 total vertices. The Geobuf format supports a maximum of 100,000 vertices.

• 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"

Value¶

A list with the following syntax:

list(
  GeofenceId = "string",
  CreateTime = as.POSIXct(
    "2015-01-01"
  ),
  UpdateTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$put_geofence(
  CollectionName = "string",
  GeofenceId = "string",
  Geometry = list(
    Polygon = list(
      list(
        list(
          123.0
        )
      )
    ),
    Circle = list(
      Center = list(
        123.0
      ),
      Radius = 123.0
    ),
    Geobuf = raw,
    MultiPolygon = list(
      list(
        list(
          list(
            123.0
          )
        )
      )
    )
  ),
  GeofenceProperties = list(
    "string"
  )
)