SDK Installation

Currently the minimal supported version is Jelly Bean (API 18) for Android and 10 for iOS.

👍

In the version 1.8.0 we have added TypeScript typings.

Installation

1. Add Cordova plugin to your project using this command:

cordova plugin add cordova-plugin-smartlook

2. Setup and start Smartlook on deviceready callback:

if(document.readyState === "complete") {
  document.addEventListener("deviceready", onDeviceReady, false);
}

function onDeviceReady() {
    Smartlook.setupAndStartRecording({smartlookAPIKey: "YOUR_API_KEY"});
}

📘

API Key

To setup Smartlook, the unique project API Key is needed. It can be found in the mobile project settings in the Smartlook Dashboard.

3. Smartlook now starts recording the app. The recordings will appear in the Smartlook player shortly.

📘

Recording when on mobile network

SDK will upload sessions only on WiFi. When uploading on mobile connections is requested, too, it must be enabled in the project settings in the dashboard. More details about the recording process can be found in the Conceptual documentation

4. To access the TypeScript types you will need to explicitly set the type folder roots. Add this to your project's tsconfig.json:

"typeRoots": ["./node_modules/@types", "./node_modules/cordova-plugin-smartlook/globalTypes"]

So the whole file will look for example like:

{
	"compilerOptions": {
		"target": "es5",
		"module": "commonjs",
		"sourceMap": true,
		"typeRoots": ["./node_modules/@types", "./node_modules/cordova-plugin-smartlook/globalTypes"],
		"skipLibCheck": true,
		"esModuleInterop": true,
		"moduleResolution": "node"
	},
	"include": ["src/js"]
}