HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

OptimizelyUserContext

This topic describes the OptimizelyUserContext Object which allows you to make flag decisions and track events for a user context.

The OptimizelyUserContext object allows you to make flag decisions and track events for a user context that you have already created using the Create User Context method.

OptimizelyUserContext version

OptimizelyUserContext is supported on SDK v3.7 and higher.

Forced decision methods version

SetForcedDecision(), GetForcedDecision(), RemoveForcedDecision() and RemoveAllForcedDecisions() methods are supported on v3.11.0 and higher.

OptimizelyUserContext Updates

public class OptimizelyUserContext {
    public OptimizelyUserContext(Optimizely optimizely, 
                               string userId,
                               UserAttributes userAttributes, 
                               ForcedDecisionsStore forcedDecisionsStore, 
                               IErrorHandler errorHandler, ILogger logger)
  
    // set an attribute for the user
    public void SetAttribute(string key, object value)
    
    // get attributes for the user
    public UserAttributes GetAttributes()

    // make a decision about which flag variation the user buckets into for the flag key 
    public OptimizelyDecision Decide(string key, 
                                     OptimizelyDecideOption[] options)
    // make decisions about which flag variations the user buckets into for flag keys
    public Dictionary<string, OptimizelyDecision> DecideForKeys(string[] keys, 
                                      OptimizelyDecideOption[] options)
    // make decisions about which flag variations the user buckets into for all flags
    public Dictionary<string, OptimizelyDecision> DecideAll(OptimizelyDecideOption[] options)
    
    // track user event
    public void TrackEvent(string eventName, 
                           EventTags eventTags)
    
    // sets a forced decision (variationKey) for a given decision context
    public bool SetForcedDecision(OptimizelyDecisionContext context, OptimizelyForcedDecision decision)

    // returns the forced decision (variationKey) for a given decision context
    public OptimizelyForcedDecision GetForcedDecision(OptimizelyDecisionContext context)

    // removes the forced decision (variationKey) for a given decision context
    public bool RemoveForcedDecision(OptimizelyDecisionContext context)

    // removes all the forced decisions (variationKeys) for the user context
    public bool RemoveAllForcedDecisions()
}

Properties

AttributeTypeComment
userIdstringThe ID of the user
(optional)
attributes
DictionaryA dictionary of custom key-value pairs specifying attributes for the user that are used for audience targeting . You can pass the map with the user ID when you create the user.

Methods

The following table shows methods for the OptimizelyUserContext object:

MethodComment
SetAttributePass a custom user attribute as a key-value pair to the user context.
GetAttributesGet attributes for the user
DecideReturns a decision result for a flag key for a user. The decision result is returned in an OptimizelyDecision object and contains all data required to deliver the flag rule.
See Decide methods
DecideForKeysReturns a map of flag decisions for specified flag keys.
See Decide methods
DecideAllReturns decisions for all active (unarchived) flags for a user.
See Decide methods
TrackEventTracks a conversion event (in other words, an action a user takes) for a user. Logs an error message if the specified event key doesn't match any existing events.
See Track Event
SetForcedDecisionForces a user into a specific variation.
See Set Forced Decision
GetForcedDecisionReturns what variation the user was forced into.
See Get Forced Decision
RemoveForcedDecisionRemoves a user from a specific forced variation.
See Remove Forced Decision
RemoveAllForcedDecisionsRemoves a user from all forced variations.
See Remove All Forced Decisions

See also

Create User Context
Forced Decision methods

Source files

The language/platform source files containing the implementation for Csharp are at Optimizely.cs.