BulletTrain 2.0.1

<img width="100%" src="https://raw.githubusercontent.com/SolidStateGroup/bullet-train-frontend/master/hero.png"/>

Bullet Train SDK for .NET applications

Bullet Train allows you to manage feature flags and remote config across multiple projects, environments and organisations.

The SDK for .NET Core, .NET Framework, Mono, Xamarin and Universal Windows Platform applications for https://bullet-train.io/.

Getting Started

Quick Setup

The client library is available from NuGet and can be added to your project by many tools. You can find the package here https://www.nuget.org/packages/BulletTrain/

Usage

Retrieving feature flags for your project

For full documentation visit https://docs.bullet-train.io

Sign Up and create account at https://bullet-train.io/

In your application initialise the Bullet Train client once with your environment API key and API URL.

BulletTrainConfiguration configuration = new BulletTrainConfiguration()
{
    ApiUrl = "https://api.bullet-train.io/api/v1/",
    EnvironmentKey = "env-key-goes-here"
};

BulletTrainClient bulletClient = new BulletTrainClient(configuration);

You can then use the instance static variable on BulletTrainClient anywhere within your app.

To check if a feature flag exists and is enabled:

bool featureEnabled = await BulletTrainClient.instance.HasFeatureFlag("my_test_feature");
if (featureEnabled) {
    // run the code to execute enabled feature
} else {
    // run the code if feature switched off
}

To get a remote config feature value:

string myRemoteConfig = await BulletTrainClient.instance.GetFeatureValue("my_test_feature");
if (myRemoteConfig != null) {
    // run the code to use remote config value
} else {
    // run the code without remote config
}

Identifying users

Identifying users allows you to target specific users from the Bullet Train dashboard.

To check if a feature exists and is enabled for a specific user:

bool featureEnabled = await BulletTrainClient.instance.HasFeatureFlag("my_test_feature", "my_user_id");
if (featureEnabled) {
    // run the code to execute enabled feature for given user
} else {
    // run the code when feature switched off
}

To get a remote config value for specific user:

string myRemoteConfig = await BulletTrainClient.instance.GetFeatureValue("my_test_feature", "my_user_id");
if (myRemoteConfig != null) {
    // run the code to use remote config value
} else {
    // run the code without remote config
}

To get user traits:

List<Trait> userTraits = await BulletTrainClient.instance.GetTraits("my_user_id")
if (userTraits != null && userTraits) {
    // run the code to use user traits
} else {
    // run the code without user traits
}

To get a specific user trait:

string userTrait = await BulletTrainClient.instance.GetTrait("my_user_id", "cookies_key");
bool userTrait = await BulletTrainClient.instance.GetBoolTrait("my_user_id", "cookies_key");
int userTrait = await BulletTrainClient.instance.GetIntegerTrait("my_user_id", "cookies_key");

To get filtered user traits:

List<Trait> userTraits = await BulletTrainClient.instance.GetTraits("my_user_id", new List<string> { "specific_key", /* rest of elements */ });
if (userTraits != null) {
    // run the code to use user traits
} else {
    // run the code without user traits
}

To set or update a user trait:

Trait userTrait = await BulletTrainClient.instance.SetTrait("my_user_id", "my_user_trait", "blue");
Trait userTrait = await BulletTrainClient.instance.SetTrait("my_user_id", "my_user_number_trait", 4);
Trait userTrait = await BulletTrainClient.instance.SetTrait("my_user_id", "my_user_bool_trait", true);

To increment a numeric user trait:

Trait userTrait = await BulletTrainClient.instance.IncrementTrait("my_user_id", "my_user_number_trait", 1);

To retrieve a user identity (both features and traits):

Identity userIdentity = await BulletTrainClient.instance.GetUserIdentity("my_user_id");
if (userIdentity != null) {
  // Run the code to use user identity i.e. userIdentity.flags or userIdentity.traits
}

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Getting Help

If you encounter a bug or feature request we would like to hear about it. Before you submit an issue please search existing issues in order to prevent duplicates.

Get in touch

If you have any questions about our projects you can email <a href="mailto:projects@solidstategroup.com">projects@solidstategroup.com</a>.