Dev guideAPI Reference
Dev guideAPI ReferenceUser GuideGitHubNuGetDev CommunitySubmit a ticketLog In
GitHubNuGetDev CommunitySubmit a ticket

Forced Decision methods for the Flutter SDK

Describes the Forced Decision methods, which you can use with the Flutter SDK to force users into a specific variation in Optimizely Feature Experimentation.

Use these methods to test and debug various flows of your client applications by forcing users into a specific variation.

The Flutter SDK checks forced decisions before making any decisions. If it finds a matching for the requested flag, the Flutter SDK returns the forced decision immediately (audience conditions and ignores traffic allocations) before making normal decisions.

The following describes specific scenarios the Flutter SDK follows:

Flag-to-Decision

  • SDK looks up at the beginning of any decide call for the given flag. If a matching Flag-to-Decision forced decision is found for the flag, it returns the decision.

Experiment-Rule-to-Decision

  • SDK looks up at the beginning of the decision for the given experiment rule (of the flag key). If a matching Experiment-Rule-to-Decision forced decision is found for the flag, it returns the decision.

Delivery-Rule-to-Decision

  • SDK looks up at the beginning of the decision for the given delivery rule (of the flag key). If a matching Delivery-Rule-to-Decision forced decision is found, it returns the decision.

❗️

Warning

You must associate your variation(s) to a flag rule before calling any Forced Decision methods.

On forced decisions, SDK fires impression events and notifications just like other normal decisions (unless disabled by the disableDecisionEvent option).

📘

Note

These forced decisions are not persistent and the system clears them when the OptimizelyUserContext is reinitialized.

For more information about each method click on the method name below:

OptimizelyDecisionContext

class OptimizelyDecisionContext {
  String flagKey;
  String? ruleKey;

  OptimizelyDecisionContext(this.flagKey, [this.ruleKey]);
}

OptimizelyForcedDecision

class OptimizelyForcedDecision {
  String variationKey;

  OptimizelyForcedDecision(this.variationKey);
}

Set Forced Decision Method - setForcedDecision()

Version

1.0.1 or higher

Description

Sets a forced decision (variationKey) for a given OptimizelyDecisionContext.

Parameters

This table lists the required and optional parameters for the Flutter SDK.

ParameterTypeDescription
context
required
StructAn instance of OptimizelyDecisionContext with the required flagKey and optional ruleKey for the forced decision you want to set.
decision
required
StructAn instance of OptimizelyForcedDecision with the required variationKey for the forced decision you want to set.

Returns

A Boolean value that indicates if setting the forced decision (variationKey) was completed successfully.

Example

See the full Flutter SDK example here.

Get Forced Decision Method - getForcedDecision()

Version

1.0.1 or higher

Description

Returns the forced decision (variationKey) for a given OptimizelyDecisionContext. Returns the OptimizelyForcedDecision instance or null if there is no matching item.

Parameters

This table lists the required and optional parameters for the Flutter SDK.

ParameterTypeDescription
context
required
structAn instance of OptimizelyDecisionContext with the required flagKey and optional ruleKey for the forced decision you want to get.

Returns

A forced decision OptimizelyForcedDecision instance for the context or null if there is no matching item.

Example

See the full Flutter SDK example in the Full Code Example section.

Remove Forced Decision Method - removeForcedDecision()

Version

1.0.1 or higher

Description

Removes the forced decision (variationKey) for a given OptimizelyDecisionContext.

Parameters

This table lists the required and optional parameters for the Flutter SDK.

ParametersTypeDescription
context
required
structAn instance of OptimizelyDecisionContext with the required flagKey and optional ruleKey for the forced decision you want to remove.

Returns

A success/failure Boolean status if the forced decision (variationKey) was removed.

Example

See the full Flutter SDK example in the Full Code Example section.

Remove All Forced Decisions Method - removeAllForcedDecisions()

Version

1.0.1 or higher

Description

Removes all forced decisions (variationKey) for the user context.

Parameters

This table lists the required and optional parameters for the Flutter SDK.

ParametersTypeDescription
NoneN/AN/A

Returns

A success/failure boolean status.

Example

See the full Flutter SDK example Full Code Example section.

Full Code Example

/* Create the OptimizelyUserContext, passing in the UserId and Attributes */
var user = await optimizelyClient.createUserContext(userId: "user-id");

var flagContext = OptimizelyDecisionContext("flag-1");
var flagAndABTestContext = OptimizelyDecisionContext("flag-1", "exp-1");
var flagAndDeliveryRuleContext = OptimizelyDecisionContext("flag-1", "delivery-1");
var variationAForcedDecision = OptimizelyForcedDecision("variation-a");
var variationBForcedDecision = OptimizelyForcedDecision("variation-b");
var variationOnForcedDecision = OptimizelyForcedDecision("on");

// set a forced decision for a flag
var success = await user!.setForcedDecision(flagContext, variationAForcedDecision);
var decision = await user.decide("flag-1");

// set a forced decision for an ab-test rule
success = await user.setForcedDecision(flagAndABTestContext, variationBForcedDecision);
decision = await user.decide("flag-1");

// set a forced variation for a delivery rule
success = await user.setForcedDecision(flagAndDeliveryRuleContext, variationOnForcedDecision);
decision = await user.decide("flag-1");

// get forced variations
var forcedDecision = await user.getForcedDecision(flagContext);
print("[ForcedDecision] variationKey = ${forcedDecision.variationKey}");

// remove forced variations
success = await user.removeForcedDecision(flagAndABTestContext);
success = await user.removeAllForcedDecisions();

See Also

OptimizelyUserContext

Source Files

The language/platform source files containing the implementation for Flutter Android is at Optimizely.java and for Flutter iOS is at OptimizelyClient.swift.