Example usage of the Swift SDK
A brief code example of how to use the Optimizely Feature Experimentation Swift SDK to evaluate feature flags, activate A/B tests, or feature tests.
Once you have installed an SDK, import the Optimizely Feature Experimentation library into your code, get your Optimizely Feature Experimentation project's datafile, and instantiate a client. Then, you can use the client to evaluate flag rules, including A/B tests and flag deliveries.
This example demonstrates the basic usage of each of these concepts:
-
Evaluate a flag with the key
product_sort
using the Decide method. As a side effect, the Decide function also sends a decision event to Optimizely Feature Experimentation to record that the current user has been exposed to the experiment. -
Conditionally execute your feature code. You have a couple of options:
- Fetch the flag enabled state, then check a configuration variable on the flag called
sort_method
. The SDK evaluates your flag rules and determines what flag variation the user is in, and therefore which sort method variable they should see. - Fetch on the flag variation, then run 'control' or 'treatment' code.
- Use event tracking to track an event called
purchased
. This conversion event measures the impact of an experiment. Using the Track Event method, the purchase is automatically attributed back to the running A/B test for which we made a decision, and the SDK sends a network request to Optimizely Feature Experimentation using the customizable event dispatcher so Optimizely can count it in your results page.
// initialize an Optimizely client
optimizely = OptimizelyClient(sdkKey: "<Your_SDK_Key>")
// create a user and decide a flag rule (such as an A/B test) for them
let user = optimizely.createUserContext(userId: "user123", attributes: ["logged_in":true])
let decision = user.decide(key: "product_sort")
// did the decision fail with a critical error?
guard let variationKey = decision.variationKey else {
print("decide error: \(decision.reasons)")
return
}
// execute code based on flag enabled state
let enabled = decision.enabled
if (enabled) {
// get flag variable values
let sortMethod: String? = decision.variables.getValue(jsonPath: "sort_method")
// or:
let sortMethod: String? = decision.variables.toMap()["sort_method"] as? String
}
// or execute code based on flag variation:
if (variationKey == "control") {
// Execute code for control variation
} else if (variation.variationKey == "treatment") {
// Execute code for treatment variation
}
// Track a user event
try? user.trackEvent(eventKey: "purchased")
Updated 9 months ago