JsonMediaTypeFormatter Class

 

Represents the MediaTypeFormatter class to handle JSON.

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

Inheritance Hierarchy

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

Syntax

public class JsonMediaTypeFormatter : BaseJsonMediaTypeFormatter
public ref class JsonMediaTypeFormatter : BaseJsonMediaTypeFormatter
type JsonMediaTypeFormatter = 
    class
        inherit BaseJsonMediaTypeFormatter
    end
Public Class JsonMediaTypeFormatter
    Inherits BaseJsonMediaTypeFormatter

Constructors

Name Description
System_CAPS_pubmethod JsonMediaTypeFormatter()

Initializes a new instance of the JsonMediaTypeFormatter class.

System_CAPS_protmethod JsonMediaTypeFormatter(JsonMediaTypeFormatter)

Initializes a new instance of the JsonMediaTypeFormatter class.

Properties

Name Description
System_CAPS_pubpropertySystem_CAPS_static DefaultMediaType

Gets the default media type for JSON, namely "application/json".

System_CAPS_pubproperty Indent

Gets or sets a value indicating whether to indent elements when writing data.

System_CAPS_pubproperty MaxDepth

Gets or sets the maximum depth allowed by this formatter.(Overrides BaseJsonMediaTypeFormatter.MaxDepth.)

System_CAPS_pubproperty MediaTypeMappings

Gets the mutable collection of MediaTypeMapping objects that match HTTP requests to media types.(Inherited from MediaTypeFormatter.)

System_CAPS_pubproperty RequiredMemberSelector

Gets or sets the IRequiredMemberSelector instance used to determine required members.(Inherited from MediaTypeFormatter.)

System_CAPS_pubproperty SerializerSettings

Gets or sets the JsonSerializerSettings used to configure the JsonSerializer.(Inherited from BaseJsonMediaTypeFormatter.)

System_CAPS_pubproperty SupportedEncodings

Gets the mutable collection of character encodings supported bythis MediaTypeFormatter.(Inherited from MediaTypeFormatter.)

System_CAPS_pubproperty SupportedMediaTypes

Gets the mutable collection of media types supported bythis MediaTypeFormatter.(Inherited from MediaTypeFormatter.)

System_CAPS_pubproperty UseDataContractJsonSerializer

Gets or sets a value indicating whether to use DataContractJsonSerializer by default.

Methods

Name Description
System_CAPS_pubmethod CanReadType(Type)

Determines whether this JsonMediaTypeFormatter can read objects of the specified type.(Overrides BaseJsonMediaTypeFormatter.CanReadType(Type).)

System_CAPS_pubmethod CanWriteType(Type)

Determines whether this JsonMediaTypeFormatter can write objects of the specified type.(Overrides BaseJsonMediaTypeFormatter.CanWriteType(Type).)

System_CAPS_pubmethod CreateDataContractSerializer(Type)

Called during deserialization to get the DataContractJsonSerializer.

System_CAPS_pubmethod CreateDefaultSerializerSettings()

Creates a JsonSerializerSettings instance with the default settings used by the BaseJsonMediaTypeFormatter.(Inherited from BaseJsonMediaTypeFormatter.)

System_CAPS_pubmethod CreateJsonReader(Type, Stream, Encoding)

Called during deserialization to get the JsonReader.(Overrides BaseJsonMediaTypeFormatter.CreateJsonReader(Type, Stream, Encoding).)

System_CAPS_pubmethod CreateJsonSerializer()

Called during serialization and deserialization to get the JsonSerializer.(Inherited from BaseJsonMediaTypeFormatter.)

System_CAPS_pubmethod CreateJsonWriter(Type, Stream, Encoding)

Called during serialization to get the JsonWriter.(Overrides BaseJsonMediaTypeFormatter.CreateJsonWriter(Type, Stream, Encoding).)

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetPerRequestFormatterInstance(Type, HttpRequestMessage, MediaTypeHeaderValue)

Returns a specialized instance of the MediaTypeFormatter that can format a response for the given parameters.(Inherited from MediaTypeFormatter.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod ReadFromStream(Type, Stream, Encoding, IFormatterLogger)

Called during deserialization to read an object of the specified type from the specified stream.(Overrides BaseJsonMediaTypeFormatter.ReadFromStream(Type, Stream, Encoding, IFormatterLogger).)

System_CAPS_pubmethod ReadFromStreamAsync(Type, Stream, HttpContent, IFormatterLogger)

Called during deserialization to read an object of the specified type from the specified stream.(Inherited from BaseJsonMediaTypeFormatter.)

System_CAPS_pubmethod ReadFromStreamAsync(Type, Stream, HttpContent, IFormatterLogger, CancellationToken)

Asynchronously deserializes an object of the specified type.(Inherited from MediaTypeFormatter.)

System_CAPS_pubmethod SelectCharacterEncoding(HttpContentHeaders)

Determines the best character encoding for reading or writing an HTTP entity body, given a set of content headers.(Inherited from MediaTypeFormatter.)

System_CAPS_pubmethod SetDefaultContentHeaders(Type, HttpContentHeaders, MediaTypeHeaderValue)

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.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

System_CAPS_pubmethod WriteToStream(Type, Object, Stream, Encoding)

Called during serialization to write an object of the specified type to the specified stream.(Overrides BaseJsonMediaTypeFormatter.WriteToStream(Type, Object, Stream, Encoding).)

System_CAPS_pubmethod WriteToStreamAsync(Type, Object, Stream, HttpContent, TransportContext)

Asynchronously writes an object of the specified type.(Inherited from MediaTypeFormatter.)

System_CAPS_pubmethod WriteToStreamAsync(Type, Object, Stream, HttpContent, TransportContext, CancellationToken)

Called during serialization to write an object of the specified type to the specified stream.(Overrides BaseJsonMediaTypeFormatter.WriteToStreamAsync(Type, Object, Stream, HttpContent, TransportContext, CancellationToken).)

Extension Methods

Name Description
System_CAPS_pubmethod AddQueryStringMapping(String, String, MediaTypeHeaderValue)

Overloaded. (Defined by MediaTypeFormatterExtensions.)

System_CAPS_pubmethod AddQueryStringMapping(String, String, String)

Overloaded. (Defined by MediaTypeFormatterExtensions.)

System_CAPS_pubmethod AddRequestHeaderMapping(String, String, StringComparison, Boolean, MediaTypeHeaderValue)

Overloaded. (Defined by MediaTypeFormatterExtensions.)

System_CAPS_pubmethod AddRequestHeaderMapping(String, String, StringComparison, Boolean, String)

Overloaded. (Defined by MediaTypeFormatterExtensions.)

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

System.Net.Http.Formatting Namespace

Return to top