Geofence API functions - Qualcomm Dragonwing Documentation

Geofence API functions are used to add, remove, modify, pause, or resume location geofencing sessions. Invoke the geofence APIs after invoking CapabilitiesCb, which is registered with the LocationClient constructor.

addGeofences

Adds any number of geofences.

The geofenceBreachCallback delivers the status of each geofence according to the geofence parameter.
If this API is called when any previous position/batching/geofence session hasn’t yet received responseCallback, then this API receives an error code of LOCATION_RESPONSE_REQUEST_ALREADY_IN_PROGRESS via its responseCallback.

Syntax

void addGeofences(std::vector<Geofence>& geofences, GeofenceBreachCb gfBreachCb,
CollectiveResponseCb responseCallback);

Parameters

Parameter	Description
`geofences`	Geofence objects. When `addGeofences` is returned, each geofence object in the vector serves as the identifier throughout the remaining communication of that geofence. Such a geofence object can be copied or cloned, but they all reference the same geofence.
`gfBreachCb`	Callback to receive geofences state change. If `gfBreachCb` is null, `addGeofences` is no-op.
`responseCallback`	(Optional) Callback to receive geofence IDs and system responses.

Response None

removeGeofences

Removes any number of geofences. Syntax

void removeGeofences(std::vector<Geofence>& geofences);

Parameters

Parameter	Description
`geofences`	Geofence objects. This parameter must be originally added to the system; otherwise it is a no-op.

Response None

modifyGeofences

Modifies any number of geofences. Syntax

void modifyGeofences(std::vector<Geofence>& geofences);

Parameters

Parameter	Description
`geofences`	Geofence objects. Geofence objects must be originally added to the system; otherwise it is a no-op. The fields that can be modified include `breachTypeMask`, `responsiveness`, and `dwelltime`. A geofence that has been added to the system may have these fields modified. But it does not take any effect until `modifyGeofences()` is called with the changed geofence passed in.

Response None

pauseGeofences

Pauses any number of geofences similar to removeGeofences, however, they can be resumed anytime. Syntax

void pauseGeofences(std::vector<Geofence>& geofences);

Parameters

Parameter	Description
`geofences`	Geofence objects. Geofence objects must be originally added to the system; otherwise it is a no-op.

Response None

resumeGeofences

Resumes any number of geofences that are currently paused. Syntax

void resumeGeofences(std::vector<Geofence>& geofences);

Parameters

Parameter	Description
`geofences`	Geofence objects. This parameter must be originally added to the system; otherwise it is a no-op.

Response None

​addGeofences

​removeGeofences

​modifyGeofences

​pauseGeofences

​resumeGeofences

addGeofences

removeGeofences

modifyGeofences

pauseGeofences

resumeGeofences