Android (Kotlin/Java) SDK 4.0.0

Breaking Changes

• Migrated to AndroidX library as support for the Support Library is deprecated.
• Removed the visitorCode parameter from all methods that accepted it. You must now specify the visitor code during initialization. As a result, a KameleoonClient instance only works for a single visitor:
  • addData
  • flush
  • isFeatureActive
  • getFeatureVariationKey
  • getFeatureVariable
  • trackConversion
  • getActiveFeatureList
  • getVisitorWarehouseAudience
• Removed all deprecated methods and exceptions related to experiments:
  • triggerExperiment
  • getVariationAssociatedData (obtainVariationAssociatedData)
  • getExperimentList (obtainExperimentList)
  • getExperimentListForVisitor (obtainExperimentListForVisitor)
  • ExperimentConfigurationNotFound
  • NotTargeted
  • NotAllocated
  • SiteCodeDisabled
• Removed additional methods that were deprecated in 3.x versions:
  • activateFeature
  • obtainVisitorCode
  • obtainFeatureVariable
  • obtainFeatureAllVariables
  • obtainFeatureList
  • obtainFeatureListForVisitorCode
  • retrieveDataFromRemoteSource
• Changed the following classes, methods, fields and exceptions:
  • Classes:
    • Renamed KameleoonConfiguraton to KameleoonClientConfig.
    • Data classes were allocated into their own package com.kameleoon.data.
    • Renamed static members of Device class:
      • Device.PHONE renamed to Device.phone()
      • Device.TABLET renamed to Device.tablet()
      • Device.DESKTOP renamed to Device.desktop().
    • Conversion has additional constructors with optional revenue and negative values. Also, the types of these fields are changed to primitives.
  • Interfaces:
    • For the runWhenReady method, the interface KameleoonReadyCallback changed to ResultCompletion<Boolean, TimeoutException>.
    • For the getRemoteData method, the interface KameleoonDataCallback changed to ResultCompletion<JSONObject, Exception>.
    • For the getRemoteVisitorData method, the interface KameleoonVisitorDataCallback changed to ResultCompletion<List<Data>, Exception>.
    • For the getVisitorWarehouseAudience method, the interface KameleoonVisitorDataCallback changed to ResultCompletion<CustomData, Exception>.
    • For the onUpdateConfiguration method, the interface KameleoonUpdateConfigurationHandler changed to ResultCompletion<Long, Exception>.
  • Methods:
    • Removed getVisitorCode.
    • Renamed getFeatureAllVariables to getFeatureVariationVariables.
    • Renamed getVisitorWarehouseAudiences to getVisitorWarehouseAudience.
    • Renamed getActiveFeatureListForVisitorCode to getActiveFeatures.
    • Renamed updateConfigurationHandler to onUpdateConfiguration.
    • Changed revenue argument to optional in the trackConversion method. Also, the type of revenue was changed to float.
  • Fields:
    • Renamed configurationRefreshInterval to refreshIntervalMinute in KameleoonClientConfig.
    • Renamed defaultTimeout to defaultTimeoutMillisecond in KameleoonClientConfig.
    • Renamed actions_configuration_refresh_interval to refresh_interval_minute in the configuration file.
    • Renamed default_timeout to default_timeout_millisecond in the configuration file.
    • Renamed sitecode to siteCode in KameleoonClientFactory.create.
  • Exceptions:
    • Removed CredentialsNotFound (the clientId and clientSecret credentials are now optional).
    • Renamed VisitorCodeNotValid to VisitorCodeInvalid.
    • Renamed FeatureConfigurationNotFound to FeatureNotFound.
    • Renamed VariationConfigurationNotFound to FeatureVariationNotFound.
  • Added new exception [SiteCodeIsEmpty] for the method KameleoonClientFactory.create that indicates the provided siteCode is empty.
  • Added new exception FeatureEnvironmentDisabled indicating that the feature flag is disabled for certain environments. The following methods can throw the new exception:
    • getFeatureVariationKey
    • getFeatureVariable
    • getFeatureVariationVariables

Features

• Added the setLegalConsent method to determine the types data that Kameleoon includes in tracking requests. This helps you adhere to legal and regulatory requirements while responsibly managing visitor data. You can find more information in the Consent management policy.
• KameleoonClientFactory.create method accepts visitorCode as a parameter to use for all SDK methods. If you omit the visitorCode, the SDK generates a new visitor code value that it uses until you overwrite it. To overwrite a visitorCode, provide it as a parameter explicitly to the method. The method throws VisitorCodeInvalid if the provided visitorCode is invalid (empty or longer than 255 characters).
• Added new configuration fields to KameleoonClientConfig and external configuration file:
  • dataExpirationIntervalMinute (data_expiration_interval_minute) specifies the time (in minutes) that the SDK retains the visitor's data on the device. By default, the TTL (time to live) is Integer.MAX_VALUE.
• Changed the key parameter in the getRemoteData method from required to optional. If you don't provide a key parameter, the SDK uses the visitorCode specified during initialization.
• Added the getActiveFeatures method, which retrieves information about the active feature flags that are available for a specific visitor code. This method replaces the deprecated getActiveFeatureListForVisitorCode method.

Bug Fixes

• Stability and performance improvements.