Geofence

Stay organized with collections Save and categorize content based on your preferences.
public interface Geofence

Represents a geographical region, also known as a geofence. Geofences can be monitored by geofencer service. And when the user crosses the boundary of a geofence, an alert will be generated.

Nested Class Summary

class Geofence.Builder A builder that builds Geofence
@interface Geofence.GeofenceTransition Geofence transition event. 
@interface Geofence.TransitionTypes Geofence transition types of interest, as either 0 or a bitwise-OR of GEOFENCE_TRANSITION_ flags. 

Constant Summary

int GEOFENCE_TRANSITION_DWELL The transition type indicating that the user enters and dwells in geofences for a given period of time.
int GEOFENCE_TRANSITION_ENTER The transition type indicating that the user enters the geofence(s).
int GEOFENCE_TRANSITION_EXIT The transition type indicating that the user exits the geofence(s).
long NEVER_EXPIRE Expiration value that indicates the geofence should never expire.

Public Method Summary

abstract long
getExpirationTime()
Returns the expiration elapsed realtime of geofence in milliseconds, or NEVER_EXPIRE if there's no expiration.
abstract double
getLatitude()
Returns latitude in degrees, between -90 and +90 inclusive.
abstract int
getLoiteringDelay()
Returns the delay between GEOFENCE_TRANSITION_ENTER and GEOFENCE_TRANSITION_DWELL in milliseconds.
abstract double
getLongitude()
Returns longitude in degrees, between -180 and +180 inclusive.
abstract int
getNotificationResponsiveness()
Returns the best-effort description of how soon should the callback be called when the transition associated with the Geofence is triggered, in milliseconds.
abstract float
getRadius()
Returns radius in meters.
abstract String
getRequestId()
Returns the request ID of this geofence.
abstract int
getTransitionTypes()
Returns the transition types of interest as a bitwise-OR of GEOFENCE_TRANSITION_ flags.

Constants

public static final int GEOFENCE_TRANSITION_DWELL

The transition type indicating that the user enters and dwells in geofences for a given period of time. If GEOFENCE_TRANSITION_ENTER is also specified, this alert will always be sent after the GEOFENCE_TRANSITION_ENTER alert.

You must set the duration of loitering before this alert is sent using Geofence.Builder.setLoiteringDelay(int).

Constant Value: 4

public static final int GEOFENCE_TRANSITION_ENTER

The transition type indicating that the user enters the geofence(s).

Constant Value: 1

public static final int GEOFENCE_TRANSITION_EXIT

The transition type indicating that the user exits the geofence(s).

Constant Value: 2

public static final long NEVER_EXPIRE

Expiration value that indicates the geofence should never expire.

Constant Value: -1

Public Methods

public abstract long getExpirationTime ()

Returns the expiration elapsed realtime of geofence in milliseconds, or NEVER_EXPIRE if there's no expiration. When positive, this geofence will be removed automatically after that time.

public abstract double getLatitude ()

Returns latitude in degrees, between -90 and +90 inclusive.

public abstract int getLoiteringDelay ()

Returns the delay between GEOFENCE_TRANSITION_ENTER and GEOFENCE_TRANSITION_DWELL in milliseconds.

public abstract double getLongitude ()

Returns longitude in degrees, between -180 and +180 inclusive.

public abstract int getNotificationResponsiveness ()

Returns the best-effort description of how soon should the callback be called when the transition associated with the Geofence is triggered, in milliseconds.

public abstract float getRadius ()

Returns radius in meters.

public abstract String getRequestId ()

Returns the request ID of this geofence. The request ID is a string to identify this geofence inside your application. When two geofences with the same requestId are monitored, the new one will replace the old one regardless the geographical region these two geofences represent.

public abstract int getTransitionTypes ()

Returns the transition types of interest as a bitwise-OR of GEOFENCE_TRANSITION_ flags.