iOS SDK - SDK Overview
The ForeSee cxReplay for Mobile SDK is a single static framework that encapsulates ForeSee’s two mobile products: Trigger and cxReplay. The current version of the SDK supports iOS versions 7.0 – 9.2.
The Trigger module allows you to define loyalty criteria and track a user’s progress towards fulfillment. Once fulfilled, they are automatically invited to participate in a satisfaction survey.
cxReplay records how a user interacts with the application. The user’s screen is recorded along with gestures, which together are used to produce a movie on the ForeSee servers. cxReplay is dependent on Trigger. Only users who have opted to participate in a satisfaction survey have their recordings sent to ForeSee servers.
Instrumenting your app
Once you have incorporated the SDK into your app (see the Quick Start article) you are responsible for instrumenting your app. There are two main tasks to be performed:
- Define the loyalty criteria All configuration is done through the provided
foresee_configuration.jsonfile that must added to the client’s project. Consult the Configuration article for more information on what this file should contain.
- Check if the user has met the loyalty criteria The Trigger module automatically tracks the user’s progress towards fulfilling the loyalty criteria, but the client must decide when to check if the user has become eligible for a survey. There is a single API method,
[ForeSee checkIfEligibleForSurvey]that you can call to check the user’s current eligibility status. If the user has fulfilled the loyalty criteria and is in the sampling pool, an invite is presented. It is recommended that you call
[ForeSee checkIfEligibleForSurvey]when the app is launched and when the app is resumed. While it may be preferable from a user experience perspective to place the call elsewhere, care must be taken that all users trigger this call to avoid skewing the response data or reducing the number of respondents.
Also in the SDK
The SDK package also contains
- Sample projects: these are found in the ‘samples’ folder of the zip file and give examples of how to implement the SDK in a number of different scenarios
- API docs: These are found in the ‘docs’ folder of the zip – they explain the various functions available within the app and how to use them
For more detailed information, we encourage you to read the Frequently Asked Questions page, which contains important information about data storage, security and compatibility. If you have any problems implementing the SDK, please consult the Troubleshooting page which has useful information on the correct way to adjust the behaviour of the SDK during testing or to remotely disable the SDK in the unlikely situation that a problem arises in the production environment.