Feature Flag Determination

A feature flag has an on and off state. You will set different features according to each state.

Once a feature flag is applied, a specific user from your traffic should be able to either receive an off or on status. This on/off status determination can be done through the Hackle SDK.

๐Ÿšง

Unity Editor

Unity SDK relies on Android and iOS SDK.
Therefore, features flags created on the Unity Editor always return as false, which means the feature flag is turned off.

IsFeatureOn

You can pass a feature key to the isFeatureOn() method to receive status results for the user. After receiving the status, we can then implement the logic according to each status.

In the example code below, we are passing feature key 42, and the user identifier of the user who will receive the status is "ae03e1adf".

// Determines the status of the feature flag to assign users with a feature key of 42.
// For undetermined cases, users are assigned to false (off status). 
bool isFeatureOn = hackle.IsFeatureOn(42);

if (isFeatureOn) {
    // Logic for on status
} else {
    // Logic for off status
}

FeatureFlagDetail

The feature_flag_detail() method works like the IsFeatureOn() method but additionally provides a reason for determining the status of a particular user. This can be useful when you want to check whether the manual allocation is working well or when you think that the traffic allocation you have set is not being reflected in your results.

You must pass a feature key as a parameter. For the example code below, we are passing feature key 42.

// Status determination details
HackleFeatureFlagDecision decision = hackle.FeatureFlagDetail(42);

// Feature flag on/off results 
bool isFeatureOn = decision.isOn;

// Reason for status determination
string reason = decision.reason;

Please refer to the table below for the full list of reasons for different status determinations.

ReasonDescriptionFeature Status
SDK_NOT_READYThe SDK is not ready to use.
(e.g. trying to initialize with the wrong SDK key)
Default status(off)
FEATURE_FLAG_NOT_FOUNDNo feature flags were found for the function key you passed in.
The feature key may be incorrect or the corresponding feature flag may be in an archived state.
Default status(off)
FEATURE_FLAG_INACTIVEThe feature flag is off.Default status(off)
INDIVIDUAL_TARGET_MATCHUser has been matched to individual targeting settings.Set to individual targeting
TARGET_RULE_MATCHUser has been matched to audience targeting settings.Set to audience targeting
DEFAULT_RULEUser has not been matched to either individual targeting or audience targeting.Default status (off)
EXCEPTIONAn unknown error has occurred.Default status(off)

Feature Flag Parameter

  • Call featureFlagDetail() method to obtain parameter values which contains the feature flag status information
  • FeatureFlagDecisioninstance passed through the featureFlagDetail() method has full parameter setting information.
  • Parameter values you've set on the dashboard exists in the form of key and value, therefore you can use the method below to set the parameter values.
  • You can change feature flag's parameter values flexibly on the Feature Flag > Parameter Settings.

๐Ÿ“˜

Parameter setting is only available for SDK version 1.3.0 or higher.

getString

  • Returns the parameter value set to STRING, JSON type.
  • Returns the default value or the value set in the rule based on the status determination.
HackleFeatureFlagDecision decsision = hackle.FeatureFlagDetail(42, "ae03e1adf");

string strValue = decsision.GetString("parameter_key_string_type", "defaultValue");
string jsonValue = decsision.GetString("parameter_key_json_type", "{}");

getInt

  • Returns the parameter value set to Number type as Int type.
  • Returns the default value or the value set in the rule based on the status determination.
HackleFeatureFlagDecision decsision = hackle.FeatureFlagDetail(42, "ae03e1adf");

int intValue = decsision.GetInt("parameter_key_number_type", 0);

getDouble

  • Returns the parameter value set to Number type as Double type.
  • Returns the default value or the value set in the rule based on the status determination.
HackleFeatureFlagDecision decsision = hackle.FeatureFlagDetail(42, "ae03e1adf");

double doubleValue = decsision.GetDouble("parameter_key_number_type", 0.0);

getLong

  • Returns the parameter value set to Number type as Long type.
  • Returns the default value or the value set in the rule based on the status determination.
HackleFeatureFlagDecision decsision = hackle.FeatureFlagDetail(42, "ae03e1adf");

long longValue = decsision.GetLong("parameter_key_number_type", 0);

getBoolean

  • Returns the parameter value set to Boolean type.
  • Returns the default value or the value set in the rule based on the status determination.
HackleFeatureFlagDecision decsision = hackle.FeatureFlagDetail(42, "ae03e1adf");

bool boolValue = decsision.GetBoolean("parameter_key_boolean_type", false);