Dev guideAPI Reference
Dev guideAPI ReferenceUser GuideGitHubNuGetDev CommunityDoc feedbackLog In
GitHubNuGetDev CommunityDoc feedback

OptimizelyUserContext for the JavaScript (Node) SDK

Explains the OptimizelyUserContext object, which allows you to make flag decisions and track events for a user context for the Optimizely Feature Experimentation JavaScript (Node) SDK.

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 minimum SDK version

OptimizelyUserContext is supported on SDK v3.7 and higher.

Forced decision methods minimum SDK version

setForcedDecision(), getForcedDecision(), removeForcedDecision() and removeAllForcedDecisions() methods are supported on v4.9.0 and higher.

OptimizelyUserContext definition

The following code shows the object definition for OptimizelyUserContext:

interface OptimizelyUserContext {
    // set an attribute for the user
    setAttribute(key: string, value: unknown): void;

    // return user attributes
    getAttributes(): UserAttributes;

    // make a decision about which flag variation the user buckets into for the flag key 
    decide(
      key: string,
      options: OptimizelyDecideOption[] = []
      ): OptimizelyDecision;

    // make decisions about which flag variations the user buckets into for flag keys
    decideForKeys(
      keys: string[],
      options: OptimizelyDecideOption[] = [],
      ): { [key: string]: OptimizelyDecision };

    // make decisions about which flag variations the user buckets into for all flags
    decideAll(
      options: OptimizelyDecideOption[] = []
      ): { [key: string]: OptimizelyDecision };

    // track user event
    trackEvent(eventName: string, eventTags?: EventTags): void;
    
    // Sets the forced decision (variationKey) for a given decision context
    setForcedDecision(context: OptimizelyDecisionContext, decision: OptimizelyForcedDecision): boolean;

    // Returns the forced decision for a given decision context
    getForcedDecision(context: OptimizelyDecisionContext): OptimizelyForcedDecision | null;

    // Removes the forced decision for a given decision context
    removeForcedDecision(context: OptimizelyDecisionContext): boolean;

    // Removes all forced decisions bound to this user context
    removeAllForcedDecisions(): boolean;
}

Properties

The following table shows attributes for the OptimizelyUserContext object:

AttributeTypeComment
userIdStringThe ID of the user
(optional) attributesMapA map 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.
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.
decideAllReturns decisions for all active (unarchived) flags for a user.
See Decide methods.
decideForKeysReturns a map of flag decisions for specified flag keys.
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

Source files

The language and platform source files containing the implementation for the JavaScript (Node) SDK are available on GitHub.