Skip to content

Latest commit

 

History

History
120 lines (94 loc) · 6.92 KB

README.md

File metadata and controls

120 lines (94 loc) · 6.92 KB
Raw

ConfigCat SDK for .NET

https://configcat.com

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

About

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 Sonar Coverage Quality Gate Status License: MIT

Supported runtimes

  • .NET 5+
  • .NET Framework 4.5+
  • Other runtimes which implement .NET Standard 2.0+ like .NET Core 2.0+, Xamarin.Android 8.0+, Xamarin.iOS 10.14+, etc. (For more details, please refer to this table.)

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 the ConfigCat Dashboard to get your SDK Key:

SDK-KEY

4. Create a ConfigCat client instance:

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

You can acquire singleton client instances for your SDK keys using the ConfigCatClient.Get(sdkKey: <sdkKey>) static factory method. (However, please keep in mind that subsequent calls to ConfigCatClient.Get() with the same SDK Key return a shared client instance, which was set up by the first call.)

5. Get your setting value:

var isMyAwesomeFeatureEnabled = await client.GetValueAsync("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.) Alternatively, you can also close all open clients at once using the ConfigCatClient.DisposeAll() method.

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 = await client.GetValueAsync(
	"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.

Platform compatibility

The ConfigCat SDK supports all the widespread .NET JIT runtimes, everything that implements .NET Standard 2.0+ and supports TLS 1.2 should work. Starting with v9.3.0, it can also be used in applications that employ trimmed self-contained or various ahead-of-time (AOT) compilation deployment models.

Based on our tests, the SDK is compatible with the following runtimes/deployment models:

  • .NET Framework 4.5+ (including Ngen)
  • .NET Core 3.1, .NET 5+ (including Crossgen2/ReadyToRun and Native AOT)
  • Mono 5.10+
  • .NET for Android (formerly known as Xamarin.Android)
  • .NET for iOS (formerly known as Xamarin.iOS)
  • Unity 2021.3+ (Mono JIT)
  • Unity 2021.3+ (IL2CPP)*
  • Universal Windows Platform 10.0.16299.0+ (.NET Native)**
  • WebAssembly (Mono AOT/Emscripten, also known as wasm-tools)

*Unity WebGL also works but needs a bit of extra effort: you will need to enable WebGL compatibility by calling the ConfigCatClient.PlatformCompatibilityOptions.EnableUnityWebGLCompatibility method. For more details, see Sample Scripts.
**To make the SDK work in Release builds on UWP, you will need to add <Namespace Name="System.Text.Json.Serialization.Converters" Browse="Required All"/> to your application's .rd.xml file. See also this discussion.

We strive to provide an extensive support for the various .NET runtimes and versions. If you still encounter an issue with the SDK on some platform, please open a GitHub issue or contact support.

Need help?

https://configcat.com/support

Contributing

Contributions are welcome. For more info please read the Contribution Guideline.

About ConfigCat