SDK Version Overview & Changelog
This version 3 has major breaking changes on all platforms in relation to v2.
Changelog iOS SDK v3
Version 3.1.0 (Released on 2025-02-18)
Major Changes
- Introduced new unified consent status management through
getUserStatus()method - Added support for Google Consent Mode v2 integration
- Enhanced WebView management and lifecycle handling
New Features
- - Added
getStatusForPurpose()andgetStatusForVendor()for granular consent checking - Introduced
forceOpen()for direct consent layer management withjumpToSettingsparameter - Added
checkAndOpen()with improved error handling and callback support - Implemented new
ConsentStatusenum for more precise consent state management - Added Google Consent Mode v2 compatibility with
getGoogleConsentModeStatus() - Introduced
LinkClickHandlertypealias for URL handling callbacks. This adds link click handling capabilities to our CMP SDK, allowing applications to customize how links within the consent layer are handled.
Deprecations
Several methods have been deprecated in favor of more robust or unified alternatives:
- Deprecated
checkIfConsentIsRequired()- UsegetUserStatus()instead - Deprecated
hasUserChoice()- UsegetUserStatus()instead - Deprecated
hasPurposeConsent()- UsegetStatusForPurpose()instead - Deprecated
hasVendorConsent()- UsegetStatusForVendor()instead
The following methods have been consolidated into getUserStatus():
- Deprecated
getAllPurposesIDs() - Deprecated
getEnabledPurposesIDs() - Deprecated
getDisabledPurposesIDs() - Deprecated
getAllVendorsIDs() - Deprecated
getEnabledVendorsIDs() - Deprecated
getDisabledVendorsIDs()
UI Methods
- Deprecated
openConsentLayer()- UseforceOpen()instead - Deprecated
checkWithServerAndOpenIfNecessary()- UsecheckAndOpen()instead
Migration Guide
To migrate to the new API:
- Replace individual consent checking methods with
getUserStatus() - Update UI-related calls to use
forceOpen()andcheckAndOpen() - Refactor purpose and vendor checks to use
getStatusForPurpose()andgetStatusForVendor()
All deprecated methods will be removed in the next version update.
Refactored
Reinforced webview dismissal protection.
Version 3.0.2 (Released on 2024-12-16)
Fixed
Linking issues with Objective-C integrations.
Version 3.0.1 (Released on 2024-12-04)
Fixed
Issue with JSON encoding/decoding for some specific CMP's.
Version 3.0.0 (Released on 2024-10-16)
Completely rewritten from the ground up, this version brings all the benefits, features and fixes collected with our clients along the last years. It's lighter, faster and safer.
Changelog Android SDK v3
Version 3.1.1 (Released on 2025-02-21)
Breaking Changes
- CMPManagerDelegate.didReceiveConsent now accepts Map<String, Any> instead of JsonObject
- Removed direct JsonObject exposure from public APIs
Added
- Type-safe/null-safe extension functions for Map<String, Any>
Changed
- Aligned Android SDK's public API with iOS implementation
- Improved type and null safety in delegate methods
- Updated internal serialization handling
Migration
Update CMPManagerDelegate implementations to use Map<String, Any>.
Version 3.1.0 (Released on 2025-02-18)
Major Changes
- Introduced new unified consent status management through
getUserStatus()method - Added support for Google Consent Mode v2 integration
- Enhanced WebView management and lifecycle handling
New Features
- - Added
getStatusForPurpose()andgetStatusForVendor()for granular consent checking - Introduced
forceOpen()for direct consent layer management withjumpToSettingsparameter - Added
checkAndOpen()with improved error handling and callback support - Implemented new
ConsentStatusenum for more precise consent state management - Added Google Consent Mode v2 compatibility with
getGoogleConsentModeStatus() - Introduced
LinkClickHandlertypealias for URL handling callbacks. This adds link click handling capabilities to our CMP SDK, allowing applications to customize how links within the consent layer are handled.
Deprecations
Several methods have been deprecated in favor of more robust or unified alternatives:
- Deprecated
checkIfConsentIsRequired()- UsegetUserStatus()instead - Deprecated
hasUserChoice()- UsegetUserStatus()instead - Deprecated
hasPurposeConsent()- UsegetStatusForPurpose()instead - Deprecated
hasVendorConsent()- UsegetStatusForVendor()instead
The following methods have been consolidated into getUserStatus():
- Deprecated
getAllPurposesIDs() - Deprecated
getEnabledPurposesIDs() - Deprecated
getDisabledPurposesIDs() - Deprecated
getAllVendorsIDs() - Deprecated
getEnabledVendorsIDs() - Deprecated
getDisabledVendorsIDs()
UI Methods
- Deprecated
openConsentLayer()- UseforceOpen()instead - Deprecated
checkWithServerAndOpenIfNecessary()- UsecheckAndOpen()instead
Migration Guide
To migrate to the new API:
- Replace individual consent checking methods with
getUserStatus() - Update UI-related calls to use
forceOpen()andcheckAndOpen() - Refactor purpose and vendor checks to use
getStatusForPurpose()andgetStatusForVendor()
All deprecated methods will be removed in the next version update.
Refactored
Reinforced webview dismissal protection.
Version 3.0.1 (Released on 2024-12-04)
Fixed
Issue with JSON encoding/decoding for some specific CMP's.
Version 3.0.0 (Released on 2024-10-16)
Completely rewritten from the ground up, this version brings all the benefits, features and fixes collected with our clients along the last years. It's lighter, faster and safer.
Changelog React Native SDK v3
Version 3.1.0 (to be released soon)
Version bump to accomodate for the changes mentioned above on Android and iOS native SDKs.
Version 3.0.0 (Released on 2024-10-16)
Completely rewritten from the ground up, this version brings all the benefits, features and fixes collected with our clients along the last years. It's lighter, faster and safer.
Changelog Flutter SDK v3
Version 3.1.0 (to be released soon)
Version bump to accomodate for the changes mentioned above on Android and iOS native SDKs.
Version 3.0.0 (Released on 2024-10-16)
Completely rewritten from the ground up, this version brings all the benefits, features and fixes collected with our clients along the last years. It's lighter, faster and safer.
Changelog Unity SDK v3
Version 3.1.0 (to be released soon)
Version bump to accomodate for the changes mentioned above on Android and iOS native SDKs.
Version 3.0.0 (Released on 2024-10-16)
Completely rewritten from the ground up, this version brings all the benefits, features and fixes collected with our clients along the last years. It's lighter, faster and safer.
