Quickstart guide

This guide helps you integrate the DevRev SDK into your Cordova app.

Requirements

• Cordova 12.0 or later.
• Android: minimum API level 24.
• iOS: minimum deployment target 15.0.
• Recommended: an SSH key configured locally and registered with GitHub.

Install

To install the DevRev SDK, run the following command:

cordova plugin add @devrev/sdk-cordova

Set up the DevRev SDK

1. Open the DevRev web app at https://app.devrev.ai and go to the Settings page.
2. Under PLuG settings, copy the value under Your unique App ID.
3. Configure the DevRev SDK in your app using the obtained credentials.

The SDK becomes ready for use once the configuration API is executed.

DevRev.configure(appID, successCallback, errorCallback)

To provide a feature configuration during setup, call the overload that accepts it:

DevRev.configure(appID, featureConfiguration, successCallback, errorCallback)

For default behavior, call the simpler form:

DevRev.configure(appID, function() {
    console.log('DevRev SDK configured successfully.');
}, function(error) {
    console.error('Failed to configure DevRev SDK:', error);
});

To customize behavior such as frame capture, auto-start recording, or theme preferences, pass a full FeatureConfiguration object:

DevRev.configure(appID, {
    enableFrameCapture: false,
    autoStartRecording: false,
    prefersDialogMode: false,
    alwaysUseRemoteConfig: true,
    supportWidgetTheme: {
        prefersSystemTheme: true,
    },
}, function() {
    console.log('DevRev SDK configured with FeatureConfiguration.');
}, function(error) {
    console.error('Failed to configure DevRev SDK:', error);
});

Update the feature configuration

You can adjust the feature configuration without reconfiguring the SDK. Pass a full FeatureConfiguration object (all properties are required):

DevRev.updateFeatureConfiguration({
    enableFrameCapture: true,
    autoStartRecording: true,
    prefersDialogMode: false,
    alwaysUseRemoteConfig: true,
    supportWidgetTheme: {
        prefersSystemTheme: true,
    },
}, function() {
    console.log('Feature configuration updated.');
}, function(error) {
    console.error('Failed to update feature configuration:', error);
});

Feature configuration reference

FeatureConfiguration controls how the SDK behaves both during initial setup and when calling DevRev.updateFeatureConfiguration(...). All properties are required when providing a feature configuration.

Support widget theme options

SupportWidgetTheme lets you fine-tune the support UI. Use the supportWidgetTheme property inside your feature configuration.

var customTheme = {
    prefersSystemTheme: false,
    primaryTextColor: '#1F2933',
    accentColor: '#F97316',
    spacing: {
        bottom: '20px',
        side: '16px'
    }
};

Sample app

A sample app with use cases for the DevRev Cordova plugin is provided as part of our public repository. To set up and run the sample app:

cd sample
npm install
cordova platform add android
cordova platform add ios

cordova run android

platform :ios, '15.0'

cd platforms/ios
pod install

cordova run ios