Skip to content

Flutter SDK 3.0.0

Choose a tag to compare

View all tags
@Kameleoon Kameleoon released this 23 Jul 07:12
· 17 commits to main since this release
3.0.0
ae4358e

Breaking changes

  • 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:
  • Removed all deprecated methods and exceptions related to experiments:
    • triggerExperiment
    • getVariationAssociatedData (obtainVariationAssociatedData)
    • getExperimentList (obtainExperimentList)
    • getExperimentListForVisitor (obtainExperimentListForVisitor)
    • ExperimentConfigurationNotFound
    • NotTargeted
    • NotAllocated
    • SiteCodeDisabled
  • Changed the following classes, methods, fields and exceptions:
    • Classes:
      • Renamed KameleoonConfiguraton to KameleoonClientConfig.
      • Renamed enum values of Devices class:
        • Devices.PHONE renamed to Devices.phone
        • Devices.TABLET renamed to Devices.tablet
        • Devices.DESKTOP renamed to Devices.desktop
      • Renamed enum values of Browsers class:
        • Browsers.CHROME renamed to Browsers.chrome
        • Browsers.INTERNET_EXPLORER renamed to Browsers.internetExplorer
        • Browsers.FIREFOX renamed to Browsers.firefox
        • Browsers.SAFARI renamed to Browsers.safari
        • Browsers.OPERA renamed to Browsers.opera
        • Browsers.OTHER renamed to Browsers.other
      • CustomData now accepts a list of strings, instead of a single string, for enhanced flexibility and usability.
    • Methods:
      • Removed obtainFeatureVariable.
      • Removed retrieveDataFromRemoteSource.
      • Removed getVisitorCode.
      • Renamed getFeatureAllVariables to getFeatureVariationVariables.
      • 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.
      • For the runWhenReady method, the readyCallback and failCallback combined into the single Function(bool) callback.
      • For the onUpdateConfiguration method, the Function callback changed to Function(int) where parameter represents the value of Unix time (number of seconds that have elapsed since January 1, 1970) when configuration was updated
    • Exceptions:
      • Removed CredentialsNotFound (the clientId and clientSecret credentials are now optional).
      • Renamed VisitorCodeNotValid to VisitorCodeInvalid.
      • Renamed VariationNotFound to FeatureVariationNotFound.
      • Renamed VariableNotFound to FeatureVariableNotFound.
    • 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:

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:
    • defaultTimeoutMilliseconds which specifies the time interval, in milliseconds, that it takes for network requests from the SDK to time out. If not provided, the default value is 10_000 ms.
    • dataExpirationIntervalMinutes 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.
    • isUniqueIdentifier that provides additional capabilities with cross-device experimentation for the KameleoonClientConfig.
  • 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 new targeting conditions (some conditions require you to pre-load data with getRemoteVisitorData)
    • Operating System
    • IP Geolocation
    • Kameleoon Segment
    • Target Feature Flag
    • Time since First Visit
    • Time since Last Visit
    • Number of Visits Today
    • Total Number of Visits
    • New or Returning Visitor
    • Likelihood to convert
  • Added new Kameleoon Data type:
  • 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.
  • Added methods for obtaining remote visitor data:
    • getVisitorWarehouseAudience method to retrieve all data associated with a visitor's warehouse audiences and adds it to the visitor.
    • getRemoteVisitorData fetches the remote visitor's data (with an optional capability to add the data for the visitor).

Bug Fixes

  • Stability and performance improvements.
Assets 2
Loading