.NET / C# SDK Usage

DevCycleUser Object

The user object is required for all methods. The only required field in the user object is userId

See the DevCycleUser class in .NET DevCycleUser model doc for all accepted fields.

DevCycleUser user = new DevCycleUser("a_unique_id");

Get and use Variable by key

This method will fetch a specific variable value by key for a given user. It will return the variable value from the server unless an error occurs or the server has no response. In that case it will return a variable value with the value set to whatever was passed in as the defaultValue parameter.

bool result = await client.VariableValue(user, "your-variable-key", true);

The default value can be of type String, Boolean, Number, or Object.

If you would like to get the full Variable object you can use Variable() instead. This contains properties such as: Key, Value, Type, DefaultValue, IsDefaulted.

Getting All Variables

To get values from your Variables, the Value field inside the variable object can be accessed.

This method will fetch all variables for a given user and return as Dictionary<string, ReadOnlyVariable<object>>;

Dictionary<string, ReadOnlyVariable<object>> result = await client.AllVariables(user);

caution

This method is intended to be used for debugging and analytics purposes, not as a method for retrieving the value of Variables to change code behaviour. For that purpose, we strongly recommend using the individual variable access method described in Get and use Variable by key Using this method instead will result in no evaluation events being tracked for individual variables, and will not allow the use of other DevCycle features such as Code Usage detection

Getting All Features

This method will fetch all features for a given user and return them as Dictionary<String, Feature>

Dictionary<string, Feature> result = await client.AllFeatures(user);

Track Event

To track a custom event for a user, pass in the user and event object.

In the Local Bucketing SDK - this queues the event to be batched out later, while in the Cloud Bucketing SDK, this is sent right away.

var event = new DevCycleEvent("test event", "test target");

DevCycleResponse result = await client.Track(user, event);

EdgeDB - Cloud Only

EdgeDB allows you to save user data to our EdgeDB storage so that you don't have to pass in all the user data every time you identify a user. Read more about EdgeDB.

To get started, contact us at [email protected] to enable EdgeDB for your project.

Once you have EdgeDB enabled in your project, pass in the enableEdgeDB option to turn on EdgeDB mode for the SDK:

DevCycleCloudOptions options = new DevCycleCloudOptions(true);
DevCycleCloudClient devcycleClient = new DevCycleCloudClientBuilder()
                                        .SetSDKKey("<DEVCYCLE_SERVER_SDK_KEY>")
                                        .SetOptions(options)
                                        .Build();
var edgeDBUser = new DevCycleUser("test_user") { Email = "[email protected]" };

This will send a request to our EdgeDB API to save the custom data (in this case, email) under the user test_user.

In the example, email is associated to the user test_user. In your next identify call for the same userId, you may omit any of the data you've sent already as it will be pulled from the EdgeDB storage when segmenting to experiments and features.

SDK Proxy

To further enable various deployment configurations - we provide a background process that can be used to proxy requests to the DevCycle API. This is useful when you have a more unique deployment style, or the SDK is not able to make requests to the DevCycle API directly. The installation and setup process for the proxy can be found here: https://github.com/DevCycleHQ/sdk-proxy#readme.

See the SDK Proxy section for more information.

Enabling Beta Realtime Updates

warning

This feature is in beta, and may not function as expected. Please ensure that you have the latest version of the SDK.

This functionality will reduce the number of polling requests that are made to the DevCycle Config CDN, and instead will use a long-lived HTTP connection (Server Sent Events) to receive updates when there is a new config available. This reduces outbound network traffic, as well as optimizes the SDK for efficiency.

To enable Beta Realtime Updates, pass in the enableBetaRealtimeUpdates option to the SDK initialization:

    client = new DevCycleLocalClientBuilder()
        .SetSDKKey("<DEVCYCLE_SERVER_SDK_KEY>")
        .SetOptions(new DevCycleLocalOptions(enableBetaRealtimeUpdates: true))
        .SetLogger(LoggerFactory.Create(builder => builder.AddConsole()))
        .Build();