com.mapzen.android.lost.api

Interface GeofencingApi

All Known Implementing Classes:

GeofencingApiImpl

public interface GeofencingApi

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXTRA_GEOFENCE_LIST Extra passed in Intent that is fired when requesting proximity updates.
static java.lang.String	EXTRA_TRANSITION Extra passed in Intent that is fired when requesting proximity updates.
static java.lang.String	EXTRA_TRIGGERING_LOCATION Extra passed in Intent that is fired when requesting proximity updates.

Method Summary

Modifier and Type	Method and Description
PendingResult<Status>	addGeofences(LostApiClient client, GeofencingRequest geofencingRequest, android.app.PendingIntent pendingIntent) Sets PendingIntent to be notified when the device enters or exits one of the specified geofences.
PendingResult<Status>	addGeofences(LostApiClient client, java.util.List<Geofence> geofences, android.app.PendingIntent pendingIntent) Deprecated. Use addGeofences(LostApiClient, GeofencingRequest, PendingIntent) instead. Sets PendingIntent to be notified when the device enters or exits one of the specified geofences.
PendingResult<Status>	removeGeofences(LostApiClient client, java.util.List<java.lang.String> geofenceRequestIds) Removes geofences for a given list of request ids
PendingResult<Status>	removeGeofences(LostApiClient client, android.app.PendingIntent pendingIntent) Removes geofences for a given PendingIntent

Field Detail

EXTRA_TRANSITION

static final java.lang.String EXTRA_TRANSITION

Extra passed in Intent that is fired when requesting proximity updates. Value is an integer.

See Also:

Constant Field Values

EXTRA_GEOFENCE_LIST

static final java.lang.String EXTRA_GEOFENCE_LIST

Extra passed in Intent that is fired when requesting proximity updates. Value is array of Geofence objects.

See Also:

Constant Field Values

EXTRA_TRIGGERING_LOCATION

static final java.lang.String EXTRA_TRIGGERING_LOCATION

Extra passed in Intent that is fired when requesting proximity updates. Value is Location object.

See Also:

Constant Field Values

Method Detail

addGeofences

PendingResult<Status> addGeofences(LostApiClient client,
                                   GeofencingRequest geofencingRequest,
                                   android.app.PendingIntent pendingIntent)

Sets PendingIntent to be notified when the device enters or exits one of the specified geofences.

Parameters:

client - Connected client to receive geofence updates for.

geofencingRequest - Request containing geofences to receive updates for.

pendingIntent - Intent to be notified when geofences are entered/exited.

Throws:

java.lang.IllegalStateException - if the client is not connected at the time of this call.

addGeofences

PendingResult<Status> addGeofences(LostApiClient client,
                                   java.util.List<Geofence> geofences,
                                   android.app.PendingIntent pendingIntent)

Deprecated. Use addGeofences(LostApiClient, GeofencingRequest, PendingIntent) instead. Sets PendingIntent to be notified when the device enters or exits one of the specified geofences.

Parameters:

client - Connected client to receive geofence updates for.

geofences - Geofences to receive updates for.

pendingIntent - Intent to be notified when geofences are entered/exited.

Throws:

java.lang.IllegalStateException - if the client is not connected at the time of this call.

removeGeofences

PendingResult<Status> removeGeofences(LostApiClient client,
                                      java.util.List<java.lang.String> geofenceRequestIds)

Removes geofences for a given list of request ids

Parameters:

client - Connected client to remove geofence updates for.

geofenceRequestIds - Geofence ids to remove updates for.

Throws:

java.lang.IllegalStateException - if the client is not connected at the time of this call.

removeGeofences

PendingResult<Status> removeGeofences(LostApiClient client,
                                      android.app.PendingIntent pendingIntent)

Removes geofences for a given PendingIntent

Parameters:

client - Connected client to remove geofence updates for.

pendingIntent - Intent to remove updates for.

Throws:

java.lang.IllegalStateException - if the client is not connected at the time of this call.