SDK Version Overview & Changelog

iOS SDK Version Overview

Android SDK Version Overview

Unity SDK Version Overview

Changelog iOS SDK

All notable changes to this project will be documented in this file.

Version 2.5.4 (Released on 2024-11-29)

Added

• Improved logging system, now including logs from the webview console 

Version 2.5.3 (Released on 2024-09-06)

This version has breaking changes.

Added

• added defaultReturn option for hasVendor and hasPurpose function. 

Fixed

• ATT Behaviour on privacy tracking changes.

Refactored

• CmpManager API harmonized.
• Deprecated hasVendorConsent and hasPurposeConsent methods. 

Version 2.0.1 (Released on 2024-05-06)

Added

• Privacy Manifest file

Fixed

• Automatic ATTracking management

Version 1.105.0 (Released on 2024-04-10)

Added

• Dark Mode Feature

Fixed

• jumpToSettings page

Version 1.104.0 (Released on 2024-03-13)

Refactored

• ATT Manager updated

Version 1.102.0 (Released on 2024-03-06)

Added

• UI Config
• ATT check in checkAndOpen API

Version 1.101.0 (Released on 2024-02-19)

Refactored

• Public API for ATT Manager

Added

• Domain Whitelisting

• CMP ATT Manager API

Version 1.99.4-no-att (Released on 2024-01-31)

Fixed

• incomplete umbrella header fixed
• iOS 15.3 archiving issue fixed

Version 1.99.4 (Released on 2024-01-31)

Fixed

• incomplete umbrella header fixed
• iOS 15.3 archiving issue fixed

Version 1.99.3 (Released on 2024-01-17)

Added

• Google ConsentMode feature

Version 1.99.2 (Released on 2023-12-21)

Refactored

• MigrationManager for older versions

Fixed

• initial consent save triggers error event but consent is saved 

Version 1.99.1 (Released on 2023-12-18)

Added

• CmpViewControllerConfigurationBlock for custom viewcontroller behaviour

• CmpUIViewConfigurationBlock for custom uiview settings

• Change Tracking Events
• Improved ATTracking management

Refactored

• Codebase: Significant refactoring done for improved code stability.
• Improvements for disable and enable vendor/purpose actions
• CmpConfig with CmpLayout object

Fixed

• importCmp improved
• Cleanup: General tidying up of the codebase.

Version 1.7.3 (Released on 2023-10-03)

Added

• Feature & Stability Improvements: New enhancements added to the system.
• Retry Logic: New retry mechanism introduced for better reliability.

Refactored

• Codebase: Significant refactoring done for improved code stability.
• ViewController: Operations focused on refactoring the ViewController and streamlining debug logs.

Fixed

• Deprecated Class Removal: An outdated class that was no longer in use has been removed.
• Cleanup: General tidying up of the codebase.

Version 1.7.2 (Released on 2023-08-09)

Refactored

• CmpConfig optimized

Version 1.7.1 (Released on 2023-07-04)

Fixed

• Serialization fix for NSString

Version 1.7.0 (Released on 2023-06-28)

Refactored

• Refactoring Cmp consent process

Version 1.6.4 (Released on 2023-05-24)

Added

• updateVendor Parameter to updateVendors in disable/enable PurposeList API

Refactored

• Documentation updates

Fixed

• disablePurposeList and enablePurposeList fix
• getDisableVendors and purpose fix
• close Listener now executed correctly

Version 1.6.3 (Released on 2023-05-14)

Added

• Check API to requests server if consent layer needs to be open.
• Adding enable and disable vendor and purpose with feedback callback
• Check API caching feature
• Adding design ID parameter to set consent design

Refactored

• Remove Webview after disappear
• Adding V4 URL for old Cmp Repository

Fixed

• disableVendorList fix

Version 1.6.2 (Released on 2023-04-21)

Added

• Check API to requests server if consent layer needs to be open.

Fixed

• Bug regarding to fetch the Vendor and Purpose List

Version 1.6.1 (Released on 2023-04-12)

Added

• Feature new codeIds.
• Cmp Error Types on error callback.
• Cmp Button Event callbacks. Callback gives information about the user clicked button

Refactored

• Added old constructor API to CMPConsentTool
• Changed constructor calls. Chainable callbacks and removed autoupdate
• Updated signature.
• Synchronized API function naming.
• Refactored signature of API functions, changed process of read write consent.
• Refactored service class to singleton instance with listener properties.
• Refactored internal naming and refactored backend consent process.
• Changed signature of API functions getAgreed becomes getEnabled.

Version 1.6.0 (Released on 2023-03-17)

Added

• Feature new codeIds.
• Cmp Error Types on error callback.
• Cmp Button Event callbacks. Callback gives information about the user clicked button

Refactored

• Changed constructor calls. Chainable callbacks and removed autoupdate
• Updated signature.
• Synchronized API function naming.
• Refactored signature of API functions, changed process of read write consent.
• Refactored service class to singleton instance with listener properties.
• Refactored internal naming and refactored backend consent process.
• Changed signature of API functions getAgreed becomes getEnabled.

Version 1.5.2 (Released on 2023-02-07)

Fixed

• Bug fixes

Version 1.5.1 (Released on 2023-02-05)

Added

• Added get list of disabled purposes and vendors
• Disabled purposes and vendors
• Changed vendorstring
• Added enable/disable vendor and purposes

Version 1.5.0 (Released on 2023-01-21)

Refactored

• Cleanup
• Removed logs
• Logs
• Refactored API and added interface. Cleaned endpoints and marked specific endpoints as deprecated

Added

• Changed att
• getAgreed and getAll api

Version 1.3.93 (Released on 2023-01-05)

Added

• Vendor and purpose api
• hasConsent API

Refactored

• Timeout and error listener

Version 1.3.92 (Released on 2023-01-04)

Refactored

• Language update

Version 1.3.91 (Released on 2023-01-04)

Refactored

• Version
• Timeout and error listener

Version 1.3.9 (Released on 2023-01-03)

Refactored

• Timeout and common error
• Synchronize error listener

Version 1.3.8 (Released on 2022-12-21)

Refactored

• Removed indicator view

Version 1.3.7 (Released on 2022-12-13)

Added

• Podspec
• hasConsent API

Version 1.3.6 (Released on 2022-12-10)

Added

• ModalTransitionStyle, openListener Bug, rejectAll feature

Version 1.3.5 (Released on 2022-11-23)

Added

• Customlayout and skiptocustomize page

Version 1.3.4 (Released on 2022-10-26)

Added

• Custom UI color

Version 1.3.3 (Released on 2022-10-24)

Fixed

• Needs acceptance fix

Version 1.3.2 (Released on 2022-10-21)

Refactored

• Changed signature to CmpSdk
• Update close and not close listener

Version 1.3.1 (Released on 2022-05-05)

Refactored

• Added constructor for backend verification option

Version 1.2.9 (Released on 2022-03-22)

Fixed

• User default parsing for IABTCF key values

Version 1.2.8 (Released on 2022-03-15)

Refactored

• Stability improvements for CMP Communication of ConsentLayer
• Reliability of network requests

Version 1.2.7 (Released on 2022-02-07)

Fixed

• ATT Status for consentlayer settings fixed:

Version 1.2.6 (Released on 2022-01-03)

Added

• log verbose level

Fixed

• Additional process flow control

Version 1.2.3 (Released on 2021-12-09)

Refactored

• basic improvements and project cleanup

Version 1.2.2 (Released on 2021-12-09)

Fixed

• decode String bug

Refactored

• Consentlayer Event callback

Version 1.2.1 (Released on 2021-12-02)

Added

• Timeout for specific events

Version 1.2.0 (Released on 2021-11-30)

Added

• Placeholder feature
• ATT Support

Changed

• Consentlayer event processing
• API queries

Refactored

• Restructure Project
• Improved performance of consentlayer
• Preparing for new Interface Structure

Version 1.1.1 (Released on 2021-09-05)

Fixed

• bug fix for hasVendor method

Version 1.1.0 (Released on 2021-08-17)

Added

• added callback event when cmp view will not be opened

Fixed

• deactivated dismissing the cmp modal
• handle consent logic with non-EU traffic

Refactored

• changed url gnerator logic

Version 1.0.3 (Released on 2021-06-17)

Fixed

• fixed misbehahaviour of external link calls within the cmp view.

Version 1.0.2 (Released on 2021-06-14)

Fixed

• minor problems with xcframework version

Version 1.0.0 (Released on 2021-06-11)

Added

• added CHANGELOG to development lifecycle

Changed

• Changed internal class names regarding to naming conflicts

Fixed

• Fixed unused element Warning caused by Parser
• Fixed Delegates association warning of ConsentController

Version 0.1.5 (Released on 2021-03-22)

Refactored

• refactored minor parts of the sdk for better maintenance

Version 0.1.1 (Released on 2021-03-21)

Added

• additional optional parameter to CmpConsentTool to pass idfa String

Version 0.1.0 (Released on 2021-03-21)

Added

• added xc framework integration

Fixed

• fixed error handling on invalid json data

Version 0.0.1 (Released on 2021-02-28)

Added

• pod example project fo pod try command

Version 0.0.1 (Released on 2021-02-27)

Added

• Providing integration through cocoapod

Changelog Android SDK

Version 2.5.4 (Released on 2024-12-10)

From this version on, the repository was migrated to Maven Central Portal.

Additionally, the minimum Android SDK version was bumped to 28, due to limitations on the way previous versions of Chrome deal with server certificates during HTTPS network requests, which affects the communication of the WebView with our backend servers.  

Fixed

Activity/Popup/Fragment/Activity Strategies

• Removed static WebView and Activity references
• Improved focus handling between main activity and CMP layer
• Fixed window attachment issues
• Fixed memory leaks
• Improved cleanup of resources

Refactored

• Better error propagation across strategies
• More consistent cleanup patterns
• Reduced potential for ANR issues

Version 2.5.3 (Released on 2024-11-08)

Refactored

• Implemented proper Fragment lifecycle management using DefaultLifecycleObserver
• Fixed IllegalStateException by using commitAllowingStateLoss
• Improved WebView state preservation during configuration changes

Version 2.5.2 (Released on 2024-09-06)

Refactored

• Migration Manager issue, when migrating from outdated versions

Added

• Google Analytics callback

Version 2.5.2-nzz (Released on 2024-08-29)

Do not use this version unless clearly recommended by our support team. 

Refactored

• Client specific migration to newer versions. 

Version 2.5.1 (Released on 2024-07-17)

This version has breaking changes.

Changed

• The method getConsentString was marked as deprecated. Now it can also be called consentString
• The method checkAndOpenConsentLayer was marked as deprecated. Now it can also be called openConsentLayerOnCheck
• The methods hasVendorConsent and hasPurposeConsent methods now offer a defaultReturn parameter to define the default value that is returned.
  • Old
    • hasVendorConsent(id: String): Boolean
    • hasPurposeConsent(id: String): Boolean
  • New:
    • hasVendorConsent(id: String, defaultReturn: Boolean): Boolean
    • hasPurposeConsent(id: String, defaultReturn: Boolean): Boolean

Refactored

• Adding platform version to the back-end calls

Version 2.5.0 (Released on 2024-07-16)

Fixed

• onOpenCallback issue (not being triggered on some situations)

Refactor

• Minor clean up

Version 2.4.1 (Released on 2024-05-16)

Fixed

• Blocking overlay on the consent layer issue

Version 2.4.0 (Released on 2024-04-10)

Fixed

• WebView thread issue

Added

• Dark mode parameter passed to the back-end
• Blocking overlay on the consent layer to manage interactions with it

Version 2.3.4/5-ktx-1.7 (Released on 2024-03-13)

Refactored

• Max retries
• change preference migration manager to default preferences

Version 2.3.3-ktx-1.7 (Released on 2024-03-12)

Refactored

• custom retry parameter

Version 2.3.2 (Released on 2024-03-06)

Added

• dismiss WebView added to Dialog

Refactored

• default/fallback of invalid shared pref to 0
• Check Android WebView enabled

Version 2.3.1 (Released on 2024-03-04)

Refactor

• Improvement of error handling 

Version 2.3.0 (Released on 2024-02-27)

Added

• CmpUIConfiguration
• Different options to create a UI window element for the consent layer
• domain white listing
• internal link callbak

Version 2.2.0 (Released on 2024-01-31)

Added

• Cmp configuration option to enable or disable cmp activity loading animation
• Cmp configuration option to enable or disable cmp activity back button interaction 

Usage Example (Kotlin):

val config = CmpConfig.apply {
    id = ""
    domain = ConsentActivity.CMP_DOMAIN
    appName = ConsentActivity.CMP_APP_NAME
    language = ConsentActivity.LANG
    preventBackButtonInteraction = true
    hasLoadingAnimation = false
}

Version 2.1.1 (Released on 2024-01-18)

Refactored

• Optimisation WebView page loading

Version 2.1.0 (Released on 2024-01-17)

Added

• Google ConsentMode V2

Version 2.0.2 (Released on 2023-12-21)

Refactored

• Migration manager
• lib version migration
• CmpConfig from CMPConfig
• cleanup new interface

Version 2.0.0 (Released on 2023-12-12)

Added

• Loading animation
• FrameLayout helper
• Composable Demo

Refactored

• callback process
• URI Builder
• Naming Conventions

Version 1.7.5 (Released on 2023-10-24)

Added

• TvSDK Mobile QR Code scan 

Version 1.7.33 (Released on 2023-10-06)

Due to a migration the SDK is now available from this Repository: net.consentmanager.sdk:android:1.7.33

Changed

• CmpConfig Api optimized
  • Renamed Properties:
    • - `idfa` -> `gaid`
    • `serverDomain` -> `domain`
    • `skipToCustomizePage` -> `jumpToSettingsPage`
    • `customLayerColor` -> `dialogBgColor`
    • `debug` -> `isDebugMode`
    • - Nested `CustomLayer` object for managing custom layer operations:
      • `.CustomLayer.activate(containerViewId: Int)`
      • `.CustomLayer.deactivate()`
      • `.CustomLayer.isActive(): Boolean`
  • Removed:
    • `setCustomViewContainerId`
    • `enableSettingsPage`
    • `removeCustomViewContainerId`

Usage Example (Kotlin):

Before

kotlinCMPConfig.idfa = "abcd"
CMPConfig.serverDomain = "example.com"
CMPConfig.activateCustomLayer(R.id.container)
CMPConfig.skipToCustomizePage = true

After: 

CMPConfig.gaid = "abcd"
CMPConfig.domain = "example.com"
CMPConfig.CustomLayer.activate(R.id.container)
CMPConfig.jumpToSettingsPage = true

Refactored

• NetworkAvailability method

Version 1.7.32 (Released on 2023-09-17)

Due to a migration the SDK is now available from this Repository: net.consentmanager.sdk:android:1.7.32

Added

• Retry Logic

Changed

• Improved Proguard rules 
• Optimized Error handling
• Performance improvements for WebView 

Refactored

• Fragment and Activity for Consentlayer
• Custom Logging

Version 1.6.3 (Released on 2023-05-10)

Added

• callback OnConsentReceived for all APIS to change vendor and purpose
• support for older Android Versions

Version 1.6.2 (Released on 2023-04-19)

Added

• Added types for metadata keys.

Version 1.6.1 (Released on 2023-04-18)

Added

• Check API with onOpenCallback
• Added consentServiceinterface and no callback service.

Refactored

• Fixed cmp error on different locations
• Updated Gradle version
• Set default value for button event.

Version 1.6.0 (Released on 2023-03-17)

Added

• Config object improved and added reset
• Added missing interface functions

Refactored

• Improved stability for CMPConfig
• Removed Metadata as internal class
• Improved stability and updated data of Cmp Consent object
• Improved stability for invalid json decoding and encoding
• Logging improved and refactored unused functions
• Change API signature of checkAndOpenCmpLayer, added optional appInterface
• Change API signature getLastConsentString to getConsentstring, exportConsentString to exportCmpString, importCMPData to importCmpString, to differentiate more between the cmp string by consentmanager and the consentstring by iab
• Change API signature getAgreedVendor becomes getEnabledVendors
• Upgraded gradle to 7.4.1
• Improved stability for errors while consentlayer is open
• Improved stability for migration and decoding and encoding of newer and older api
• Improved service class and error handling

Fixed

• Fixed idfa string
• possible memory leak and improved performance

Removed

• Deprecation note for placeholder API
• Unused listener
• Internalized Repository
• Internalized classes for module

Testing

• Refactored test classes
• Updated tests
• Added test for consent object
• Added constructor tests

Version 1.5.7 (Released on 2023-02-16)

Added

• Added get list of disabled purposes and vendors
• Disabled purposes and vendors

Fixed

• Missing errorCallback in createInstance

Refactor

• Improved stability by adding try catch blocks around serialization and deserialization parts
• Network availability checks improved
• Refactored API and added interface. Cleaned endpoints and marked specific endpoints as deprecated
• Improved stability for saving consent

Style

• Updated docs and cleaned code
• Documentation

Version 1.5.6 (Released on 2023-02-07)

Changed

• Resolved a bug related to GDPR or CCPA.

Version 1.5.5 (Released on 2023-02-07)

Fixes

• Eliminated the Java class for improved performance.

Version 1.5.4 (Released on 2023-02-02)

Refactored

• Huge refactoring and changing API of hasVendor

Version 1.5.3 (Released on 2023-02-02)

Fixed

• Removed static instance of service

Version 1.5.2 (Released on 2023-01-24)

Fixed

• Removed static instance of service

Version 1.5.1 (Released on 2023-01-23)

Refactored

• General refactor and cleanup

Version 1.5.0 (Released on 2023-01-19)

Added

• API getAgreed and getAll Purposes and Vendors

Version 1.4.94 (Released on 2023-01-06)

Added

• Static callback class

Version 1.4.93 (Released on 2023-01-05)

Added

• Added vendor and purpose list API

Version 1.4.92 (Released on 2023-01-04)

Added

• onErrorCallback and CMP language API

Version 1.4.91 (Released on 2023-01-03)

Fixed

• Removed unnecessary log

Version 1.4.9 (Released on 2022-12-28)

Added

• Common error

Version 1.4.8 (Released on 2022-12-16)

Changed

• Updated Android Material

Version 1.5.6 (Released on 2023-02-07)

Fixed

• Bug related to GDPR or CCPA.

Version 1.5.5 (Released on 2023-02-07)

Fixed

• Eliminated the Java class for improved performance.

Version 1.4.8 (Released on 2022-12-16)

Changed

• Updated Android Material.

Version 1.4.7 (Released on 2022-12-13)

Added

• hasConsent() method.

Version 1.4.6 (Released on 2022-12-13)

Fixed

• Missing key error.

Version 1.4.5 (Released on 2022-12-13)

Added

• Methods:
  • rejectAll()
  • hasConsentPurpose()
  • hasConsentVendor()

Version 1.4.4 (Released on 2022-11-29)

Added

• Javascript event.

Version 1.4.3 (Released on 2022-11-29)

Added

• Activity styles.

Version 1.4.2 (Released on 2022-11-10)

Changed

• Updated the CMP SDK version.

Version 1.4.1 (Released on 2022-11-01)

Changes

• Initialize() method

Version 1.4.0 (Released on 2022-10-31)

Added

• Implemented fragment and cleanups.

Version 1.3.4 (Released on 2022-10-05)

Added

• Feature custom color and custom screen size.

Version 1.3.3 (Released on 2022-04-08)

Added

• Events after save.

Version 1.3.2 (Released on 2022-04-08)

Added

• Consent saved event after save function.

Version 1.3.1 (Released on 2022-04-08)

Added

• Activity new task.

Version 1.3.0 (Released on 2020-08-04)

Fixed

• Check for consent if empty or null.

Version 1.2.9 (Released on 2020-07-04)

Changed

• Additional Verification on hasPurpose/hasVendor to check if consent is given.

Version 1.2.8 (Released on 2022-07-04)

Fixed

• Event triggers for closing CMP fixed.
• Event trigger for not opened CMP fixed.
• Not open event will now be triggered also when ConsentLayer pushes a consent without opening.

Version 1.2.7 (Released on 2022-27-03)

Changed

• OpenListener callback moved to the actual layer opening event

Version 1.2.6 (Released on 2022-15-03)

Refactored

• Stability improvements for CMP Communication of ConsentLayer.
• Refactored UI Activity and WebView.

Fixed

• ConsentLayer user consent synchronization to SDK fixed.

Version 1.2.5 (Released on 2022-13-03)

Refactored

• Stability for CCPA/GDP Appliances.
• Reliability of network requests.

Version 1.2.4 (Released on 2022-20-02)

Fixed

• Possibility to createInstance without any callback functions.
• Fixed Status of CCPA/GDPR Appliances on vendor/purpose requests.

Version 1.2.3 (Released on 2022-02-02)

Fixed

• Fixed Bug with need acceptance behavior.

Changed

• Activity is running in background.

Version 1.2.2 (Released on 2022-30-01)

Changed

• changed time of inserting js functions on webview.
• backend API call changed if no consent is present.

Version 1.2.1 (Released on 2021-12-02)

Changed

• changed API call of ConsentLayer.
• Visibility.

Version 1.2.0 (Released on 2021-11-10)

Added

• Placeholder Preview Object

Refactored

• introduced kotlin objects for future upcoming Android Sdk
• synced Event callback names between projects

Fixed

• fixed issue of reopening ConsentLayer.

Version 1.1.0 (Released on 2021-08-24)

Fixed

• deactivated dismissing the CMP modal.
• handle consent logic with non-EU traffic.

Refactored

• changed URL generator logic.

Version 1.0.1 (Released on 2021-06-22)

Fixed

• fixed minified bug

Version 1.0.0 (Released on 2021-03-26)

Added

• added AddId Property handling
• added Readme and working example project

Version 0.0.1 (Released on 2021-03-24)

Added

• Providing integration through jitpack

Changelog Unity SDK

All notable changes to this project will be documented in this file.

Version 1.0.0 (Released on 2024-03-04)

Added

• custom layouts
• ATTracking support

Version 0.99.2 (Released on 2023-12-21)

Added

• Dynamic iOS build path for xcframework

• build optimisations 

Version 0.99.0 (Released on 2023-12-18)

Breaking Changes

• The SetAndroidCallbacks and SetIOSCallbacks methods have been removed. The callbacks are now set in the AddEventListeners method.
• The Callbacks for iOS have been renamed to IOnOpenCallback, IOnCloseCallback, IOnCmpNotOpenedCallback, IOnCmpButtonClickedCallback, IOnErrorCallback.
• Renaming of Internal Classes and Methods

Added

• Implementation of Assembler Files

• Editor Window for Build Scripts

• Integration of Custom Layouts for Android

Refactored

• Streamlining Event Listener Implementation for iOS

• Optimization of Build Scripts

Version 0.4.0 (Released on 2023-11-15)

Added

• CmpConfig Object
• ImportCmpString 

Version 0.3.0 (Released on 2023-10-25)

Added

• Custom Layout Feature and configuration class added. 

Refactored

• Optimised integration of iOS xcFramework

Version 0.2.0 (Released on 2023-10-03)

Added

• Support for older Gradle Versions 6.1.1

Refactored

• updated consentmanager SDK dependency and removed jitpack

Version 0.1.0 (Released on 2023-08-24)

Added

• Unity SDK Implementation for iOS and Android