OmniFlags.Sdk 1.0.19

OmniFlags .NET SDK

.NET SDK for OmniFlags. Supports ASP.NET Core, Worker Services, and standalone apps.

Installation

dotnet add package OmniFlags.Sdk

ASP.NET Core / Generic Host

Register the SDK in Program.cs:

builder.Services.AddOmniFlags(options =>
{
    options.SdkKey = "your-sdk-key";
});

The SDK initializes and starts background polling automatically as a hosted service. Inject OmniFlagsClient wherever you need it:

public class ProductController(OmniFlagsClient flags) : ControllerBase
{
    [HttpGet("/products")]
    public IActionResult Get()
    {
        var newLayout = flags.IsEnabled("store.new-product-layout");
        return Ok(newLayout ? GetNewLayout() : GetLegacyLayout());
    }
}

Standalone usage

var httpClient = new HttpClient();
var client = new OmniFlagsClient(new OmniFlagsOptions { SdkKey = "your-sdk-key" }, httpClient);

await client.InitializeAsync();

var enabled = client.IsEnabled("store.dark-mode");

Call client.Dispose() when done to stop polling and flush metrics.

Configuration

Load from appsettings.json

{
  "OmniFlags": {
    "SdkKey": "your-sdk-key"
  }
}

builder.Services.AddOmniFlags(options =>
    builder.Configuration.GetSection("OmniFlags").Bind(options));

Evaluation

Flag keys are namespaced by project: {projectKey}.{flagKey}.

// Boolean
bool enabled = client.IsEnabled("store.show-banner");

// Typed value methods
bool   dark  = client.GetBoolean("store.dark-mode", false);
string theme = client.GetString("store.theme", "light");
double ratio = client.GetNumber("store.ab-weight", 0.5);

// Generic — for complex types
var config = client.GetValue<MyConfig>("store.config", defaultConfig);

// Full result (variant, reason, rule matched)
EvaluationResult result = client.GetVariant("store.show-banner");
// result.Value, result.Variant, result.Reason, result.RuleId, result.ErrorCode

Context

Pass context per evaluation call — customer, business, branch, country, etc. There is no persistent context state on the client.

var ctx = new EvaluationContext
{
    CustomerId       = request.CustomerId,
    AgentId          = request.AgentId,
    BusinessId       = request.BusinessId,
    BusinessBranchId = request.BusinessBranchId,
};

bool enabled = client.IsEnabled("store.show-banner", ctx);
string theme  = client.GetString("store.theme", "light", ctx);

Status

ProviderStatus status = client.Status; // NotReady | Ready | Stale | Error

// Wait until the first snapshot is loaded before serving traffic
await client.WaitForReadyAsync();

Polling runs in the background on a server-driven interval (default: 5 minutes). If a poll fails but a previous snapshot exists, status moves to Stale and evaluations continue against the last known flags.

Target frameworks

.NET 8.0+