JsonMediaTypeFormatter Class

Article
2012-12-19

Represents the MediaTypeFormatter class to handle JSON.

Inheritance Hierarchy

System.Object
System.Net.Http.Formatting.MediaTypeFormatter
System.Net.Http.Formatting.JsonMediaTypeFormatter

Namespace: System.Net.Http.Formatting
Assembly: System.Net.Http.Formatting (in System.Net.Http.Formatting.dll)

Syntax

'Declaration
Public Class JsonMediaTypeFormatter _
    Inherits MediaTypeFormatter
'Usage
Dim instance As JsonMediaTypeFormatter

public class JsonMediaTypeFormatter : MediaTypeFormatter

public ref class JsonMediaTypeFormatter : public MediaTypeFormatter

type JsonMediaTypeFormatter =  
    class
        inherit MediaTypeFormatter
    end

public class JsonMediaTypeFormatter extends MediaTypeFormatter

The JsonMediaTypeFormatter type exposes the following members.

Constructors

	Name	Description
	JsonMediaTypeFormatter	Initializes a new instance of the JsonMediaTypeFormatter class.

Top

Properties

	Name	Description
	DefaultMediaType	Gets the default media type for JSON, namely "application/json".
	Indent	Gets or sets a value indicating whether to indent elements when writing data.
	MaxDepth	Gets or sets the maximum depth allowed by this formatter.
	MediaTypeMappings	Gets the mutable collection of MediaTypeMapping objects that match HTTP requests to media types. (Inherited from MediaTypeFormatter.)
	RequiredMemberSelector	Gets or sets the IRequiredMemberSelector instance used to determine required members. (Inherited from MediaTypeFormatter.)
	SerializerSettings	Gets or sets the JsonSerializerSettings used to configure the JsonSerializer.
	SupportedEncodings	Gets the mutable collection of character encodings supported bythis MediaTypeFormatter. (Inherited from MediaTypeFormatter.)
	SupportedMediaTypes	Gets the mutable collection of media types supported bythis MediaTypeFormatter. (Inherited from MediaTypeFormatter.)
	UseDataContractJsonSerializer	Gets or sets a value indicating whether to use DataContractJsonSerializer by default.

Top

Methods

	Name	Description
	CanReadType	Determines whether this JsonMediaTypeFormatter can read objects of the specified type. (Overrides MediaTypeFormatter.CanReadType(Type).)
	CanWriteType	Determines whether this JsonMediaTypeFormatter can write objects of the specified type. (Overrides MediaTypeFormatter.CanWriteType(Type).)
	CreateDefaultSerializerSettings	Creates a JsonSerializerSettings instance with the default settings used by the JsonMediaTypeFormatter.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetPerRequestFormatterInstance	Returns a specialized instance of the MediaTypeFormatter that can format a response for the given parameters. (Inherited from MediaTypeFormatter.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	ReadFromStreamAsync	Reads an object of the specified type from the specified stream. This method is called during deserialization. (Overrides MediaTypeFormatter.ReadFromStreamAsync(Type, Stream, HttpContent, IFormatterLogger).)
	SelectCharacterEncoding	Determines the best character encoding for reading or writing an HTTP entity body, given a set of content headers. (Inherited from MediaTypeFormatter.)
	SetDefaultContentHeaders	Sets the default headers for content that will be formatted using this formatter. This method is called from the ObjectContent constructor. This implementation sets the Content-Type header to the value of mediaType if it is not null. If it is null it sets the Content-Type to the default media type of this formatter. If the Content-Type does not specify a charset it will set it using this formatters configured Encoding. (Inherited from MediaTypeFormatter.)
	ToString	(Inherited from Object.)
	WriteToStreamAsync	Writes an object of the specified type to the specified stream. This method is called during serialization. (Overrides MediaTypeFormatter.WriteToStreamAsync(Type, Object, Stream, HttpContent, TransportContext).)

Top

Extension Methods

	Name	Description
	AddQueryStringMapping(String, String, MediaTypeHeaderValue)	Overloaded. Updates the given set of formatter of MediaTypeMapping elements so that it associates the mediaType with Uris containing a specific query parameter and value. (Defined by MediaTypeFormatterExtensions.)
	AddQueryStringMapping(String, String, String)	Overloaded. Updates the given set of formatter of MediaTypeMapping elements so that it associates the mediaType with Uris containing a specific query parameter and value. (Defined by MediaTypeFormatterExtensions.)
	AddRequestHeaderMapping(String, String, StringComparison, Boolean, MediaTypeHeaderValue)	Overloaded. Updates the given set of formatter of MediaTypeMapping elements so that it associates the mediaType with a specific HTTP request header field with a specific value. (Defined by MediaTypeFormatterExtensions.)
	AddRequestHeaderMapping(String, String, StringComparison, Boolean, String)	Overloaded. Updates the given set of formatter of MediaTypeMapping elements so that it associates the mediaType with a specific HTTP request header field with a specific value. (Defined by MediaTypeFormatterExtensions.)
	AddUriPathExtensionMapping(String, MediaTypeHeaderValue)	Overloaded. Updates the given formatter's set of MediaTypeMapping elements so that it associates the mediaType with Uris ending with the given uriPathExtension. (Defined by MediaTypeFormatterExtensions.)
	AddUriPathExtensionMapping(String, String)	Overloaded. Updates the given formatter's set of MediaTypeMapping elements so that it associates the mediaType with Uris ending with the given uriPathExtension. (Defined by MediaTypeFormatterExtensions.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via