Importing the Plugin

Prior to v11, Instabug modules were polluting the plugins object and may clash with other libraries (thanks to Edmu for highlighting it here)

So instead of using the modules like this:

cordova.plugins.bugReporting.setEnabled(...);

Now you can use it with cordova.require as follows:

var BugReporting = cordova.require("instabug-cordova.BugReporting");

BugReporting.setEnabled(...);

Or if you prefer to use the window object:

var BugReporting = window.InstabugLib.BugReporting;

Available Modules

Start the SDK from JS only

Users are now able to initialize the SDK completely from Javascript rather than having to write the initialization code for Android in the Java/Kotlin files.

Migrate the initialization code to JS

1. If you have checked platform/android in your source control, then remove the following attribute from platforms/android/app/src/main/AndroidManifest.xml:

android:name="com.instabug.cordova.plugin.MyApplication"

2. Initialize Instabug in your JS, inside the onDeviceReady function, by replacing calls for Instabug.activate with Instabug.start

function onDeviceReady() {
  var Instabug = cordova.require("instabug-cordova.Instabug");
  var BugReporting = cordova.require("instabug-cordova.BugReporting");

  Instabug.start(
    'APP_TOKEN',
    function () {
        console.log('Instabug initialized.');
    },
    function (error) {
        console.log('Instabug could not be initialized - ' + error);
    }
  );
}

import { Instabug, BugReporting } from "instabug-cordova";

Instabug.start(
    'APP_TOKEN',
    [BugReporting.invocationEvents.button],
    function () {
        console.log('Instabug initialized.');
    },
    function (error) {
        console.log('Instabug could not be initialized - ' + error);
    }
);

3. Replace Instabug.activate options with the alternative JS API:

Remove the deprecated APIs

BugReporting Module

Chats Module

Completely removed. Use Replies Module instead.

Instabug Module

Breaking Changes

Some APIs were removed or moved to another module:

1. Remove Instabug.setAutoScreenRecordingMaxDuration
2. Remove Surveys.setThresholdForReshowingSurveyAfterDismiss
3. Remove Instabug.setViewHierarchyEnabled
4. Remove BugReporting.invocationModes enum.
5. Replace Instabug.setVideoRecordingFloatingButtonPosition with BugReporting.setVideoRecordingFloatingButtonPosition
6. Replace Instabug.setShakingThreshold with BugReporting.setShakingThresholdForAndroid