Android SDK - SDK Overview
The ForeSee Replay for Mobile SDK ships as a single AAR file that contains ForeSee’s two mobile products: Trigger and Replay. The current version of the SDK supports Android 4.0 – 6.0.1.
The Trigger module allows clients to define loyalty criteria and track a user’s progress towards fulfillment. Once fulfilled, the user is automatically invited to participate in a satisfaction survey.
Replay allows clients to record how a user interacts with an application. The application’s screen is recorded along with gestures which together are used to produce a movie on ForeSee’s servers. Replay is dependent on Trigger. Only users that have opted to participate in a satisfaction survey have their recordings sent to the servers.
Instrumenting your app
Once the client has incorporated the SDK into their app (see the Quick Start article) they are responsible for instrumenting the app. There are two main decisions the client needs to make:
- Defining the loyalty criteriaAll configuration is done through the provided
foresee_configuration.jsonfile that added in Step 2 of ‘Instrumenting your code’ section of the Quick Start page. Please consult the Configuration article for more information.
- Checking if the user has met the loyalty criteriaThe Trigger module automatically tracks the users 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 the client 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 invitation is presented.It is recommended to call
ForeSee.checkIfEligibleForSurvey()when the app is launched and when the app is resumed.
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