MediaTypeFormatter Class

Article
2012-12-19

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

Top

Properties

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

Top

Methods

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

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