Swift SDK

Introduction

Welcome to the developer documentation for the Kameleoon Swift SDK! Our SDK gives you the possibility of running experiments and activating feature flags on native mobile iOS applications. Integrating our SDK into your applications is relatively easy, and its footprint (in terms of memory and network usage) is low.

You can refer to the SDK reference to check out all possible features of the SDK. Also make sure you check out our Getting started tutorial which we have prepared to walk you through the installation and implementation.

Latest version of the Swift SDK: 2.1.1 (changelog).

Getting started

This guide is designed to help you integrate our SDK in a few minutes and start running experiments in your iOS applications. This tutorial will explain the setup of a simple A/B test to change the number of recommended products based on different variations.

Creating an experiment

First, you must create an experiment in the Kameleoon back-office so that our platform is aware of the new A/B test you're planning to implement on your side. Make sure that mobile application type is chosen as shown below:

Upon successful creation of the experiment, you will need to get its ID to use in the SDK as an argument to the triggerExperiment() method.

Installing the SDK

Installing the Swift client

We currently support either CocoaPods or Swift Package Manager as methods of installation.

# Podfile
use_frameworks!

target 'YOUR_TARGET_NAME' do
    pod 'kameleoonClient'
end

With CocoaPods, use the code to the right in your Podfile, replacing "YOUR_TARGET_NAME" with the correct value. Then in the Podfile directory, type:

$ pod install

  dependencies: [
    .package(url: "https://github.com/Kameleoon/client-swift.git", from("2.0.10"))
  ],
)

With Swift Package Manager, it is recommended to add a package dependency to your Xcode project. Select File > Swift Packages > Add Package Dependency and enter its repository URL: https://github.com/Kameleoon/client-swift.

Alternatively, modify your Package.swift file directly as shown in the example to the right.

Additional configuration

A .plist configuration file can also be used to customize the SDK behavior. A sample configuration file can be obtained here. This file should be installed in the root directory of your Xcode project, and should be named exactly kameleoon-client-swift.plist. With the current version of the Swift SDK, those are the available keys:

• actions_configuration_refresh_interval: this specifies the refresh interval, in minutes, of the configuration for experiments and feature flags (the active experiments and feature flags are fetched from the Kameleoon servers). An initial fetch is performed on the first application launch, and subsequent fetches are processed at the defined interval. It means that once you launch an experiment, pause it, or stop it the changes can take (at most) the duration of this interval to be propagated to the end-user iOS devices. If not specified, the default interval is 60 minutes.
• environment: an option specifying which feature flag configuration will be used, by default each feature flag is split into production, staging, development. If not specified, will be set to default value of production. More information

Initializing the Kameleoon Client

import kameleoonClient

public class KameleoonDelegate
{
    private let siteCode = "a8st4f59bj"
    public let kameleoonClient = KameleoonClientFactory.create(sitecode: siteCode)
}

After installing the SDK into your application and setting up an server-side experiment on Kameleoon's back-office, the next step is to create the Kameleoon client.

The code on the right gives a clear example. A Client is a singleton object that acts as a bridge between your application and the Kameleoon platform. It includes all the methods and properties you will need to run an experiment.

While executing the KameleoonClientFactory.create() method initializes the client, on iOS it is not immediately ready for use. This is because the current configuration of experiments (along with their traffic repartition) has to be retrieved from a Kameleoon remote server. This requires network access, which is not always available. Until the Kameleoon client is fully ready, you should not try to run any other method in our SDK. Note that once the first configuration of experiments is fetched, it is then periodically refreshed, but even if the refresh fails for any reason, the Kameleoon client will still be ready and working (but on an outdated / previous configuration).

We provide the .ready public getter to know if the Kameleoon client initialization completed.

Alternatively, we provide a helper callback to encapsulate logic of experiment triggering and variation implementation. What approach (.ready or callback) is best to use depends on your own preferences and on the exact use case at hand. As a rule of thumb, we recommend using .ready when it is expected that the SDK will indeed be ready for use. For instance, if you are running an experiment on some dialog that would be accessible only after a few seconds / minutes of navigation within the application. And we recommend to use the callback when there is a high probability that the SDK is still in the process of initialization. For instance, an experiment that would take place at the launch of the application would be better treated with a callback that would make the application wait until either the SDK is ready or a specified timeout has expired.

Triggering an experiment

Running an A/B experiment on your iOS application means bucketing your users into several groups (one per variation). The SDK takes care of this bucketing (and the associated reporting) automatically.

Triggering an experiment by calling the triggerExperiment() method will register a random variation for a given visitorCode. If this visitorCode is already associated with a variation (most likely the user had already been exposed to the experiment previously), then it will return the previous variation associated with a given experiment.

import kameleoonClient

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
    func applicationWillEnterForeground(_ application: UIApplication) {
        let kameleoonClient = kameleoonDelegate.kameleoonClient
        let visitorCode = "1267576" // usually, this would be the internal ID of the current user
        var variationID : Int
        var recommendedProductsNumber : Int

        if (kameleoonClient.ready) {
            variationID = try? kameleoonClient.triggerExperiment(visitorCode, 75253) ?? 0
        }
        else {
            // The SDK is not ready, so the user is "out of the experiments". This is the same as if he was bucketed into the reference
            variationID = 0
        }

        if (variationID == 0)) {
            //This is the default / reference number of products to display
            recommendedProductsNumber = 5
        }
        else if (variationID == 148382) {
            //We are changing number of recommended products for this variation to 10
            recommendedProductsNumber = 10
        }
        else if (variationID == 187791) {
            //We are changing number of recommended products for this variation to 8
            recommendedProductsNumber = 8
        }
    }
}

We provide two code samples to illustrate the triggering of an experiment. The first one uses the .ready approach. It's a bit simpler.

import kameleoonClient

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
    func applicationWillEnterForeground(_ application: UIApplication) {
        let kameleoonClient = kameleoonDelegate.kameleoonClient
        let visitorCode = "1267576" // usually, this would be the internal ID of the current user
        var variationID : Int
        var recommendedProductsNumber : Int
        kameleoonClient.runWhenReady(1000) { success in
            if (success)
            {
                variationID = try? kameleoonClient.triggerExperiment(visitorCode, 75253) ?? 0
                if (variationID == 0)) {
                    // This is the default / reference number of products to display
                    recommendedProductsNumber = 5
                }
                else if (variationID == 148382) {
                    // We are changing number of recommended products for this variation to 10
                    recommendedProductsNumber = 10
                }
                else if (variationID == 187791) {
                    // We are changing number of recommended products for this variation to 8
                    recommendedProductsNumber = 8
                }
            }
            else
            {
                variationID = 0
                recommendedProductsNumber = 5
            }
        }
    }
}

This is a second example with the callback runWhenReady() approach. You need to pass a lambda as a second argument, with signature (Bool) -> Void. The boolean that will be passed indicates if the SDK is ready or if the timeout was reached. Note that here we used a timeout of 1000 milliseconds.

Implementing variation code

var recommendedProductsNumber : Int

if (variationID == 0)) {
    // This is the default / reference number of products to display
    recommendedProductsNumber = 5
}
else if (variationID == 148382) {
    // We are changing number of recommended products for this variation to 10
    recommendedProductsNumber = 10
}
else if (variationID == 187791) {
    // We are changing number of recommended products for this variation to 8
    recommendedProductsNumber = 8
}

To execute different code paths depending on the variation assigned to the visitor, you will need the list of all the experiment's variation IDs. You can find these variation IDs (as well as the experiment ID) by opening the experiment in the back-office interface. By convention, the reference (original variation) always has an ID equal to 0.

Once you have the IDs of the different variations, you can implement a different action for each variation, and one of the code paths will be executed, based on the associated variationID for the current visitor. Generally, this can be done using a simple if / else or switch mechanism. In our example, we just change the number of recommended products with two different variations.

Tracking conversion

let visitorCode = UUID().uuidString

kameleoonClient.trackConversion(visitorCode : "1267576", goalID : 83023, revenue: 1.0) { success in
    if success {
        // callback code
    }
}

After you are done with triggering an experiment, the next step is usually to start tracking conversions. This is done to measure performance characteristics according to the goals that make sense for your business.

For this purpose, use the trackConversion() method of the SDK as shown in the example. You need to pass the visitorCode and goalID parameters so we can correctly track conversion for this particular user.

Obtaining results

Once your implementation is in place on the mobile app side (experiment triggering, variations handling, and conversion tracking), it is time to launch the experiment on the Kameleoon platform. You do this in the same way as for a front-end test. Basic operations such as starting, pausing and stopping the experiment work exactly in the same way.

After the experiment is launched, first results will be available on our standard results page in the back-office after a duration of 30 minutes. This is because (as is the case with front-end testing) visits are considered over after 30 minutes of inactivity. Inactivity in this context means the absence of calls sent to the Kameleoon back-end servers (such calls are made via triggerExperiment(), trackConversion() or flush() methods).

Getting SDK configuration

Overview

When you update your experiment or feature flag configuration, the SDK can get it in two different ways. The first - polling - consists in retrieving the configuration at regular intervals. The second - streaming - is to retrieve the new configuration immediately.

Polling

This mode of obtaining the configuration is used by default. The SDK will send a request to the server at regular intervals to retrieve the configuration. If you have not set an interval in the SDK configuration, the configuration in SDK will be refreshed every 60 minutes.

Benefits:
• When intervals are moderately spaced, this way of updating configuration consumes nominal memory and network resources.

Streaming

This mode allows the SDK to automatically take into account the new configuration without delay. When turned on, Kameleoon SDK is notified of any changes to the configuration in real-time, thanks to server-sent events (SSE).

Benefits:
• Makes it possible to propagate and apply a new configuration in real-time.
• Reduce network traffic compared to polling at short intervals, as streaming does not require sending periodic requests. It opens the connection once and then keeps it permanently open and ready to receive data.
• The best option for mobile applications requiring real-time updates, as it minimizes battery drain and data usage.

If you rely on instant data updates (real-time), then streaming is for you. If you wish to activate this mode, please contact us.

Reference

This is a full reference documentation of the Swift SDK.

If this is your first time working with the Swift SDK, we strongly recommend you go over our Getting started tutorial to integrate the SDK and start experimenting in a few minutes.

KameleoonClientFactory

create

let kameleoonClient = KameleoonClientFactory.create(sitecode: siteCode)

The starting point for using the SDK is the initialization step. All interaction with the SDK is done through an object named KameleoonClient, therefore you need to create this object.

Arguments

KameleoonClient

isReady

let ready = kameleoonClient.ready

For mobile SDKs, the initialization of the Kameleoon Client is not immediate, as it needs to perform a server call to retrieve the current configuration for all active experiments. It is recommended to check if the SDK is ready by calling this method before triggering an experiment. Alternatively, you could setup error catching around the triggerExperiment() method to look for the KameleoonError.sdkNotReady error, or you could use the runWhenReady() method with a callback as detailed in the next paragraph.

Arguments

Return value

runWhenReady

kameleoonClient.runWhenReady(1000) { success in
    if (success)
    {
        variationID = try? kameleoonClient.triggerExperiment(visitorCode, experimentID) ?? 0
        if (variationID == 0)) {
            // This is the default / reference number of products to display
            recommendedProductsNumber = 5
        }
        else if (variationID == 148382) {
            //We are changing number of recommended products for this variation to 10
            recommendedProductsNumber = 10
        }
        else if (variationID == 187791) {
            //We are changing number of recommended products for this variation to 8
            recommendedProductsNumber = 8
        }
    }
    else
    {
        variationID = 0
        recommendedProductsNumber = 5
    }
}

For mobile SDKs, the initialization of the Kameleoon Client is not immediate, as it needs to perform a server call to retrieve the current configuration for all active experiments. The runWhenReady() method of the KameleoonClient class allows to pass a callback that will be executed as soon as the SDK is ready for use. It also allows the use of a timeout.

The lambda given as second argument to this method must have signature (Bool) -> Void. The lambda will be called with argument true once the Kameleoon client is ready, and should contain code triggering an experiment and implementing variations. The lambda will be called with argument false if the specified timeout happens before the client is initialized. Usually this case should implement the "reference" variation, as the user will be "out of the experiment" if a timeout takes place.

Arguments

triggerExperiment

let visitorCode = UUID().uuidString
let experimentID = 75253

let variationID = try? kameleoonClient.triggerExperiment(visitorCode, experimentID) ?? 0

To trigger an experiment, call the triggerExperiment() method of our SDK.

This method takes visitorCode and experimentID as mandatory arguments to register a variation for a given user. If such a user has never been associated with any variation, the SDK returns a randomly selected variation. In case a user with a given visitorCode is already registered with a variation, it will detect the previously registered variation and return the variationID.

You have to make sure that proper error handling is set up in your code as shown in the example to the right to catch potential errors.

Arguments

Return value

Errors Thrown

activateFeature

let visitorCode = UUID().uuidString
let featureKey = "new_checkout"
var hasNewCheckout = false

do {
    hasNewCheckout = try kameleoonClient.activateFeature(visitorCode: visitorCode, featureKey: featureKey)
} catch {
    if let kameleoonError = error as? KameleoonError {
        switch kameleoonError {
            // Handle error
            hasNewCheckout = false
        }
    }
}

if hasNewCheckout
{
    // Implement new checkout code here
}

To activate a feature toggle, call the activateFeature() method of our SDK.

This method takes a visitorCode and featureKey (or featureID) as mandatory arguments to check if the specified feature will be active for a given user.

If such a user has never been associated with this feature flag, the SDK returns a boolean value randomly (true if the user should have this feature or false if not). If a user with a given visitorCode is already registered with this feature flag, it will detect the previous featureFlag value.

You have to make sure that proper error handling is set up in your code as shown in the example to the right to catch potential errors.

Arguments

Return value

Errors Thrown

obtainVariationAssociatedData

let visitorCode = UUID().uuidString
let experimentID = 75253

do {
    let variationID = kameleoonClient.triggerExperiment(visitorCode, experimentID: experimentID)
    let jsonObject = kameleoonClient.obtainVariationAssociatedData(variationID)
    let firstName = jsonObject["firstName"] as? String
}
catch {
    if let kameleoonError = error as? KameleoonError {
        switch kameleoonError {
            // Handle error
        }
    }
}

To retrieve JSON data associated with a variation, call the obtainVariationAssociatedData() method of our SDK. The JSON data usually represents some metadata of the variation, and can be configured on our web application interface or via our Automation API.

This method takes the variationID as a parameter and will return the data as a JSON object. It will throw an error (KameleoonError.variationConfigurationNotFound) if the variation ID is wrong or corresponds to an experiment that is not yet online.

Arguments

Return value

Errors Thrown

obtainFeatureVariable

String featureKey = "myFeature"
String variableKey = "myVariable"

try {
    let variable = kameleoonClient.obtainFeatureVariable(featureKey: featureKey, variableKey: variableKey)
}
catch {
    if let kameleoonError = error as? KameleoonError {
        switch kameleoonError {
            // Handle error
        }
    }
}

To retrieve a feature variable, call the obtainFeatureVariable() method of our SDK. A feature variable can be changed easily via our web application.

This method takes two input parameters: featureKey and variableKey. It will return the data as a Any instance. Usually it should be casted to the expected type (the one defined on the web interface). It will throw an error (KameleoonError.featureConfigurationNotFound) if the requested feature has not been found in the internal configuration of the SDK.

Arguments

Return value

Errors Thrown

trackConversion

let visitorCode = UUUID().uuidString
let goalID = 83023

kameleoonClient.addData(visitorCode : visitorCode, data : Interest(2))
kameleoonClient.addData(visitorCode : visitorCode, data : Conversion(goalID : 32, revenue : 10.0, negative : false))
kameleoonClient.trackConversion(visitorCode : visitorCode, goalID : goalID, revenue: 10.0)

To track conversion, use the trackConversion() method. This method requires visitorCode and goalID to track conversion on this particular goal. In addition, this method also accepts revenue as a third optional argument to track revenue. The visitorCode should be identical to the one that was used when triggering the experiment.

The trackConversion() method doesn't return any value. This method is non-blocking as the server call is made asynchronously.

Arguments

Errors Thrown

addData

kameleoonClient.addData(visitorCode : visitorCode, data : Interest(2))
kameleoonClient.addData(visitorCode : visitorCode, data : Conversion(goalID : 32, revenue : 10.0, negative : false))

To associate various data with the current user, we can use the addData() method. This method requires the visitorCode as a first parameter, and then accept several additional parameters. Those additional parameters represent the various Data Types allowed in Kameleoon.

Note that the addData() method doesn't return any value and doesn't interact with the Kameleoon back-end servers by itself. Instead, every data declared is saved for further sending via the flush() method described in the next paragraph. This allows a minimal number of server calls to be made, as data are usually regrouped in a single server call triggered by the execution of flush().

Arguments

Errors Thrown

flush

let visitorCode = UUID().uuidString

kameleoonClient.addData(visitorCode : visitorCode, data : Interest(2))
kameleoonClient.addData(visitorCode : visitorCode, data : Conversion(goalID : 32, revenue : 10.0, negative : false))
kameleoonClient.flush(visitorCode : visitorCode)

Data associated with the current user via addData() method is not sent immediately to the server. It is stored and accumulated until it is sent automatically by the triggerExperiment() or trackConversion() methods, or manually by the flush() method. This allows the developer to exactly control when the data is flushed to our servers. For instance, if you call the addData() method a dozen times, it would be a waste of ressources to send data to the server after each addData() invocation. Just call flush() once at the end.

The flush() method doesn't return any value. This method is non-blocking as the server call is made asynchronously.

Arguments

Errors Thrown

retrieveDataFromRemoteSource

struct Test1: Decodable {
    let value: String

    private enum CodingKeys: String, CodingKey {
        case value = "json_value"
    }
}

do {
    try kameleoonClient.retrieveDataFromRemoteSource(key: "test") { (test: Test1) in
        print(test.value)
    }
} catch {
}

do {
    try kameleoonClient.retrieveDataFromRemoteSource(key: "test") { (data: Data) in
        do {
            if let json = try JSONSerialization.jsonObject(with: data) as? [String: Any] {
                print(json)
            }
        }
    }
} catch {
}

The retrieveDataFromRemoteSource() method allows you to retrieve data (according to a key passed as argument) for specified siteCode (specified in KameleoonClientFactory.create()) stored on a remote Kameleoon server. Usually data will be stored on our remote servers via the use of our Data API. This method, along with the availability of our highly scalable servers for this purpose, provides a convenient way to quickly store massive amounts of data that can be later retrieved for each of your visitors / users.

Note that since a server call is required, this mechanism is asynchronous, and you must pass a completionHandler as argument to the method.

Arguments

Errors Thrown

updateConfigurationHandler

kameleoonClient.updateConfigurationHandler {
    // configuration was updated
}

The updateConfigurationHandler() method allows you to handle the event when configuration has updated data. It takes one input parameter handler. The handler that will be called when the configuration is updated using a real-time configuration event.

Arguments

Data

Conversion

try? kameleoonClient.addData(visitorCode : visitorCode, data : Conversion(goalID : 32, revenue : 10.0, negative : false))

CustomData

try? kameleoonClient.addData(visitorCode : visitorCode, data : CustomData(id : 1, value : "some custom value"))

Interest

try? kameleoonClient.addData(visitorCode : visitorCode, data : Interest(2))