Early Preview

This is currently very much a preview. Please feel free to try things out, but don't be upset if anything is not yet working. Feedback is welcome over on our GitHub Dicussions page.

Newtonsoft.Json

Json.NET is a popular high-performance JSON framework for .NET

Author	James Newton-King
Version	10.0.1
Tags	json

Public Types

Newtonsoft.Json

enum ConstructorHandling

Specifies how constructors are used when initializing objects during deserialization by the <see cref="T:Newtonsoft.Json.JsonSerializer" /> .

enum DateFormatHandling

Specifies how dates are formatted when writing JSON text.

enum DateParseHandling

Specifies how date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c> , are parsed when reading JSON text.

enum DateTimeZoneHandling

Specifies how to treat the time value when converting between string and <see cref="T:System.DateTime" /> .

enum DefaultValueHandling

Specifies default value handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer" /> .

enum FloatFormatHandling

Specifies float format handling options when writing special floating point numbers, e.g. <see cref="F:System.Double.NaN" /> , <see cref="F:System.Double.PositiveInfinity" /> and <see cref="F:System.Double.NegativeInfinity" /> with <see cref="T:Newtonsoft.Json.JsonWriter" /> .

enum FloatParseHandling

Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text.

enum Formatting

Specifies formatting options for the <see cref="T:Newtonsoft.Json.JsonTextWriter" /> .

interface IArrayPool<T>

Provides an interface for using pooled arrays.

interface IJsonLineInfo

Provides an interface to enable a class to return line and position information.

class JsonArrayAttribute

Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer" /> how to serialize the collection.

class JsonConstructorAttribute

Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer" /> to use the specified constructor when deserializing that object.

class JsonContainerAttribute

Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer" /> how to serialize the object.

class JsonConvert

Provides methods for converting between .NET types and JSON types.

class JsonConverter

Converts an object to and from JSON.

class JsonConverterAttribute

Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer" /> to use the specified <see cref="T:Newtonsoft.Json.JsonConverter" /> when serializing the member or class.

class JsonConverterCollection

Represents a collection of <see cref="T:Newtonsoft.Json.JsonConverter" /> .

class JsonDictionaryAttribute

Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer" /> how to serialize the collection.

class JsonException

The exception thrown when an error occurs during JSON serialization or deserialization.

class JsonExtensionDataAttribute

Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer" /> to deserialize properties with no matching class member into the specified collection and write values during serialization.

class JsonIgnoreAttribute

Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer" /> not to serialize the public field or public read/write property value.

class JsonObjectAttribute

Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer" /> how to serialize the object.

class JsonPropertyAttribute

Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer" /> to always serialize the member with the specified name.

class JsonReader

Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data.

class JsonReaderException

The exception thrown when an error occurs while reading JSON text.

class JsonRequiredAttribute

Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer" /> to always serialize the member, and to require that the member has a value.

class JsonSerializationException

The exception thrown when an error occurs during JSON serialization or deserialization.

class JsonSerializer

Serializes and deserializes objects into and from the JSON format. The <see cref="T:Newtonsoft.Json.JsonSerializer" /> enables you to control how objects are encoded into JSON.

class JsonSerializerSettings

Specifies the settings on a <see cref="T:Newtonsoft.Json.JsonSerializer" /> object.

class JsonTextReader

Represents a reader that provides fast, non-cached, forward-only access to JSON text data.

class JsonTextWriter

Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data.

enum JsonToken

Specifies the type of JSON token.

class JsonValidatingReader

<para> Represents a reader that provides <see cref="T:Newtonsoft.Json.Schema.JsonSchema" /> validation. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details. </note>

class JsonWriter

Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data.

class JsonWriterException

The exception thrown when an error occurs while writing JSON text.

enum MemberSerialization

Specifies the member serialization options for the <see cref="T:Newtonsoft.Json.JsonSerializer" /> .

enum MetadataPropertyHandling

Specifies metadata property handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer" /> .

enum MissingMemberHandling

Specifies missing member handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer" /> .

enum NullValueHandling

Specifies null value handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer" /> .

enum ObjectCreationHandling

Specifies how object creation is handled by the <see cref="T:Newtonsoft.Json.JsonSerializer" /> .

enum PreserveReferencesHandling

Specifies reference handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer" /> . Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement <see cref="T:System.Runtime.Serialization.ISerializable" /> .

enum ReferenceLoopHandling

Specifies reference loop handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer" /> .

enum Required

Indicating whether a property is required.

class SerializationBinder

Allows users to control class loading and mandate what class to load.

enum StringEscapeHandling

Specifies how strings are escaped when writing JSON text.

enum TraceLevel

Specifies what messages to output for the <see cref="T:Newtonsoft.Json.Serialization.ITraceWriter" /> class.

enum TypeNameAssemblyFormatHandling

Indicates the method that will be used during deserialization for locating and loading assemblies.

enum TypeNameHandling

Specifies type name handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer" /> .

enum WriteState

Specifies the state of the <see cref="T:Newtonsoft.Json.JsonWriter" /> .

Newtonsoft.Json.Bson

class BsonObjectId

Represents a BSON Oid (object id).

class BsonReader

Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data.

class BsonWriter

Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data.

Newtonsoft.Json.Converters

class BinaryConverter

Converts a binary value to and from a base 64 string value.

class BsonObjectIdConverter

Converts a <see cref="T:Newtonsoft.Json.Bson.BsonObjectId" /> to and from JSON and BSON.

class CustomCreationConverter<T>

Creates a custom object.

class DateTimeConverterBase

Provides a base class for converting a <see cref="T:System.DateTime" /> to and from JSON.

class DiscriminatedUnionConverter

Converts a F# discriminated union type to and from JSON.

class ExpandoObjectConverter

Converts an <see cref="T:System.Dynamic.ExpandoObject" /> to and from JSON.

class IsoDateTimeConverter

Converts a <see cref="T:System.DateTime" /> to and from the ISO 8601 date format (e.g. <c>"2008-04-12T12:53Z"</c> ).

class JavaScriptDateTimeConverter

Converts a <see cref="T:System.DateTime" /> to and from a JavaScript <c>Date</c> constructor (e.g. <c>new Date(52231943)</c> ).

class KeyValuePairConverter

Converts a <see cref="T:System.Collections.Generic.KeyValuePair`2" /> to and from JSON.

class RegexConverter

Converts a <see cref="T:System.Text.RegularExpressions.Regex" /> to and from JSON and BSON.

class StringEnumConverter

Converts an <see cref="T:System.Enum" /> to and from its name string value.

class VersionConverter

Converts a <see cref="T:System.Version" /> to and from a string (e.g. <c>"1.2.3.4"</c> ).

class XmlNodeConverter

Converts XML to and from JSON.

Newtonsoft.Json.Linq

enum CommentHandling

Specifies how JSON comments are handled when loading JSON.

class Extensions

Contains the LINQ to JSON extension methods.

interface IJEnumerable<T>

Represents a collection of <see cref="T:Newtonsoft.Json.Linq.JToken" /> objects.

class JArray

Represents a JSON array.

class JConstructor

Represents a JSON constructor.

class JContainer

Represents a token that can contain other tokens.

struct JEnumerable<T>

Represents a collection of <see cref="T:Newtonsoft.Json.Linq.JToken" /> objects.

class JObject

Represents a JSON object.

class JProperty

Represents a JSON property.

class JRaw

Represents a raw JSON string.

class JsonLoadSettings

Specifies the settings used when loading JSON.

class JsonMergeSettings

Specifies the settings used when merging JSON.

class JToken

Represents an abstract JSON token.

class JTokenEqualityComparer

Compares tokens to determine whether they are equal.

class JTokenReader

Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data.

enum JTokenType

Specifies the type of token.

class JTokenWriter

Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data.

class JValue

Represents a value in JSON (string, integer, date, etc).

enum LineInfoHandling

Specifies how line information is handled when loading JSON.

enum MergeArrayHandling

Specifies how JSON arrays are merged together.

enum MergeNullValueHandling

Specifies how null value properties are merged.

Newtonsoft.Json.Schema

class Extensions

<para> Contains the JSON schema extension methods. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details. </note>

class JsonSchema

<para> An in-memory representation of a JSON Schema. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details. </note>

class JsonSchemaException

<para> Returns detailed information about the schema exception. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details. </note>

class JsonSchemaGenerator

<para> Generates a <see cref="T:Newtonsoft.Json.Schema.JsonSchema" /> from a specified <see cref="T:System.Type" />. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details. </note>

class JsonSchemaResolver

<para> Resolves <see cref="T:Newtonsoft.Json.Schema.JsonSchema" /> from an id. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details. </note>

enum JsonSchemaType

<para> The value types allowed by the <see cref="T:Newtonsoft.Json.Schema.JsonSchema" />. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details. </note>

enum UndefinedSchemaIdHandling

<para> Specifies undefined schema Id handling options for the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaGenerator" />. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details. </note>

class ValidationEventArgs

<para> Returns detailed information related to the <see cref="T:Newtonsoft.Json.Schema.ValidationEventHandler" />. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details. </note>

class ValidationEventHandler

<para> Represents the callback method that will handle JSON schema validation events and the <see cref="T:Newtonsoft.Json.Schema.ValidationEventArgs" />. </para> <note type="caution"> JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details. </note>

Newtonsoft.Json.Serialization

class CamelCaseNamingStrategy

A camel case naming strategy.

class CamelCasePropertyNamesContractResolver

Resolves member mappings for a type, camel casing property names.

class DefaultContractResolver

Used by <see cref="T:Newtonsoft.Json.JsonSerializer" /> to resolve a <see cref="T:Newtonsoft.Json.Serialization.JsonContract" /> for a given <see cref="T:System.Type" /> .

class DefaultNamingStrategy

The default naming strategy. Property names and dictionary keys are unchanged.

class DefaultSerializationBinder

The default serialization binder used when resolving and loading classes from type names.

class ErrorContext

Provides information surrounding an error.

class ErrorEventArgs

Provides data for the Error event.

class ExpressionValueProvider

Get and set values for a <see cref="T:System.Reflection.MemberInfo" /> using dynamic methods.

class ExtensionDataGetter

Gets extension data for an object during serialization.

class ExtensionDataSetter

Sets extension data for an object during deserialization.

interface IAttributeProvider

Provides methods to get attributes.

interface IContractResolver

Used by <see cref="T:Newtonsoft.Json.JsonSerializer" /> to resolve a <see cref="T:Newtonsoft.Json.Serialization.JsonContract" /> for a given <see cref="T:System.Type" /> .

interface IReferenceResolver

Used to resolve references when serializing and deserializing JSON by the <see cref="T:Newtonsoft.Json.JsonSerializer" /> .

interface ISerializationBinder

Allows users to control class loading and mandate what class to load.

interface ITraceWriter

Represents a trace writer.

interface IValueProvider

Provides methods to get and set values.

class JsonArrayContract