Library Versions
The latest libraries are part of Crowd Connected's 'V3' platform and are not backward compatible with the older 'V2' platform.
If you are upgrading from the V2 platform, see the V2 to V3 upgrade FAQ.
If you are already using the V3 platform, see the iOS Release Notes.
Introduction to Modules
The iOS SDK comprises four modules. Every integration requires the Core Module, and this is covered in the Base Integration guide.
The Core Module provides no functionality on its own, so you will need to include at least one of the three additional modules.
The following module combinations are currently supported
| Indoor Positioning using iBeacons. No GPS support. | |
| Indoor positioning using either iBeacons or Eddystone beacons. (Using both simultaneously is not supported.) No GPS support. | |
| GPS location data - no Indoor Positioning support. |
Integrating indoor positioning and GPS positioning in a single app is supported from library version 1.2.0. Just include all the required modules together.
Foreground vs Background usage
The Base Integration guide covers permissions required for foreground use only. This covers the navigation use case. If you want to gather location data from apps running in the background, then you will also need to follow the steps in the Background Data Collection guide.
App Credentials
When you start the library, you will need an app key, a token and a secret. If you don't have an app key, you can register for a new account here.
Once you have an account, you can follow the Tokens guide to generate the token and secret.
Aliases
The use cases for background data collection (analytics, and message targeting) often require that the location data is matched to a user id. You can set these alternative IDs as aliases. The process is covered in the Setting a Device Alias guide.