Skip to content

.NET SDK for ConfigCat. ConfigCat is a hosted feature flag service: https://configcat.com. Manage feature toggles across frontend, backend, mobile, desktop apps. Alternative to LaunchDarkly. Management app + feature flag SDKs.

master
Switch branches/tags
Code

ConfigCat SDK for .NET

Supported frameworks:

  • .NET Core
  • .NET Framework
  • Xamarin
  • .NET Standard

https://configcat.com

ConfigCat SDK for .NET provides easy integration for your application to ConfigCat.

ConfigCat is a feature flag and configuration management service that lets you separate releases from deployments. You can turn your features ON/OFF using ConfigCat Dashboard even after they are deployed. ConfigCat lets you target specific groups of users based on region, email or any other custom user attribute.

ConfigCat is a hosted feature flag service. Manage feature toggles across frontend, backend, mobile, desktop apps. Alternative to LaunchDarkly. Management app + feature flag SDKs.

Build status NuGet Version codecov Quality Gate Status License: MIT

Getting Started

1. Install the package with NuGet

Install-Package ConfigCat.Client

or

dotnet add package ConfigCat.Client

2. Import ConfigCat.Client to your application

using ConfigCat.Client;

3. Go to Connect your application tab to get your SDK Key:

SDK-KEY

4. Create a ConfigCat client instance:

var client = new ConfigCatClient("#YOUR-SDK-KEY#");

We strongly recommend using the ConfigCat Client as a Singleton object in your application.

5. Get your setting value:

var isMyAwesomeFeatureEnabled = client.GetValue("isMyAwesomeFeatureEnabled", false);

if(isMyAwesomeFeatureEnabled)
{
    doTheNewThing();
}
else
{
    doTheOldThing();
}

6. On application exit:

client.Dispose();

To ensure graceful shutdown of the client you should invoke .Dispose() method. (Client implements IDisposable interface)

Getting user specific setting values with Targeting

Using this feature, you will be able to get different setting values for different users in your application by passing a User Object to the GetValue() function.

Read more about Targeting here.

User currentUser = new User("435170f4-8a8b-4b67-a723-505ac7cdea92");

var isMyAwesomeFeatureEnabled = client.GetValue(
	"isMyAwesomeFeatureEnabled",
	defaultValue: false,
	user: currentUser);

Sample/Demo apps

Polling Modes

The ConfigCat SDK supports 3 different polling mechanisms to acquire the setting values from ConfigCat. After latest setting values are downloaded, they are stored in the internal cache then all requests are served from there. Read more about Polling Modes and how to use them at ConfigCat Docs.

Need help?

https://configcat.com/support

Contributing

Contributions are welcome.

About ConfigCat

About

.NET SDK for ConfigCat. ConfigCat is a hosted feature flag service: https://configcat.com. Manage feature toggles across frontend, backend, mobile, desktop apps. Alternative to LaunchDarkly. Management app + feature flag SDKs.

Topics

Resources

License

Packages

No packages published

Languages