com.radiusnetworks.proximity

Class ProximityKitGeofenceRegion

java.lang.Object

com.radiusnetworks.proximity.ProximityKitGeofenceRegion

All Implemented Interfaces:

ProximityRegion

public class ProximityKitGeofenceRegion
extends Object
implements ProximityRegion

Represents a geofence region as defined on the Proximity Kit cloud.

This provides access to a geofence's location and size. As well as any custom attributes configured via Proximity Kit.

Since:

0.1.0

Method Summary

Modifier and Type	Method and Description
Map	getAttributes() Set of custom attributes configured for this geofence on Proximity Kit.
String	getIdentifier() Entity identifier for this geofence region.
Double	getLatitude() Getter for accessing this geofence's latitude.
Double	getLongitude() Getter for accessing this geofence's longitude.
String	getName() Getter for accessing this geofence's name.
Double	getRadius() Getter for accessing this geofence's configured radius.
String	getRequestId() Custom ID representation of this geofence to identify it in a map.
boolean	regionEquals(ProximityKitGeofenceRegion otherRegion) Returns whether the supplied ProximityKitGeofenceRegion is equivalent to this one

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getLatitude

public Double getLatitude()

Getter for accessing this geofence's latitude.

Returns:

Latitude of the geofence

getLongitude

public Double getLongitude()

Getter for accessing this geofence's longitude.

Returns:

Longitude of the geofence.

getRadius

public Double getRadius()

Getter for accessing this geofence's configured radius.

Returns:

The radius of the circular region this geofence covers.

getRequestId

public String getRequestId()

Custom ID representation of this geofence to identify it in a map.

Returns:

String representation of an ID representing this geofence region.

getAttributes

public Map getAttributes()

Set of custom attributes configured for this geofence on Proximity Kit.

Specified by:

getAttributes in interface ProximityRegion

Returns:

custom key:value attributes for this geofence.

getIdentifier

public String getIdentifier()

Entity identifier for this geofence region.

This uniquely identifies the geofence region within the kit.

Specified by:

getIdentifier in interface ProximityRegion

Returns:

this region's entity identifier or null if it wasn't provided by the kit

Since:

0.13.0

getName

public String getName()

Getter for accessing this geofence's name.

Specified by:

getName in interface ProximityRegion

Returns:

String of the geofence's name.

Since:

0.11.0

regionEquals

public boolean regionEquals(ProximityKitGeofenceRegion otherRegion)

Returns whether the supplied ProximityKitGeofenceRegion is equivalent to this one

Parameters:

otherRegion - The ProximityKitGeofenceRegion to be compared to this one

Returns:

true if the two geofence regions have the same latitude, longitude, and radius; false otherwise