JsonMediaTypeFormatter Class

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
Public method JsonMediaTypeFormatter Initializes a new instance of the JsonMediaTypeFormatter class.

Top

Properties

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

Top

Methods

  Name Description
Public method CanReadType Determines whether this JsonMediaTypeFormatter can read objects of the specified type. (Overrides MediaTypeFormatter.CanReadType(Type).)
Public method CanWriteType Determines whether this JsonMediaTypeFormatter can write objects of the specified type. (Overrides MediaTypeFormatter.CanWriteType(Type).)
Public method CreateDefaultSerializerSettings Creates a JsonSerializerSettings instance with the default settings used by the JsonMediaTypeFormatter.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetPerRequestFormatterInstance Returns a specialized instance of the MediaTypeFormatter that can format a response for the given parameters. (Inherited from MediaTypeFormatter.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method 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).)
Public method SelectCharacterEncoding Determines the best character encoding for reading or writing an HTTP entity body, given a set of content headers. (Inherited from MediaTypeFormatter.)
Public method 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.)
Public method ToString (Inherited from Object.)
Public method 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
Public Extension Method 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.)
Public Extension Method 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.)
Public Extension Method 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.)
Public Extension Method 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.)
Public Extension Method 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.)
Public Extension Method 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.

See Also

Reference

System.Net.Http.Formatting Namespace