NativeScript

UXCam NativeScript SDK Installation & Quick Start

npm version

Follow the instructions below for the integration on iOS and Android

SDK Installation

  1. To add UXCam to your project

    tns plugin add nativescript-uxcam
  2. Import the UXCam plugin code at the top of your App Component file:

    import {NSUXCam} from 'nativescript-uxcam';
  3. Then start the UXCam system from inside you component code. Your App-key is available from UXCam dashboard.

    var config = { 
         'userAppKey': 'your-app-key', 
    }
    NSUXCam.optIntoSchematicRecordings(); // Add this line to enable iOS screen recordings  
    NSUXCam.startWithConfiguration(config); // Add this line after NSUXCam.optIntoSchematicRecordings();

Here are some examples of where the SDK should start if using Angular or Vue with your Nativescript project:

export default Vue.extend({

mounted() {    
 NSUXCam.optIntoSchematicRecordings();
 NSUXCam.startWithConfiguration(config);

},});
import { Component, OnInit } from '@angular/core'
import {NSUXCam} from 'nativescript-uxcam';

var config = { 
  'userAppKey': 'your-app-key>', 
}

@Component({
  selector: 'ns-app',
  templateUrl: 'app.component.html',
})
export class AppComponent implements OnInit {
  constructor() {

    NSUXCam.optIntoSchematicRecordings(); // Add this line to enable iOS screen recordings  
    NSUXCam.startWithConfiguration(config); 
    // Use the component constructor to inject providers.
  }

πŸ‘

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