Increase the dependency version in your prodspec.yaml file to upgrade your Qonversion SDK to the latest
dependencies: qonversion_flutter: ^5.0.0
Qonversion Flutter SDK 5 contains significant changes in how the library is initialized. We are moving from a static class approach to an instance-based one. Before, you initialized Qonversion using the
Qonversion.launch('projectKey', isObserveMode: true);
Now, instead, you should create a
QonversionConfig object using
QonversionConfigBuilder and provide it to the initialization method as follows:
final config = new QonversionConfigBuilder( 'projectKey', QLaunchMode.subscriptionManagement ).build(); Qonversion.initialize(config);
Note that instead of providing the
observeMode flag to the
launch call, you should provide a concrete value from the
QLaunchMode enum, depending on which mode you use Qonversion. Also, we've renamed our modes to make them more transparent for users:
- "Observe" mode becomes "Analytics" mode,
- "Infrastructure" mode becomes "Subscription Management" mode.
After the initialization, you can access the Qonversion instance whenever you want as follows:
So you should replace all your Qonversion calls with the construction above.
Also, if you were using
Qonversion.setDebugMode() for testing purposes, you should now call the
setEnvironment(QEnvironment.sandbox) method of the
launch method is available anymore, you won't get
QLaunchResult as a result. The good news is that there are analogues for all the fields you might have been using from there:
userInfo()and get the
QUser.qonversionIdfrom the result,
We are on the way to renaming permissions to entitlements as this naming suits more what it is used for. So, the following objects and methods were renamed in this release:
|Version <4||Version 4+|
QEntitlement class contains the same information as the
QPermission with a renaming of the
permissionId field - now it's named simply
- There is no
setPermissionsCacheLifetimemethod in Qonversion. You should provide
QonversionConfigBuilderduring the initialization using the
final config = new QonversionConfigBuilder( 'projectKey', QLaunchMode.subscriptionManagement ) .setEntitlementsCacheLifetime(QEntitlementsCacheLifetime.year) .build(); Qonversion.initialize(config);
We've also changed the way the
Automations is used. As in Qonversion, you should use
Automations via the shared instance. On the first access, it will be initialized and returned. Then the initialized instance will be used.
You should access the shared instance of
Automationsstrictly after you initialize Qonversion, else an exception will be thrown.
final config = new QonversionConfigBuilder( 'projectKey', QLaunchMode.subscriptionManagement ).build(); Qonversion.initialize(config); Automations.getSharedInstance().setDelegate(...);
Also, the methods for working with push notifications were moved from
Automations, so if you were using the following methods:
make sure to make calls from the Automations instance instead of the Qonversion one.
Along with the changes described above, there are several technical improvements and other changes in the new major release:
- all the internal classes were moved to the
internalpackage, and DTO classes were moved to the
dtopackage to make the library file structure more readable;
- the deprecated methods
resetUserwas deprecated for a long time, and it did nothing, so there is nothing to replace this call with, remove the call if you were still using it for some reason.
setUserIdshould be replaced with the
- added the new method
userInfo, which returns the information about the current Qonversion user. Now it contains internal Qonversion and identity identifiers. The user info may be extended in future releases;
- added new enum values -
QTrialDuration.Unknown, which are used when parsing fails;
advertisingIdvalues were added to the
- native modules' error codes were refactored - now clear textual error codes are provided.
- the following methods and classes renaming took place:
|Old name||New name|
Updated 12 months ago