Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas Device SDKs
/
.NET SDK

Install the .NET SDK

On this page

  • Prerequisites
  • Installation
  • Open the NuGet Package Manager
  • Add the Realm Package
  • Open the NuGet Package Manager
  • Add the Realm Package
  • Add the Realm Weaver to FodyWeavers.xml
  • Import the SDK

You can use the Atlas Device SDK for .NET to develop apps in C# .NET with several frameworks, including .NET MAUI, Xamarin, Avalonia UI, UWP, Unity, and others.

For more information about specific version support for .NET, .NET MAUI, UWP, and Xamarin, see Platform and Framework Compatibility - .NET SDK.

Note

Integrating the .NET SDK with Unity has different prerequisites and install steps than the ones below. Learn how to Integrate the SDK with Unity.

Prerequisites

Before getting started, ensure you have installed Visual Studio:

Installation

Tip

Atlas Device SDK and Realm

The SDK uses Realm Core database for device data persistence. When you install the .NET SDK, the package names reflect Realm naming.

Follow these steps to add the .NET SDK to your project.

Important

Install the SDK for all projects

If you have a multi-platform solution, be sure to install the SDK for all of the platform projects, even if the given project doesn't contain any SDK-specific code.

1

Open the NuGet Package Manager

In the Solution Explorer, right-click your solution and select Manage NuGet Packages... to open the NuGet Package management window.

Open the NuGet Package management window.
click to enlarge

Note

Adding the package at the Solution level allows you to add it to every project in one step.

2

Add the Realm Package

In the search bar, search for Realm. Select the result and click Add Package. If you are using Xamarin, you may be prompted to select which projects use the Realm package. Select all of the projects, and then click Ok.

1

Open the NuGet Package Manager

In the Solution Explorer, right-click your solution and select Manage NuGet Packages for Solution... to open the NuGet Package management window.

Open the NuGet Package management window.
click to enlarge
2

Add the Realm Package

In the search bar, search for Realm. Select the result and click Install. When prompted, select all projects and click Ok.

Search for Realm and add it to your project(s).
click to enlarge
3

Add the Realm Weaver to FodyWeavers.xml

Note

You can skip this step if you were not already using Fody in your project. Visual Studio will generate a properly-configured FodyWeavers.xml file for you when you first build.

If your project was already using Fody, you must manually add the Realm weaver to your FodyWeavers.xml file. When done, your FodyWeavers.xml file should look something like this:

<Weavers xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FodyWeavers.xsd">
  <Realm />
</Weavers>

Import the SDK

Add the following line to the top of your source files to use the SDK:

using Realms;

Back

.NET SDK

Next

Quick Start

On this page