SDK 12.1.0 Migration Guide for Flutter

Guide for migrating to Instabug's SDK version 12.0 on Flutter

With the release of version 12.1.0, a whole host of new products have been released such as, Session Replay, App Ratings, and Rollout Management. Along with this release, a few APIs have been changed to better suit these new features and in order to improve the usage of these APIs.

Initializing the SDK

If you're using Instabug.start to initialize the Instabug SDK, you'll need to migrate to the new Instabug.init method introduced in v11.9.0.

Before

Instabug.start('<APP_TOKEN>', [InvocationEvent.shake]);
Instabug.setSdkDebugLogsLevel(LogLevel.verbose);

After

Instabug.init(
  token: '<APP_TOKEN>',
  invocationEvents: [InvocationEvent.shake],
  debugLogsLevel: LogLevel.verbose,
);

Removed APIs & Alternatives

Deprecated APICorresponding API
Instabug.startInstabug.init
Instabug.setSdkDebugLogsLevelInstabug.init's debugLogsLevel parameter.
Instabug.setDebugEnabledInstabug.init's debugLogsLevel parameter
Instabug.setReproStepsModeInstabug.setReproStepsConfig
Instabug.enableAndroidInstabug.setEnabled(true)
Instabug.disableAndroidInstabug.setEnabled(false)
APM.setLogLevelInstabug.init's debugLogsLevel parameter
LogLevel.warningLogLevel.error
LogLevel.infoLogLevel.debug
IBGSDKDebugLogsLevel enum.LogLevel
CustomTextPlaceHolderKey.invalidCommentMessageNone
Callback parameter of Replies.hasChatsThe returned Future object.
Callback parameter of Replies.getUnreadRepliesCountThe returned Future object.
Callback parameter of Surveys.getAvailableSurveysThe returned Future object.
Callback parameter of Surveys.hasRespondedToSurveyThe returned Future object.