Microsoft.Orleans.Serialization.NewtonsoftJson 9.2.0-preview2

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. .NET Standard 2.1 This package targets .NET Standard 2.1. The package is compatible with this framework or higher.
This is a prerelease version of Microsoft.Orleans.Serialization.NewtonsoftJson.
There is a newer prerelease version of this package available.
See the version list below for details. 
dotnet add package Microsoft.Orleans.Serialization.NewtonsoftJson --version 9.2.0-preview2
                    


                    

                
NuGet\Install-Package Microsoft.Orleans.Serialization.NewtonsoftJson -Version 9.2.0-preview2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Microsoft.Orleans.Serialization.NewtonsoftJson" Version="9.2.0-preview2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Microsoft.Orleans.Serialization.NewtonsoftJson" Version="9.2.0-preview2" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Microsoft.Orleans.Serialization.NewtonsoftJson" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Microsoft.Orleans.Serialization.NewtonsoftJson --version 9.2.0-preview2
                    


                    

                
#r "nuget: Microsoft.Orleans.Serialization.NewtonsoftJson, 9.2.0-preview2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#addin nuget:?package=Microsoft.Orleans.Serialization.NewtonsoftJson&version=9.2.0-preview2&prerelease
                    


                            Install Microsoft.Orleans.Serialization.NewtonsoftJson as a Cake Addin
                        

                    

                
#tool nuget:?package=Microsoft.Orleans.Serialization.NewtonsoftJson&version=9.2.0-preview2&prerelease
                    


                            Install Microsoft.Orleans.Serialization.NewtonsoftJson as a Cake Tool

Microsoft Orleans Serialization for Newtonsoft.Json

Introduction

Microsoft Orleans Serialization for Newtonsoft.Json provides JSON serialization support for Microsoft Orleans using the popular Newtonsoft.Json library. This allows you to use the comprehensive JSON features of Newtonsoft.Json within your Orleans application.

Getting Started

To use this package, install it via NuGet:

dotnet add package Microsoft.Orleans.Serialization.NewtonsoftJson

Example - Configuring Newtonsoft.Json Serialization

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Orleans.Hosting;
using Orleans.Serialization;

var builder = Host.CreateApplicationBuilder(args)
    .UseOrleans(siloBuilder =>
    {
        siloBuilder
            .UseLocalhostClustering()
            // Configure Newtonsoft.Json as a serializer
            .AddSerializer(serializerBuilder => serializerBuilder.AddNewtonsoftJsonSerializer(type => type.Namespace.StartsWith("ExampleGrains")));
    });

// Run the host
await builder.RunAsync();

Example - Using Newtonsoft.Json with a Custom Type

using Orleans;
using Newtonsoft.Json;
namespace ExampleGrains;

// Define a class with Newtonsoft.Json attributes
public class MyJsonClass
{
    [JsonProperty("full_name")]
    public string Name { get; set; }
    
    [JsonProperty("age")]
    public int Age { get; set; }
    
    [JsonProperty("tags")]
    public List<string> Tags { get; set; }
    
    [JsonIgnore]
    public string SecretData { get; set; }
}

// You can use it directly in your grain interfaces and implementation
public interface IMyGrain : IGrainWithStringKey
{
    Task<MyJsonClass> GetData();
    Task SetData(MyJsonClass data);
}

public class MyGrain : Grain, IMyGrain
{
    private MyJsonClass _data;

    public Task<MyJsonClass> GetData()
    {
        return Task.FromResult(_data);
    }

    public Task SetData(MyJsonClass data)
    {
        _data = data;
        return Task.CompletedTask;
    }
}

Documentation

For more comprehensive documentation, please refer to:

Feedback & Contributing

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Microsoft.Orleans.Serialization.NewtonsoftJson:

Package Downloads
Cszy.Orleans

Package Description

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Microsoft.Orleans.Serialization.NewtonsoftJson:

Repository Stars
OrleansContrib/Orleankka
Functional API for Microsoft Orleans http://orleanscontrib.github.io/Orleankka
Version Downloads Last updated
9.2.0-preview3 266 6/10/2025
9.2.0-preview2 130 6/4/2025
9.2.0-preview1 118 4/4/2025
9.1.2 22,788 2/13/2025
9.0.1 16,878 11/23/2024
9.0.0 1,596 11/14/2024
8.2.0 88,257 7/12/2024
8.2.0-preview1 160 5/22/2024
8.1.0 30,201 4/17/2024
8.1.0-preview3 523 3/11/2024
8.1.0-preview2 119 2/23/2024
8.1.0-preview1 122 2/13/2024
8.0.0 20,214 1/5/2024
8.0.0-rc2 168 12/20/2023
8.0.0-rc1 208 12/4/2023
7.2.7 3,823 10/15/2024
7.2.6 15,145 3/9/2024
7.2.5 5,260 2/22/2024
7.2.4 20,727 12/2/2023
7.2.3 13,766 11/3/2023
7.2.2 7,697 10/16/2023
7.2.1 32,290 7/11/2023
7.2.0 784 7/7/2023
7.1.2 65,666 4/19/2023
7.1.1 3,395 3/23/2023
7.1.0 10,826 2/1/2023
7.0.0 8,373 11/8/2022
7.0.0-rc2 207 10/19/2022
4.0.0-preview2 352 8/4/2022
4.0.0-preview1 490 2/10/2022