SDK

Location Services

In this page you'll dive deeper into functionality like using GPS signals to get the user's location or monitor their visits to regions and proximity to BTLE devices. These services will bring a new level of contextuality to your app, allowing you to create geo-triggers to send notifications or categorize users based on their location behaviour.

Tracking a user location in iOS will require the user's authorization, this means that your app must declare usage description texts explaining why it needs to track location. For older versions of iOS you may optionally declare the key NSLocationUsageDescription in your app's .plist file. In iOS8 and higher, is it mandatory the use of the key NSLocationAlwaysUsageDescription. In iOS 11 a new permission was introduced and you are required to include both NSLocationAlwaysAndWhenInUseUsageDescription and NSLocationWhenInUseUsageDescription in your app's .plist file. Bottom line if you are supporting iOS 7 and up you'll need to include the following in your app's .plist file:

ios location privacy plist entries

Make sure you provide a text that best describes why and how you are going to use the user’s location. This text will be displayed to the user the first time you request the use of location services. Users are more likely to trust your app with location data if they understand why you need it.

Location Updates

Location services can only be requested after a successful device registration. To make sure this happens correctly, the best place to request location services is right after a device registration:

Notificare.on('deviceRegistered', function(data) {
    //It would be safe to request it after this point
    Notificare.startLocationUpdates();
});

But in most cases you will want to start location updates only after a user clicks on a certain button after going through some on-boarding screen that explains why location updates are needed. In those cases you would implement something like this:

document.getElementById("myButton").addEventListener('click', function() {
    //It would be safe to request it after this point
    Notificare.startLocationUpdates();
});

The first time this is requested, it will prompt the user with a permission dialogue. If the user agrees to share location with your app, Notificare will automatically start monitoring significant location changes (roughly every 500m/1,640ft). It will also start monitoring for the nearest regions and beacons you might have created in our dashboard or API. This is basically all it takes to use location services, at this point you should be able to manage all your regions, geo-triggers, beacons and send geo-targeted notifications through our dashboard or API.

You will also want to change the way location updates are requested after the user has accepted it. To make sure a location update is requested right away when your app launches and a user has already given permission to do so, you will want to implement the following:

Notificare.on('ready', (data) => {
    Notificare.isLocationServicesEnabled(function(status){
        if (status) {
            Notificare.startLocationUpdates();
        }
    });
});

Location Services Events

In order for you to update your app's UI, react programmatically to location updates or any other custom implementation you might want to add, you should implement the following delegates. Please note that the implementation of these events is optional and simply using the dashboard or API to create interactions using location should be enough to create engaging experiences.

This delegate will be triggered whenever you start tracking location. When this delegate is triggered, it is possible to request the authorization status for location services:

Notificare.on('locationServiceAuthorizationStatusReceived', function(data) {

});

The following delegate will be triggered if locations services could not be started. Typically you can use this delegate to retry again in case it's a network related error or find out why your app is incorrectly configured to use location services:

Notificare.on('locationServiceFailedToStart', function(data) {

});

This following delegate will be called when location updates are received. It will contain an array of one or more CLLocation objects. This array always contains at least one object representing the current location. If updates were deferred or if multiple locations arrived before they could be delivered, the array may contain additional entries. The objects in the array are organized in the order in which they occurred. Therefore, the most recent location position is at the end of the array.

Notificare.on('locationsUpdated', function(data) {

});

If you've created Geo-Zones in Notificare, you may want get information of the regions being monitored or any events and errors that might occur. This will display all the regions that started being monitored:

Notificare.on('monitoringForRegionStarted', function(data) {

});

You can also get the information if Geo-Zones failed to be monitored. This could be happen because there is a poor cell reception or any kind of GPS errors:

Notificare.on('monitoringForRegionFailed', function(data) {

});

You can also track Geo-Zones states by implementing the following delegate:

Notificare.on('stateForRegionChanged', function(data) {

});

Finally, you can also be informed whenever the user enters or leaves a certain region:

Notificare.on('regionEntered', function(data) {

});

Notificare.on('regionExited', function(data) {

});

Using iBeacons

This technology will require the device to have Bluetooth Service ON. If enabled your app will monitor any BTLE device in the vicinity. By default this is automatically done by our library so there is not really any additionally step to take.

However you might want to retrieve the proximity level of any beacons around you. This is only possible while the app is in foreground. To get this information you will need to implement the following delegate:

Notificare.on('beaconsInRangeForRegion', function(data) {

});

If by any reason your app fails to start ranging beacons, it will trigger the following delegate:

Notificare.on('rangingBeaconsFailed', function(data) {

});

Using Visits API

As part of our location services feature, you will be able to use Apple's Visits API. This API will allow you to get events whenever users visit a location. This might be a great way to discover where areas a user visits. To use this feature you will need to turn the USE_VISITS_API property to YES, under OPTIONS in your app's Notificare.plist:

notificare use visits api

When enabled, as soon as you start location updates you will be receiving visits events too. To handle those visits make sure you implement the following delegate method:

Notificare.on('visitReceived', function(data) {

});

Using Heading API

Also part of our location services feature, Apple's Heading API will allow you to obtain the user's current heading. To use this feature you will need to turn the USE_HEADING_API property to YES, under OPTIONS in your app's Notificare.plist:

notificare use heading api

When enabled, as soon as you start location updates you will be receiving heading events too. To handle those visits make sure you implement the following delegate method:

Notificare.on('headingUpdated', function(data) {

});