HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

Updating usage from older versions

This topic describes how to update from older versions of the Optimizely Swift SDK.

Code examples

This section provides code examples for how we recommend leveraging our new Decision and Event Tracking APIs. All existing methods and implementation are still included and supported and will only be removed after deprecation marking and with a future Major version.

We recommend adopting the new Decide, Decide All and Track Event methods as more flexible and easier to use replacements for cases where you currently use isFeatureEnabled, getFeatureVariable, getAllFeatures or Track calls within your implementation.

Refer to an earlier version of the SDK reference guides for earlier methods.

The following are some examples of how to migrate older methods to newer methods.

// -------------------------------
// Prereq for new methods: create a user
// ------------------------------
let attributes: [String: Any] = ["is_logged_in": true]
let user = optimizely.createUserContext(userId: "user_123", attributes: attributes)

// -------------------------------
// Is Feature Enabled 
// ------------------------------
// old method
let enabled = optimizely.isFeatureEnabled(featureKey: "flag_1", userId: "user_123", attributes: attributes)

// new method
let decision = user.decide(key: "flag_1")
let enabled = decision.enabled

// -------------------------------
// Activate & Get Variation 
// ------------------------------
// old method
let variationKey = try? optimizely.activate(experimentKey:"experiment_1",
                                            userId: "user_123",
                                            attributes: attributes)
// new method
let variationKey = decision.variationKey



// -------------------------------
// Get All Feature Variables 
// ------------------------------
// old method
let allVarValues = try? optimizelyClient.getAllFeatureVariables(featureKey: "flag_1",
                                                            userId: "user_123",) 
// new method
let allVarValues = decision.variables


// -------------------------------
// Get Enabled Features 
// ------------------------------
// old method
let enabledFlags = optimizely.getEnabledFeatures(userId: "user_123")

// new method
let decisions = user.decideAll(options: [.enabledFlagsOnly])
let enabledFlags = decisions.keys


// -------------------------------
// Track 
// ------------------------------
// old method
try? optimizely.track(eventKey: "my_purchase_event_key", 
                                            userId: "user_123", 
                      attributes: attributes, 
                      eventTags: ["purchase_count": 2])

// new method
try? user.trackEvent(eventKey: 'my_purchase_event_key', 
                     eventTags: ["purchase_count": 2])

Activate method and A/B Tests

Like the existing Is Feature Enabled method, the Decide methods are based on feature flag keys, and do not support standalone A/B tests or Multi-armed Bandits. We are working to unify the data models and interfaces for our application longer term to mitigate the need to maintain multiple different access methods. In the meantime, you can still use the Activate and Get Variation methods for standalone A/B tests in your legacy projects alongside the Decide methods.