Create a user context using the Swift SDK

7 min

Create a user for which you can make flag decisions and track events. The user context is returned as a runtime object that is not otherwise persisted. The purpose of this method is to set a user context once, so you do not have to specify the user each time you make a flag decision or track an event. You can define multiple user contexts.

Version

SDK v3.7 and higher

Description

This call creates a user context for flag decisions and events. You can call this method on the Optimizely client instance, even when the instance is not fully configured yet.

Parameters

The following table lists the required and optional parameters:

Parameter	Type	Description
userId required	string	The ID of the user.
attributes\ optional	map	A map of custom key-value pairs specifying attributes for the user that are used for audience targeting. See the following section for more details.

Audience attributes

You can set custom audience attributes for the user, which you can then use to Target audiences. You can pass strings, numbers, Booleans, and nil as custom user attribute values. If you want to target audiences based on the version of your application that they are using, you can also pass in a string formatted as a semantic version, then define a version audience condition in the Optimizely app.

Important During audience evaluation, note that if you don't pass a valid attribute value for a given audience condition, for example, if you pass a string when the audience condition requires a Boolean, or if you forget to pass a value, then that condition is skipped. The SDK logs will include warnings when this occurs.

Returns

Returns an OptimizelyUserContext object. For details, see OptimizelyUserContext.

Create a user context with the device VUID

Enable the visitor unique ID (VUID) with OptimizelySdkSettings(enableVuid: true) when you initialize the SDK. Then create a user context for an anonymous user without a user ID:

public func createUserContext(attributes: [String: Any]? = nil) -> OptimizelyUserContext?

This overload uses the device VUID (available as optimizely.vuid) as the user ID. It returns nil and logs an error if VUID is not enabled.

Example

let optimizely = OptimizelyClient(sdkKey: "sdk-key")
optimizely.start { result in
  // Option 1 – Create a user, then set attributes.
	let user = optimizely.createUserContext(userId: "user123")
	user.setAttribute(key: "is_logged_in", value: false)
	user.setAttribute(key: "app_version", value: "1.3.2")

	// Option 2 - Pass attributes when creating the user.
	let attributes: [String: Any] = [
  	"device": "iPhone",
  	"lifetime": 24738388,
  	"is_logged_in": true,
  	"app_version": "4.3.0-beta",
	]

	let user2 = optimizely.createUserContext(userId: "user123", attributes: attributes)
}

Source files

The language/platform source files containing the implementation for Swift is OptimizelyClient.swift.