Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/home/feature-management/edgedb/edge-flags.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ For specific documentation on how to use Edge Flags with each SDK
- [PHP SDK](/sdk/server-side-sdks/php/php-usage#edgedb)
- [Python SDK](/sdk/server-side-sdks/python/python-usage#edgedb)
- [Ruby SDK](/sdk/server-side-sdks/ruby#edgedb)
- [.NET SDK for Cloud Bucketing](/sdk/server-side-sdks/dotnet-cloud#edgedb)
- [.NET SDK for Cloud Bucketing](/sdk/server-side-sdks/dotnet-cloud/dotnet-cloud-usage#edgedb)

:::info
**Data stored in EdgeDB is only used for user segmenting (targeting rules), so EdgeDB won’t return data to the SDK.**
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/example-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Welcome to the Samples & Example Apps page, which showcases example applications

| Sample SDK App | SDK Reference Documentation |
| ------------------------------------------------------------------------- |--------------------------------------------------------------------------------|
| [.NET (Cloud Bucketing)](https://github.com/DevCycleHQ/dotnet-server-sdk) | [.NET (Cloud Bucketing) Reference Docs](/sdk/server-side-sdks/dotnet-cloud.md) |
| [.NET (Cloud Bucketing)](https://github.com/DevCycleHQ/dotnet-server-sdk) | [.NET (Cloud Bucketing) Reference Docs](/sdk/server-side-sdks/dotnet-cloud/dotnet-cloud.md) |
| [.NET (Local Bucketing)](https://github.com/DevCycleHQ/dotnet-server-sdk) | [.NET (Local Bucketing) Reference Docs](/sdk/server-side-sdks/dotnet-local.md) |
| [Android](https://github.com/DevCycleHQ/android-client-sdk) | [Android Reference Docs](/sdk/client-side-sdks/android.md) |
| [Flutter](https://github.com/devcyclehq/flutter-client-sdk) | [Flutter Reference Docs](/sdk/client-side-sdks/flutter.md) |
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/features/all-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The DevCycle React SDK is built upon the JavaScript SDK. For more details, view

### [• PHP SDK](/sdk/server-side-sdks/php/php-usage#getting-all-features)

### [• .NET / C# Cloud SDK](/sdk/server-side-sdks/dotnet-cloud#getting-all-features)
### [• .NET / C# Cloud SDK](/sdk/server-side-sdks/dotnet-cloud/dotnet-cloud-usage#getting-all-features)

### [• .NET / C# Local SDK](/sdk/server-side-sdks/dotnet-local#getting-all-features)

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/features/all-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The DevCycle React SDK is built upon the JavaScript SDK. For more details, view

### [• PHP SDK](/sdk/server-side-sdks/php/php-usage#get-all-variables)

### [• .NET / C# Cloud SDK](/sdk/server-side-sdks/dotnet-cloud#getting-all-variables)
### [• .NET / C# Cloud SDK](/sdk/server-side-sdks/dotnet-cloud/dotnet-cloud-usage#getting-all-variables)

### [• .NET / C# Local SDK](/sdk/server-side-sdks/dotnet-local#getting-all-variables)

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/features/evaluating.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If there is an error reaching DevCycle, if the requested variable does not exist

### [• C# / .NET Local SDK](/sdk/server-side-sdks/dotnet-local#get-and-use-variable-by-key)

### [• C# / .NET Cloud SDK](/sdk/server-side-sdks/dotnet-cloud#get-and-use-variable-by-key)
### [• C# / .NET Cloud SDK](/sdk/server-side-sdks/dotnet-cloud/dotnet-cloud-usage#get-and-use-variable-by-key)

### [• Go SDK](/sdk/server-side-sdks/go#get-and-use-variable-by-key)

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/features/identify.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ As well, unlike the Client-Side SDKs, because Server-Side SDKs poll for project

### [• C# / .NET Local SDK](/sdk/server-side-sdks/dotnet-local#user-object)

### [• C# / .NET Cloud SDK](/sdk/server-side-sdks/dotnet-cloud#user-object)
### [• C# / .NET Cloud SDK](/sdk/server-side-sdks/dotnet-cloud/dotnet-cloud-usage#user-object)

### [• Go SDK](/sdk/server-side-sdks/go#user-object)

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/features/initialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ If a variable is first read from the cache and has a listener for [realtime upda

### [• C# / .NET Local SDK](/sdk/server-side-sdks/dotnet-local#installation)

### [• C# / .NET Cloud SDK](/sdk/server-side-sdks/dotnet-cloud#installation)
### [• C# / .NET Cloud SDK](/sdk/server-side-sdks/dotnet-cloud/dotnet-cloud-gettingstarted)

### [• Go SDK](/sdk/server-side-sdks/go#installation)

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/features/track.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The Track function in the DevCycle SDKs allows you to send up custom events whic

### [• C# / .NET Local SDK](/sdk/server-side-sdks/dotnet-local#track-event)

### [• C# / .NET Cloud SDK](/sdk/server-side-sdks/dotnet-cloud#track-event)
### [• C# / .NET Cloud SDK](/sdk/server-side-sdks/dotnet-cloud/dotnet-cloud-usage#track-event)

### [• Go SDK](/sdk/server-side-sdks/go#tracking-user-event)

Expand Down
2 changes: 2 additions & 0 deletions docs/sdk/server-side-sdks/dotnet-cloud/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
position: 8
collapsed: true
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: .NET / C# SDK Cloud Getting Started
sidebar_label: Getting Started
sidebar_position: 2
---

[![Nuget](https://badgen.net/nuget/v/DevCycle.SDK.Server.Cloud)](https://www.nuget.org/packages/DevCycle.SDK.Server.Cloud/)
[![GitHub](https://img.shields.io/github/stars/devcyclehq/dotnet-server-sdk.svg?style=social&label=Star&maxAge=2592000)](https://github.com/DevCycleHQ/dotnet-server-sdk)

To start, initialize a client using the API key.

```csharp
using System;
using System.Diagnostics;
using DevCycle.SDK.Server.Cloud.Api;


namespace Example
{
public class Example
{
public void main()
{
// using ensures REST Client resources are correctly disposed once no longer required.
using DVCCloudClient dvcClient = new DVCCloudClientBuilder()
.SetSDKKey("<DVC_SERVER_SDK_KEY>")
.Build();
}
}
}
```
31 changes: 31 additions & 0 deletions docs/sdk/server-side-sdks/dotnet-cloud/dotnet-cloud-install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: .NET / C# Cloud SDK Installation
sidebar_label: Installation
sidebar_position: 1
---

[![Nuget](https://badgen.net/nuget/v/DevCycle.SDK.Server.Cloud)](https://www.nuget.org/packages/DevCycle.SDK.Server.Cloud/)
[![GitHub](https://img.shields.io/github/stars/devcyclehq/dotnet-server-sdk.svg?style=social&label=Star&maxAge=2592000)](https://github.com/DevCycleHQ/dotnet-server-sdk)

## Requirements

### Frameworks supported
- .NET Core >=1.0
- .NET Framework >=4.6
- Mono/Xamarin >=vNext
- UWP >=10.0

### Dependencies
- FubarCoder.RestSharp.Portable.Core >=4.0.8
- FubarCoder.RestSharp.Portable.HttpClient >=4.0.8
- JsonSubTypes >=1.8.0
- Newtonsoft.Json >=13.0.1

## Installation
Download the SDK from Nuget - https://www.nuget.org/packages/DevCycle.SDK.Server.Cloud/
and use the namespaces:

```csharp
using DevCycle.SDK.Server.Cloud.Api;
using DevCycle.SDK.Server.Common.Model;
```
Original file line number Diff line number Diff line change
@@ -1,69 +1,13 @@
---
title: .NET SDK for Cloud Bucketing
sidebar_position: 8
title: .NET / C# Cloud SDK Usage
sidebar_label: Usage
sidebar_position: 3
---

# DevCycle .NET / C# SDK

Welcome to the DevCycle .NET Server SDK, which interfaces with the [DevCycle Bucketing API](/bucketing-api/#tag/devcycle).
All requests, including user data are sent to DevCycle servers to ensure the User is bucketed correctly and will receive the correct variation.

The SDK is available as a package on Nuget. It is also open source and can be viewed on Github.

[![Nuget](https://badgen.net/nuget/v/DevCycle.SDK.Server.Cloud)](https://www.nuget.org/packages/DevCycle.SDK.Server.Cloud/)
[![GitHub](https://img.shields.io/github/stars/devcyclehq/dotnet-server-sdk.svg?style=social&label=Star&maxAge=2592000)](https://github.com/DevCycleHQ/dotnet-server-sdk)

## Requirements

### Frameworks supported
- .NET Core >=1.0
- .NET Framework >=4.6
- Mono/Xamarin >=vNext
- UWP >=10.0

### Dependencies
- FubarCoder.RestSharp.Portable.Core >=4.0.8
- FubarCoder.RestSharp.Portable.HttpClient >=4.0.8
- JsonSubTypes >=1.8.0
- Newtonsoft.Json >=13.0.1

## Installation
Download the SDK from Nuget - https://www.nuget.org/packages/DevCycle.SDK.Server.Cloud/
and use the namespaces:

```csharp
using DevCycle.SDK.Server.Cloud.Api;
using DevCycle.SDK.Server.Common.Model;
```

## Getting Started

To start, initialize a client using the API key.

```csharp
using System;
using System.Diagnostics;
using DevCycle.SDK.Server.Cloud.Api;


namespace Example
{
public class Example
{
public void main()
{
// using ensures REST Client resources are correctly disposed once no longer required.
using DVCCloudClient dvcClient = new DVCCloudClientBuilder()
.SetSDKKey("<DVC_SERVER_SDK_KEY>")
.Build();
}
}
}
```

## Usage

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

See the User class in [.NET User model doc](https://github.com/DevCycleHQ/dotnet-server-sdk/blob/main/docs/User.md) for all accepted fields.
Expand All @@ -72,7 +16,7 @@ See the User class in [.NET User model doc](https://github.com/DevCycleHQ/dotnet
User user = new User("a_user_id");
```

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

```csharp
Expand Down Expand Up @@ -107,7 +51,7 @@ namespace Example
}
```

### Get all Variables
## Getting All Variables

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

Expand Down Expand Up @@ -150,7 +94,7 @@ namespace Example
}
```

### Get and use Variable by key
## Get and use Variable by key

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

Expand Down Expand Up @@ -193,7 +137,7 @@ namespace Example
}
```

### Track Event
## Track Event
To POST custom event for a user, pass in the user and event object.

```csharp
Expand Down Expand Up @@ -234,15 +178,14 @@ namespace Example
}
```

### EdgeDB
## EdgeDB

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](/home/feature-management/edgedb/what-is-edgedb).

To get started, contact us at support@devcycle.com 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:

####
```csharp
DVCCloudOptions options = new DVCCloudOptions(true);
DVCCloudClient api = new DVCCloudClientBuilder()
Expand Down
39 changes: 39 additions & 0 deletions docs/sdk/server-side-sdks/dotnet-cloud/dotnet-cloud.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: .NET SDK for Cloud Bucketing
---

# DevCycle .NET / C# SDK

Welcome to the DevCycle .NET Server SDK, which interfaces with the [DevCycle Bucketing API](/bucketing-api/#tag/devcycle).
All requests, including user data are sent to DevCycle servers to ensure the User is bucketed correctly and will receive the correct variation.

The SDK is available as a package on Nuget. It is also open source and can be viewed on Github.

[![Nuget](https://badgen.net/nuget/v/DevCycle.SDK.Server.Cloud)](https://www.nuget.org/packages/DevCycle.SDK.Server.Cloud/)
[![GitHub](https://img.shields.io/github/stars/devcyclehq/dotnet-server-sdk.svg?style=social&label=Star&maxAge=2592000)](https://github.com/DevCycleHQ/dotnet-server-sdk)


## Getting Started

To start, initialize a client using the API key.

```csharp
using System;
using System.Diagnostics;
using DevCycle.SDK.Server.Cloud.Api;


namespace Example
{
public class Example
{
public void main()
{
// using ensures REST Client resources are correctly disposed once no longer required.
using DVCCloudClient dvcClient = new DVCCloudClientBuilder()
.SetSDKKey("<DVC_SERVER_SDK_KEY>")
.Build();
}
}
}
```