MediaTypeFormatter Class

Base class to handle serializing and deserializing strongly-typed objects using ObjectContent.

Inheritance Hierarchy

System.Object
  System.Net.Http.Formatting.MediaTypeFormatter
    System.Net.Http.Formatting.BufferedMediaTypeFormatter
    System.Net.Http.Formatting.FormUrlEncodedMediaTypeFormatter
    System.Net.Http.Formatting.JsonMediaTypeFormatter
    System.Net.Http.Formatting.XmlMediaTypeFormatter

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

Syntax

'Declaration
Public MustInherit Class MediaTypeFormatter
'Usage
Dim instance As MediaTypeFormatter
public abstract class MediaTypeFormatter
public ref class MediaTypeFormatter abstract
[<AbstractClassAttribute>]
type MediaTypeFormatter =  class end
public abstract class MediaTypeFormatter

The MediaTypeFormatter type exposes the following members.

Constructors

  Name Description
Protected method MediaTypeFormatter Initializes a new instance of the MediaTypeFormatter class.

Top

Properties

  Name Description
Public propertyStatic member MaxHttpCollectionKeys Gets or sets the maximum number of keys stored in a T: [System.Collections.Specialized.NameValueCollection].
Public property MediaTypeMappings Gets the mutable collection of MediaTypeMapping objects that match HTTP requests to media types.
Public property RequiredMemberSelector Gets or sets the IRequiredMemberSelector instance used to determine required members.
Public property SupportedEncodings Gets the mutable collection of character encodings supported bythis MediaTypeFormatter.
Public property SupportedMediaTypes Gets the mutable collection of media types supported bythis MediaTypeFormatter.

Top

Methods

  Name Description
Public method CanReadType Queries whether this MediaTypeFormatter can deserializean object of the specified type.
Public method CanWriteType Queries whether this MediaTypeFormatter can serializean object of the specified type.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public methodStatic member GetDefaultValueForType Gets the default value for the specified type.
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.
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ReadFromStreamAsync Asynchronously deserializes an object of the specified type.
Public method SelectCharacterEncoding Determines the best character encoding for reading or writing an HTTP entity body, given a set of content headers.
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.
Public method ToString (Inherited from Object.)
Public method WriteToStreamAsync Asynchronously writes an object of the specified type.

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