SDK Installation

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

Ionic framework 4.0 is needed to support Ionic native plugins such as this one. If you are using older versions of Ionic framework and want to use Smartlook SDK, you can use our Cordova SDK directly.

Installation

1. Install Smartlook Ionic native plugin:

npm install @ionic-native/smartlook --save

2. Add Cordova plugin plugin to your project:

ionic cordova plugin add cordova-plugin-smartlook

3. Inject Smartlook SDK into app.module.ts:

import { Smartlook } from '@ionic-native/smartlook/ngx';

@NgModule({
  ...

  providers: [Smartlook, ...]

  ...
})
export class AppModule {}

4. Import Smartlook and SmartlookSetupConfig into app.component.ts and setup the SDK in platform ready callback:

import { Smartlook, SmartlookSetupConfig } from '@ionic-native/smartlook/ngx';

@Component( ... )
export class AppComponent {
	constructor(private smartlook: Smartlook) {
  	this.platform.ready().then(() => {
      this.smartlook.setupAndStartRecording(new SmartlookSetupConfig("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.

5. 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