To enable device location awareness (DLA) in your Cordova app, do the following:

In the root directory of your project, open the CampaignConfig.json file.
Make sure the location plugin in the plugins section is enabled.

{
  "plugins": {
    "useRelease": false,
    
    "Required Mobile-Push plugins": "<true/false>, enable or disable plugin",
    "cordova-acoustic-mobile-push": true,
    "cordova-acoustic-mobile-push-plugin-ios-notification-service": true,
    "cordova-acoustic-mobile-push-plugin-inapp": true,
    "cordova-acoustic-mobile-push-plugin-inbox": true,
    
    "Optional Mobile-Push plugins": "<true/false>, enable or disable plugin",
    "cordova-acoustic-mobile-push-plugin-action-menu": true,
    "cordova-acoustic-mobile-push-plugin-beacon": true,
    "cordova-acoustic-mobile-push-plugin-calendar": true,
    "cordova-acoustic-mobile-push-plugin-displayweb": true,
    "cordova-acoustic-mobile-push-plugin-geofence": true,
    "cordova-acoustic-mobile-push-plugin-location": true,
    "cordova-acoustic-mobile-push-plugin-passbook": true,
    "cordova-acoustic-mobile-push-plugin-snooze": true
  }
}

Review the settings in the location section of CampaignConfig.json.
If the autoInitialize property in the location section is set to false, start location services and monitoring for locations by calling the manualLocationInitialization method.

Location module

Methods

(static) `locationAuthorization()`

This method reports if the app has authorization to use location services. It can report the following values:

-2 - the app has foreground only access to location services (use the manualLocationInitialization method)
-1 - the app is not authorized to use location services
0 - the app has not yet requested to use location services (use the manualLocationInitialization method)
1 - the app has complete access to location services

(static) `manualLocationInitialization()`

Use this method to manually initialize location services for the Campaign library. This lets you delay location services initialization until desired.

To enable the method, you must set the Auto initialize location feature to false in the CampaignConfig.json file.

(static) `setLocationAuthorizationCallback()`

This callback is called when access to the location services changes.

(static) `setLocationUpdatedCallback(callback)`

Set callback for location database updates.

Parameter	Type	Definition
`callback`	locationCallback	Callback which will be called when the database is updated.

(static) `syncLocations()`

Prompts the Campaign library to synchronize the geofences with the server. This can only be called once every 5 minutes.

Type definitions

`locationCallback`

The location callback includes no data. When it is received you should refresh your inbox database.

Beacon module

Methods

(static) `beaconEnabled(callback)`

Query if iBeacons are enabled or disabled.

Parameter	Type	Definition
`callback`	beaconEnabledCallback	Response callback

(static) `beaconRegions(callback)`

Query the current iBeacon regions.

Parameter	Type	Definition
`callback`	beaconRegionsCallback	The callback with the current iBeacon regions.

(static) `beaconUUID(callback)`

Query if iBeacon global UUID currently setup.

Parameter	Type	Definition
`callback`	beaconUUIDCallback	Response callback.

(static) `setBeaconEnterCallback(callback)`

Set callback for entering iBeacon regions.

Parameter	Type	Definition
`callback`	beaconCallback	Callback function for entering iBeacon regions.

(static) `setBeaconExitCallback(callback)`

Set callback for exiting iBeacon regions.

Parameter	Type	Definition
`callback`	beaconCallback	Callback function for exiting iBeacon regions.

Type definitions

`Beacon`

Property	Type	Definition
`major`	Integer	Major of beacon region
`minor`	Integer	Minor of beacon region
`locationId`	String	Identifier of beacon region

`beaconCallback(beacon)`

Property	Type	Definition
`beacon`	Beacon	Beacon region entered or left.

`beaconEnabledCallback(status)`

Property	Type	Definition
`status`	Boolean	`true` if iBeacons are enabled, `false` otherwise.

`BeaconMajor`

Property	Type	Definition
`major`	Integer	Major of beacon region

`beaconRegionsCallback(beacons)`

Property	Type	Definition
`beacons`	Array	List of current beacon regions.

`beaconUUIDCallback(status)`

Property	Type	Definition
`status`	String	Beacon global UUID setup.

Geofence module

Methods

(static) `geofenceEnabled(callback)`

Query if geofences are enabled or disabled.

Parameter	Type	Definition
`callback`	geofenceEnabledCallback	Response callback.

(static) `geofencesNear(callback, latitude, longitude, radius)`

Parameter	Type	Definition
`callback`	geofencesNearCallback	Callback data will be provided to
`latitude`	double	Latitude of center of area
`longitude`	double	Longitude of center of area
`radius`	double	Radius of area

(static) `setGeofenceEnterCallback(callback)`

Set callback for entering geofences.

Parameter	Type	Definition
`callback`	geofenceCallback	Callback executed when geofences are entered.

(static) `setGeofenceExitCallback(callback)`

Set callback for exiting geofences.

Parameter	Type	Definition
`callback`	geofenceCallback	Callback executed when geofences are exited.

Type definitions

`Geofence`

Property	Type	Definition
`latitude`	double	Latitude of center of geofence.
`longitude`	double	Longitude of center of geofence.
`radius`	double	Radius of geofence in meters.
`locationId`	String	Unique location identifier.

`geofenceCallback(geofence)`

Property	Type	Definition
`geofence`	Geofence	Geofence entered or exited.

`geofenceEnabledCallback(status)`

Property	Type	Definition
`status`	boolean	`true` if geofences are enabled, `false` otherwise.

`geofencesNearCallback(geofences)`

Property	Type	Definition
`geofences`	Array	List of geofences

Device location awareness for Cordova apps

Location module

Methods

(static) `locationAuthorization()`

(static) `manualLocationInitialization()`

(static) `setLocationAuthorizationCallback()`

(static) `setLocationUpdatedCallback(callback)`

(static) `syncLocations()`

Type definitions

`locationCallback`

Beacon module

Methods

(static) `beaconEnabled(callback)`

(static) `beaconRegions(callback)`

(static) `beaconUUID(callback)`

(static) `setBeaconEnterCallback(callback)`

(static) `setBeaconExitCallback(callback)`

Type definitions

`Beacon`

`beaconCallback(beacon)`

`beaconEnabledCallback(status)`

`BeaconMajor`

`beaconRegionsCallback(beacons)`

`beaconUUIDCallback(status)`

Geofence module

Methods

(static) `geofenceEnabled(callback)`

(static) `geofencesNear(callback, latitude, longitude, radius)`

(static) `setGeofenceEnterCallback(callback)`

(static) `setGeofenceExitCallback(callback)`

Type definitions

`Geofence`

`geofenceCallback(geofence)`

`geofenceEnabledCallback(status)`

`geofencesNearCallback(geofences)`

Related pages

Location module

Methods

(static) locationAuthorization()

(static) manualLocationInitialization()

(static) setLocationAuthorizationCallback()

(static) setLocationUpdatedCallback(callback)

(static) syncLocations()

Type definitions

locationCallback

Beacon module

Methods

(static) beaconEnabled(callback)

(static) beaconRegions(callback)

(static) beaconUUID(callback)

(static) setBeaconEnterCallback(callback)

(static) setBeaconExitCallback(callback)

Type definitions

Beacon

beaconCallback(beacon)

beaconEnabledCallback(status)

BeaconMajor

beaconRegionsCallback(beacons)

beaconUUIDCallback(status)

Geofence module

Methods

(static) geofenceEnabled(callback)

(static) geofencesNear(callback, latitude, longitude, radius)

(static) setGeofenceEnterCallback(callback)

(static) setGeofenceExitCallback(callback)

Type definitions

Geofence

geofenceCallback(geofence)

geofenceEnabledCallback(status)

geofencesNearCallback(geofences)

Related pages

(static) `locationAuthorization()`

(static) `manualLocationInitialization()`

(static) `setLocationAuthorizationCallback()`

(static) `setLocationUpdatedCallback(callback)`

(static) `syncLocations()`

`locationCallback`

(static) `beaconEnabled(callback)`

(static) `beaconRegions(callback)`

(static) `beaconUUID(callback)`

(static) `setBeaconEnterCallback(callback)`

(static) `setBeaconExitCallback(callback)`

`Beacon`

`beaconCallback(beacon)`

`beaconEnabledCallback(status)`

`BeaconMajor`

`beaconRegionsCallback(beacons)`

`beaconUUIDCallback(status)`

(static) `geofenceEnabled(callback)`

(static) `geofencesNear(callback, latitude, longitude, radius)`

(static) `setGeofenceEnterCallback(callback)`

(static) `setGeofenceExitCallback(callback)`

`Geofence`

`geofenceCallback(geofence)`

`geofenceEnabledCallback(status)`

`geofencesNearCallback(geofences)`