Cordova

UXCam Cordova SDK Installation & Quick Start

npm versionnpm version

📘

AndroidX

UXCam android SDK requires AndroidX; add this to your config.xml file:

<preference name="AndroidXEnabled" value="true" />

Cordova Integration

  1. Add UXCam to your project

    cordova plugin add cordova-uxcam
  2. Call this method on onDeviceReady(). Your App-key is available from UXCam dashboard.

    UXCam.optIntoSchematicRecordings() //To enable session video recording on iOS 
    
    const configuration = {
        userAppKey: 'YOUR API KEY',
        enableAutomaticScreenNameTagging:false,
        enableImprovedScreenCapture:true,
    }
    
    UXCam.startWithConfiguration(configuration);
    

Ionic Integration

  1. Add UXCam to your project

    ionic cordova plugin add cordova-uxcam
  2. On your file, AppComponent.ts, add the following line under imports

    declare var UXCam:any;
  3. Call this method on platform.ready(). Your App-key is available from UXCam dashboard.

    UXCam.optIntoSchematicRecordings() //To enable session video recording on iOS 
    
    const configuration = {
        userAppKey: 'YOUR API KEY',
        enableAutomaticScreenNameTagging:false,
        enableImprovedScreenCapture:true,
    }
    
    UXCam.startWithConfiguration(configuration);
    

Capacitor Integration

  1. Add UXCam to your project

    Npm install cordova-uxcam
  2. On your file, AppComponent.ts, add the following line under imports

    declare var UXCam:any;
  3. Call this method on platform.ready(). Your App-key is available from UXCam dashboard.

    UXCam.optIntoSchematicRecordings() //To enable session video recording on iOS 
    
    const configuration = {
        userAppKey: 'YOUR API KEY',
        enableAutomaticScreenNameTagging:false,
        enableImprovedScreenCapture:true,
    }
    
    UXCam.startWithConfiguration(configuration);
    

🚧

OkHttp Error

If you are getting the following message: Failed resolution of: Lokhttp3/Callback; - Please follow this steps:

  1. Go to Platforms > Android > App > build.gradle and add the following dependency:
  2. implementation("com.squareup.okhttp3:okhttp:4.9.3")

This should solve the problem and the integration should be completed.

👍

That completes the integration process.

Your session will be shown on the dashboard within a few seconds after the app goes in the background. You can optionally use the API'es for customizations such as identifying users from your database with UXCam, tagging sessions or hiding sensitive views.

📘

SDK Updates

To check all the information on the fixes and improvements on the latest versions of the SDK, please visit this page.


What’s Next