com.codename1.location

Class Geofence

java.lang.Object

com.codename1.location.Geofence

public class Geofence
extends Object

Metadata for geofencing support that allows tracking user location in the background while the app is inactive.
The sample below tracks location and posts a notification or shows a dialog based on the state of the app:

NOTE: For iOS you must include the ios.background_modes build hint with a value that includes "location" for geofencing to work.

Geofencing is not supported on all platforms, use LocationManager.isGeofenceSupported() to find out if the current platform supports it at runtime.

The maximum number of simulataneous Geofences allowed will vary by platform. iOS currently has a maximum of 20, and Android has a maximum of 100. If you need to track more than 20 at a time, consider using the GeofenceManager class to manage your Geofences, as it will allow you to effectively track an unlimited number of regions.

Author:

Chen

See Also:

LocationManager.isGeofenceSupported(), LocationManager.addGeoFencing(java.lang.Class, com.codename1.location.Geofence), LocationManager.removeGeoFencing(java.lang.String), GeofenceListener

Constructor Summary

Constructors

Constructor and Description
Geofence(String id, Location loc, int radius, long expiration) Constructor

Method Summary

Modifier and Type	Method and Description
static Comparator<Geofence>	createDistanceComparator(Geofence refRegion) Creates a comparator for sorting Geofences from the current Geofence.
static Comparator<Geofence>	createDistanceComparator(Location refPoint) Creates a comparator for sorting Geofences from the given reference point.
boolean	equals(Object o) Geofences are equal if their id, radius, and expiration are the same, and the location latitude and longitude are the same.
double	getDistanceTo(Geofence gf) Gets the distance between the current region and the given region.
long	getExpiration() Gets the expiration duration (from now) of the Geofence in milliseconds.
String	getId() Gets the Geofence ID.
Location	getLoc() Gets the location of the Geofence.
int	getRadius() Gets the radius of the geofence in metres.

Methods inherited from class java.lang.Object

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

Constructor Detail

Geofence

public Geofence(String id,
                Location loc,
                int radius,
                long expiration)

Constructor

Parameters:

id - unique identifier

loc - the center location of this Geofence

radius - the radius in meters. Note that the actual radius will vary on an actual device depending on the hardware and OS. Typical android and iOS devices have a minimum radius of 100m.

expiration - the expiration time in milliseconds. Note that this is a duration, not a timestamp. Use -1 to never expire.

Method Detail

getId

public String getId()

Gets the Geofence ID.

Returns:

the id

getLoc

public Location getLoc()

Gets the location of the Geofence.

Returns:

the center Location

getExpiration

public long getExpiration()

Gets the expiration duration (from now) of the Geofence in milliseconds.

Returns:

the Geofence expiration

getRadius

public int getRadius()

Gets the radius of the geofence in metres. Note that the actual radius will vary on an actual device depending on the hardware and OS. Typical android and iOS devices have a minimum radius of 100m.

Returns:

Geofence radius

getDistanceTo

public double getDistanceTo(Geofence gf)

Gets the distance between the current region and the given region.

Parameters:

gf -

Returns:

createDistanceComparator

public static Comparator<Geofence> createDistanceComparator(Geofence refRegion)

Creates a comparator for sorting Geofences from the current Geofence.

Returns:

createDistanceComparator

public static Comparator<Geofence> createDistanceComparator(Location refPoint)

Creates a comparator for sorting Geofences from the given reference point.

Returns:

equals

public boolean equals(Object o)

Geofences are equal if their id, radius, and expiration are the same, and the location latitude and longitude are the same.

Overrides:

equals in class Object

Parameters:

o -

Returns: