Skip to content

Get Geofence

locationservice_get_geofence R Documentation

Retrieves the geofence details from a geofence collection

Description

Retrieves the geofence details from a geofence collection.

The returned geometry will always match the geometry format used when the geofence was created.

Usage

locationservice_get_geofence(CollectionName, GeofenceId)

Arguments

CollectionName

[required] The geofence collection storing the target geofence.

GeofenceId

[required] The geofence you're retrieving details for.

Value

A list with the following syntax:

list(
  GeofenceId = "string",
  Geometry = list(
    Polygon = list(
      list(
        list(
          123.0
        )
      )
    ),
    Circle = list(
      Center = list(
        123.0
      ),
      Radius = 123.0
    ),
    Geobuf = raw
  ),
  Status = "string",
  CreateTime = as.POSIXct(
    "2015-01-01"
  ),
  UpdateTime = as.POSIXct(
    "2015-01-01"
  ),
  GeofenceProperties = list(
    "string"
  )
)

Request syntax

svc$get_geofence(
  CollectionName = "string",
  GeofenceId = "string"
)