Class MapsGeofenceGeometry


  • public class MapsGeofenceGeometry
    extends Object
    The geofence geometry.
    • Constructor Detail

      • MapsGeofenceGeometry

        public MapsGeofenceGeometry()
    • Method Detail

      • deviceId

        public String deviceId()
        Get iD of the device.
        Returns:
        the deviceId value
      • withDeviceId

        public MapsGeofenceGeometry withDeviceId​(String deviceId)
        Set iD of the device.
        Parameters:
        deviceId - the deviceId value to set
        Returns:
        the MapsGeofenceGeometry object itself.
      • distance

        public Double distance()
        Get distance from the coordinate to the closest border of the geofence. Positive means the coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. Negative means the coordinate is inside of the geofence. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border,then the value is -999. A value of 999 means that there is great confidence the coordinate is well outside the geofence. A value of -999 means that there is great confidence the coordinate is well within the geofence.
        Returns:
        the distance value
      • withDistance

        public MapsGeofenceGeometry withDistance​(Double distance)
        Set distance from the coordinate to the closest border of the geofence. Positive means the coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. Negative means the coordinate is inside of the geofence. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border,then the value is -999. A value of 999 means that there is great confidence the coordinate is well outside the geofence. A value of -999 means that there is great confidence the coordinate is well within the geofence.
        Parameters:
        distance - the distance value to set
        Returns:
        the MapsGeofenceGeometry object itself.
      • geometryId

        public String geometryId()
        Get the unique ID for the geofence geometry.
        Returns:
        the geometryId value
      • withGeometryId

        public MapsGeofenceGeometry withGeometryId​(String geometryId)
        Set the unique ID for the geofence geometry.
        Parameters:
        geometryId - the geometryId value to set
        Returns:
        the MapsGeofenceGeometry object itself.
      • nearestLat

        public Double nearestLat()
        Get latitude of the nearest point of the geometry.
        Returns:
        the nearestLat value
      • withNearestLat

        public MapsGeofenceGeometry withNearestLat​(Double nearestLat)
        Set latitude of the nearest point of the geometry.
        Parameters:
        nearestLat - the nearestLat value to set
        Returns:
        the MapsGeofenceGeometry object itself.
      • nearestLon

        public Double nearestLon()
        Get longitude of the nearest point of the geometry.
        Returns:
        the nearestLon value
      • withNearestLon

        public MapsGeofenceGeometry withNearestLon​(Double nearestLon)
        Set longitude of the nearest point of the geometry.
        Parameters:
        nearestLon - the nearestLon value to set
        Returns:
        the MapsGeofenceGeometry object itself.
      • udId

        public String udId()
        Get the unique id returned from user upload service when uploading a geofence. Will not be included in geofencing post API.
        Returns:
        the udId value
      • withUdId

        public MapsGeofenceGeometry withUdId​(String udId)
        Set the unique id returned from user upload service when uploading a geofence. Will not be included in geofencing post API.
        Parameters:
        udId - the udId value to set
        Returns:
        the MapsGeofenceGeometry object itself.