com.mapzen.android.lost.api

Class Geofence.Builder

java.lang.Object

com.mapzen.android.lost.api.Geofence.Builder

Enclosing interface:

Geofence

public static final class Geofence.Builder
extends java.lang.Object

Builder class for Geofence.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Geofence	build() Construct and return a new Geofence object from the Geofence.Builder's properties.
Geofence.Builder	setCircularRegion(double latitude, double longitude, float radius) Sets the latitude, longitude, and radius for the Geofence.Builder.
Geofence.Builder	setExpirationDuration(long durationMillis) Sets the duration in millis for the Geofence.Builder.
Geofence.Builder	setLoiteringDelay(int loiteringDelayMs) Sets the loitering delay in millis for the Geofence.Builder.
Geofence.Builder	setNotificationResponsiveness(int notificationResponsivenessMs) Not yet implemented
Geofence.Builder	setRequestId(java.lang.String requestId) Sets the request id for the Geofence.Builder.
Geofence.Builder	setTransitionTypes(int transitionTypes) Sets the transition type for the Geofence.Builder.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public Geofence build()

Construct and return a new Geofence object from the Geofence.Builder's properties.

Returns:

new Geofence object.

setCircularRegion

public Geofence.Builder setCircularRegion(double latitude,
                                          double longitude,
                                          float radius)

Sets the latitude, longitude, and radius for the Geofence.Builder.

Parameters:

latitude - in degrees.

longitude - in degrees.

radius - in meters.

Returns:

the Geofence.Builder object.

setExpirationDuration

public Geofence.Builder setExpirationDuration(long durationMillis)

Sets the duration in millis for the Geofence.Builder.

Parameters:

durationMillis - duration in milliseconds.

Returns:

the Geofence.Builder object.

setLoiteringDelay

public Geofence.Builder setLoiteringDelay(int loiteringDelayMs)

Sets the loitering delay in millis for the Geofence.Builder. If transition type is set to dwell then this value is used, otherwise it is ignored.

Parameters:

loiteringDelayMs - duration in milliseconds.

Returns:

the Geofence.Builder object.

setNotificationResponsiveness

public Geofence.Builder setNotificationResponsiveness(int notificationResponsivenessMs)

Not yet implemented

setRequestId

public Geofence.Builder setRequestId(java.lang.String requestId)

Sets the request id for the Geofence.Builder.

Parameters:

requestId - id to be used for geofence.

Returns:

the Geofence.Builder object.

setTransitionTypes

public Geofence.Builder setTransitionTypes(int transitionTypes)

Sets the transition type for the Geofence.Builder.

Parameters:

transitionTypes - types to be used for geofence.

Returns:

the Geofence.Builder object.