System.Net.Http.Formatting

Extension methods to provide convenience methods for finding items within a <see cref="T:System.Collections.Generic.IEnumerable`1" /> collection.

Returns all instances of in a sequence that has a header field with a property equal to the provided contentType.

null if source is empty or if no element matches; otherwise the first in the sequence with a matching media type. The content to evaluate The media type to look for.

Returns all instances of in a sequence that has a header field with a property equal to the provided contentType.

null if source is empty or if no element matches; otherwise the first in the sequence with a matching media type. The content to evaluate The media type to look for.

Returns the first in a sequence that has a header field with a property equal to dispositionName.

The first in the sequence with a matching disposition name. The contents to evaluate The disposition name to look for.

Returns the first in a sequence that has a header field with a property equal to dispositionName.

null if source is empty or if no element matches; otherwise the first in the sequence with a matching disposition name. The contents to evaluate The disposition name to look for.

Returns the first in a sequence that has a header field with a property equal to dispositionType.

The first in the sequence with a matching disposition type. The contents to evaluate The disposition type to look for.

Returns the first in a sequence that has a header field with a property equal to dispositionType.

null if source is empty or if no element matches; otherwise the first in the sequence with a matching disposition type. The contents to evaluate The disposition type to look for.

Returns the start multipart body part. The start is used to identify the main body in multipart/related content (see RFC 2387).

The first in the sequence with a matching value. The contents to evaluate. The start value to look for. A match is found if a has a Content-ID header field with the given value.

Returns the first in a sequence that has a header field parameter equal to start. This parameter is typically used in connection with multipart/related content (see RFC 2387).

null if source is empty or if no element matches; otherwise the first in the sequence with a matching value. The contents to evaluate. The start value to look for. A match is found if a has a Content-ID header field with the given value.

Extension methods to allow strongly typed objects to be read from instances.

Extension methods to read and entities from instances.

Determines whether the specified content is HTTP request message content.

true if the specified content is HTTP message content; otherwise, false. The content.

Determines whether the specified content is HTTP response message content.

true if the specified content is HTTP message content; otherwise, false. The content.

Extension methods to read MIME multipart entities from instances.

Determines whether the specified content is MIME multipart content.

true if the specified content is MIME multipart content; otherwise, false. The content.

Determines whether the specified content is MIME multipart content with the specified subtype. For example, the subtype mixed would match content with a content type of multipart/mixed.

true if the specified content is MIME multipart content with the specified subtype; otherwise, false. The content. The MIME multipart subtype to match.

Derived class which can encapsulate an or an as an entity with media type "application/http".

Initializes a new instance of the class encapsulating an .

The instance to encapsulate.

Initializes a new instance of the class encapsulating an .

The instance to encapsulate.

Releases unmanaged and - optionally - managed resources

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Gets the HTTP request message.

Gets the HTTP response message.

Asynchronously serializes the object's content to the given stream.

A instance that is asynchronously serializing the object's content. The to which to write. The associated .

Computes the length of the stream if possible.

true if the length has been computed; otherwise false. The computed length of the stream.

Derived class that contains a strongly typed object as its content.

The type of object it contains as its content.

Initializes a new instance of the <see cref="T:System.Net.Http.HttpRequestMessage`1" /> class.

The object to use as the content of this new instance.

Initializes a new instance of the <see cref="T:System.Net.Http.HttpRequestMessage`1" /> class.

The object to use as the content of this new instance. The collection of instances to use for serialization.

Initializes a new instance of the <see cref="T:System.Net.Http.HttpRequestMessage`1" /> class.

The object to use as the content of this new instance. The media type to use to write the request.

Initializes a new instance of the <see cref="T:System.Net.Http.HttpRequestMessage`1" /> class.

The object to use as the content of this new instance. The media type to use to write the request. The collection of instances to use for serialization.

Initializes a new instance of the <see cref="T:System.Net.Http.HttpRequestMessage`1" /> class.

The object to use as the content of this new instance. The media type to use to write the request. The collection of instances to use for serialization. The to use to select the .

Initializes a new instance of the <see cref="T:System.Net.Http.HttpRequestMessage`1" /> class.

The object to use as the content of this new instance. The for this request. The to use for this request. The collection of instances to use for serialization.

Initializes a new instance of the <see cref="T:System.Net.Http.HttpRequestMessage`1" /> class.

The object to use as the content of this new instance. The media type to use to write the request.

Gets or sets the that manages the object value for this .

Extension methods for .

Creates a new instance associated with the given .

The existing The type of the value. The value for the new

Creates a new instance associated with the given .

The . The type of the value. The value for the new The collection of instances to use. The to select the

Creates a new instance associated with the given .

The . The type of the value. The value for the new The to set as the request media type. The collection of instances to use. The to select the

Creates a new instance associated with the given .

The existing The value for the new The type of value for the new .

Creates a new instance associated with the given .

The . The value for the new The collection of instances to use. The to select the The type of the value.

Creates a new instance associated with the given .

The . The value for the new The to set as the request media type. The collection of instances to use. The to select the The type of the value.

Derived class that contains a strongly typed object as its content.

The type of object instances of this class will contain as its content.

Initializes a new instance of the <see cref="T:System.Net.Http.HttpResponseMessage`1" /> class.

The to use for this response.

Initializes a new instance of the <see cref="T:System.Net.Http.HttpResponseMessage`1" /> class.

The value to use as the content of this new instance.

Initializes a new instance of the <see cref="T:System.Net.Http.HttpResponseMessage`1" /> class.

The value to use as the content of this new instance. The collection of instances to use for serialization.

Initializes a new instance of the <see cref="T:System.Net.Http.HttpResponseMessage`1" /> class.

The value to use as the content of this new instance. The to use to select the appropriate .

Initializes a new instance of the <see cref="T:System.Net.Http.HttpResponseMessage`1" /> class.

The value to use as the content of this new instance. The to use to serialize the response.

Initializes a new instance of the <see cref="T:System.Net.Http.HttpResponseMessage`1" /> class.

The value to use as the content of this new instance. The original . The collection of instances to use for serialization. The to use to select the appropriate .

Initializes a new instance of the <see cref="T:System.Net.Http.HttpResponseMessage`1" /> class.

The value to use as the content of this new instance. The original . The media type to use. The collection of instances to use for serialization. The to use to select the appropriate .

Initializes a new instance of the <see cref="T:System.Net.Http.HttpResponseMessage`1" /> class.

The value to use as the content of this new instance. The to use for this response.

Initializes a new instance of the <see cref="T:System.Net.Http.HttpResponseMessage`1" /> class.

The value to use as the content of this new instance. The to use for this response. The collection of instances to use for serialization.

Gets or sets the that manages the value for this instance.

Creates a new instance associated with the given .

The existing The type of the value. The value for the new

Creates a new instance associated with the given .

The . The type of the value. The value for the new The collection of instances to use. The to select the

Creates a new instance associated with the given .

The . The type of the value. The value for the new The to set as the response media type. The collection of instances to use. The to select the

Creates a new instance associated with the given .

The existing The value for the new The type of value for the new .

Creates a new instance associated with the given .

The . The value for the new The collection of instances to use. The to select the The type of the value.

Creates a new instance associated with the given .

The . The value for the new The to set as the response media type. The collection of instances to use. The to select the The type of the value.

An implementation examines the headers provided by the MIME multipart parser as part of the MIME multipart extension methods (see ) and decides what kind of stream to return for the body part to be written to.

When a MIME multipart body part has been parsed this method is called to get a stream for where to write the body part to.

The instance where the message body part is written to. Header fields describing the body part.

An suited for writing each MIME body parts of the MIME multipart message to a file using a .

Initializes a new instance of the class.

The root path where the content of MIME multipart body parts are written to.

Initializes a new instance of the class.

The root path where the content of MIME multipart body parts are written to. The number of bytes buffered for writes to the file.

Gets an <see cref="T:System.Collections.Generic.IEnumerable`1" /> containing the files names of MIME body part written to file.

Gets the name of the local file which will be combined with the root path to create an absolute file name where the contents of the current MIME body part will be stored.

A relative filename with no path component. The headers for the current MIME body part.

This body part stream provider examines the headers provided by the MIME multipart parser and decides which to write the body part to.

The instance where the message body part is written to. Header fields describing the body part

Override this method in a derived class to examine the headers provided by the MIME multipart parser and decides which to write the body part to.

The instance where the message body part is written to. Header fields describing the body part

An suited for use with HTML file uploads for writing file content to a . The stream provider looks at the Content-Disposition header field and determines an output based on the presence of a filename parameter. If a filename parameter is present in the Content-Disposition header field then the body part is written to a , otherwise it is written to a . This makes it convenient to process MIME Multipart HTML Form data which is a combination of form data and file content.

Initializes a new instance of the class.

The root path where the content of MIME multipart body parts are written to.

Initializes a new instance of the class.

The root path where the content of MIME multipart body parts are written to. The number of bytes buffered for writes to the file.

Gets an <see cref="T:System.Collections.Generic.IDictionary`2" /> instance containing mappings of each filename parameter provided in a Content-Disposition header field (represented as the keys) to a local file name where the contents of the body part is stored (represented as the values).

Gets the name of the local file which will be combined with the root path to create an absolute file name where the contents of the current MIME body part will be stored.

A relative filename with no path component. The headers for the current MIME body part.

This body part stream provider examines the headers provided by the MIME multipart parser and decides whether it should return a file stream or a memory stream for the body part to be written to.

The instance where the message body part is written to. Header fields describing the body part

Override this method in a derived class to examine the headers provided by the MIME multipart parser and decide whether it should return a file stream or a memory stream for the body part to be written to.

The instance where the message body part is written to. Header fields describing the body part

Derived class that contains a strongly typed object.

Asynchronously creates the content read stream.

A instance that will yield a stream intended for reading.

Gets or sets the default formatter.

The default formatter.

Gets or sets the formatter context.

The formatter context.

Gets the mutable collection of instances used to serialize or deserialize the value of this .

Gets or sets the formatter selector.

The formatter selector.

Gets or sets the inner wrapped by by the current .

Gets the type of object managed by this instance.

Asynchronously returns the object instance for this .

A instance that will yield the object instance.

Asynchronously returns the object instance for this or the default value for the type if content is not available.

A instance that will yield the object instance.

Selects the appropriate to read the object content.

The selected or null.

Selects the appropriate to write the object content.

The selected or null. The to use to describe the object's content type.

Asynchronously serializes the object's content to the given stream.

A instance that is asynchronously serializing the object's content. The to which to write. The associated .

Sets the value of the without any type checking.

The value to set to

Computes the length of the stream if possible.

true if the length has been computed; otherwise false. The computed length of the stream.

Gets a value indicating whether the formatter collection was set explicitly.

truefalse

Gets a value indicating whether formatter context was set explicitly.

truefalse

Gets a value indicating whether the formatter selector was set explicitly.

truefalse

Gets and sets value indicating whether the media type was set explicitly.

truefalse

Gets or sets the write formatter.

The write formatter.

Generic form of .

The type of object this class will contain.

Returns a instance to yield the object instance for this .

A that will yield the object instance.

Returns a instance to yield the object instance for this or the default value for the type if content is not available.

A that will yield the object instance.

Extension methods to allow strongly typed objects to be read from the query component of instances.

Parses the query portion of the specified .

A containing the parsed result. The instance from which to read.

Reads HTML form URL encoded data provided in the query component as an of the given type.

true if the query component can be read as the specified type; otherwise false. The instance from which to read. The type of the object to read. An object to be initialized with this instance or null if the conversion cannot be performed.

Reads HTML form URL encoded data provided in the query component as an of type <typeparamref name="T" />.

true if the query component can be read as the specified type; otherwise false. The instance from which to read. An object to be initialized with this instance or null if the conversion cannot be performed. The type of the object to read.

Reads HTML form URL encoded data provided in the query component as a object.

true if the query component can be read as ; otherwise false. The instance from which to read. An object to be initialized with this instance or null if the conversion cannot be performed.

Helper class to allow a synchronous formatter on top of the async formatter infrastructure. This does not guarantee non-blocking threads. The only way to guarantee that we don't block a thread on IO is: a) use the async form, or b) fully buffer the entire write operation. The user opted out of the async form, meaning they can tolerate potential thread blockages. This class just tries to do smart buffering to minimize that blockage. It also gives us a place to do future optimizations on synchronous usage.

Initializes a new instance of the class.

Suggested size of buffer to use with streams, in bytes.

Helper class to serialize <see cref="T:System.Collections.Generic.IEnumerable`1" /> types by delegating them through a concrete implementation."/>.

The interface implementing to proxy.

Initialize a DelegatingEnumerable. This constructor is necessary for to work.

Initialize a DelegatingEnumerable with an <see cref="T:System.Collections.Generic.IEnumerable`1" />. This is a helper class to proxy <see cref="T:System.Collections.Generic.IEnumerable`1" /> interfaces for .

The <see cref="T:System.Collections.Generic.IEnumerable`1" /> instance to get the enumerator from.

This method is not implemented but is required method for serialization to work. Do not use.

The item to add. Unused.

Get the enumerator of the associated <see cref="T:System.Collections.Generic.IEnumerable`1" />.

The enumerator of the <see cref="T:System.Collections.Generic.IEnumerable`1" /> source.

Get the enumerator of the associated <see cref="T:System.Collections.Generic.IEnumerable`1" />.

The enumerator of the <see cref="T:System.Collections.Generic.IEnumerable`1" /> source.

The context used to identify the or that needs to be either read or written.

Instantiates a new instance of a .

The to use in the absence of a request or response. Indicates if this is context is meant to select a formatter to read or to write.

Instantiates a new instance of the class to use to serialize or deserialize a request.

The to serialize or deserialize. Indicates if this is context is meant to select a formatter to read or to write.

Instantiates a new instance of the class to use to serialize or deserialize a response.

The to serialize or deserialize. Indicates if this is context is meant to select a formatter to read or to write.

Gets the HTTP Content-Type of the request or response associated with the context.

Gets a value indicating whether the context will be used to select for formatter for reading or writing the content

Gets the associated with the context.

Gets the associated with the context or null if there is no associated response message.

Class that selects a for an or .

Initializes a new instance of the class.

Called to select a formatter for deserializing an instance of a given type.

The chosen for deserialization or null if their is no appropriate formatter.> The type to be deserialized. The context related to the deserialization of the instance. The set of objects from which to choose.

Called to select a formatter for serializing an instance of a given type.

The chosen for serialization or null if their is no appropriate formatter. The type to be serialized. The context related to the serialization of the instance. The set of objects from which to choose. The media type that is associated with the formatter chosen for serialization.

Selects a formatter for deserializing an instance of a given type.

Selects a formatter for serializing an instance of a given type.

class for handling HTML form URL-ended data, also known as application/x-www-form-urlencoded.

Initializes a new instance of the class.

Determines whether this can read objects of the specified type.

true if objects of this type can be read, otherwise false. The type of object that will be read.

Determines whether this can write objects of the specified type.

true if objects of this type can be written, otherwise false. The type of object that will be written.

Gets the default media type for HTML Form URL encoded data, namely application/x-www-form-urlencoded.

Called during serialization to write an object of the specified type to the specified stream.

A that will write the value to the stream. The type of object to write. The object to write. The to which to write. The for the content being read. The containing the respective request or response. The .

Gets or sets the size of the buffer when reading the incoming stream.

The size of the read buffer.

Interface to select a for an or .

Selects a formatter for deserializing an instance of a given type.

Selects a formatter for serializing an instance of a given type.

Interface to provide a key/value model of an object graph.

Gets all the keys for all the values.

Attempts to retrieve the value associated with the given key.

If there was a value associated with that key The key of the value to retrieve. The value associated with that key.

class to handle Json.

Initializes a new instance of the class.

Gets or sets a flag indicating whether this formatter uses a serialization surrogate to allow data contracts marked with set to true to be serialized.

truefalse

Determines whether this can read objects of the specified type.

true if objects of this type can be read, otherwise false. The type of object that will be read.

Determines whether this can write objects of the specified type.

true if objects of this type can be written, otherwise false. The type of object that will be written.

Gets or sets the to use when writing data.

Creates the default serializer used to serialize objects of the specified type.

A that can serialize instances of the specified type. The type of object to create a serializer for. A <see cref="T:System.Collections.Generic.IEnumerable`1" /> of Type that contains the known types that may be present in the object graph. true to create a serializer that can handle reference data contracts, otherwise false.

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

Called during serialization to write an object of the specified type to the specified stream.

A that will write the value to the stream. The type of object to write. The object to write. The to which to write. The for the content being written. The containing the respective request or response. The .

Unregisters the serializer currently associated with the given type.

true if a serializer was registered for the type; otherwise false. The type of object whose serializer should be removed.

Registers the to use to read or write the specified <typeparamref name="T" /> type.

The instance to use. The type of object that will be serialized or deserialized with the serializer.

Registers the to use to read or write the specified type.

The type of object that will be serialized or deserialized with the serializer. The instance to use.

Class that provides s for a request or response from a media range.

Initializes a new instance of the class.

The that provides a description of the media range. The to return on a match.

Initializes a new instance of the class.

The description of the media range. The media type to return on a match.

Gets the describing the known media range.

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

Initializes a new instance of the class.

Determines whether this can deserialize an object of the specified type.

true if this can deserialize an object of that type; otherwise false. The type of object that will be deserialized.

Determines whether this can serialize an object of the specified type.

true if this can serialize an object of that type; otherwise false. The type of object that will be serialized.

Gets or sets the to use when reading and writing data.

Gets the mutable collection of elements used by this instance to determine the of requests or responses.

Called from <see cref="M:System.Net.Http.Formatting.MediaTypeFormatter.GetResponseHeaders(System.Type,System.String,System.Net.Http.HttpResponseMessage)" /> to retrieve the response headers.

The collection of response header key value pairs. The type of the object. See . The media type. The .

Called to write an object to the stream asynchronously.

A that will write the object to the stream asynchronously. The type of object to write. The object instance to write. The to which to write. The for the content being written. The containing the respective request or response. The .

Gets or sets {insert text here}.

Gets the mutable collection of elements supported by this instance.

Returns a that serializes the given value of the given type to the given stream.

A that will perform the write. The type of the object to write. The object value to write. It may be null. The to which to write. The if available. It may be null. The containing the The if available. It may be null.

Collection class that contains instances.

Initializes a new instance of the class.

A collection of instances to place in the collection.

Gets the to use for application/x-www-form-urlencoded data.

Gets the to use for Json.

Gets the to use for Xml.

Extensions for adding items to a .

Updates the given formatter's set of elements so that it associates the mediaType with requests or responses containing mediaRange in the content headers.

The to receive the new item. The media range that will appear in the content headers. The media type to associate with that mediaRange.

Updates the given formatter's set of elements so that it associates the mediaType with requests or responses containing mediaRange in the content headers.

The to receive the new item. The media range that will appear in the content headers. The media type to associate with that mediaRange.

Updates the given formatter's set of elements so that it associates the mediaType with s containing a specific query parameter and value.

The to receive the new item. The name of the query parameter. The value assigned to that query parameter. The to associate with a containing a query string matching queryStringParameterName and queryStringParameterValue.

Updates the given formatter's set of elements so that it associates the mediaType with s containing a specific query parameter and value.

The to receive the new item. The name of the query parameter. The value assigned to that query parameter. The media type to associate with a containing a query string matching queryStringParameterName and queryStringParameterValue.

Updates the given formatter's set of elements so that it associates the mediaType with a specific HTTP request header field with a specific value.

The to receive the new item. Name of the header to match. The header value to match. The to use when matching headerValue. if set to true then headerValue is considered a match if it matches a substring of the actual header value. The to associate with a entry with a name matching headerName and a value matching headerValue.

Updates the given formatter's set of elements so that it associates the mediaType with a specific HTTP request header field with a specific value.

The to receive the new item. Name of the header to match. The header value to match. The to use when matching headerValue. if set to true then headerValue is considered a match if it matches a substring of the actual header value. The media type to associate with a entry with a name matching headerName and a value matching headerValue.

Updates the given formatter's set of elements so that it associates the mediaType with s ending with the given uriPathExtension.

The to receive the new item. The string of the path extension. The to associate with s ending with uriPathExtension.

Updates the given formatter's set of elements so that it associates the mediaType with s ending with the given uriPathExtension.

The to receive the new item. The string of the path extension. The string media type to associate with s ending with uriPathExtension.

An abstract base class used to create an association between or instances that have certain characteristics and a specific .

Initializes a new instance of a with the given mediaType value.

The that is associated with or instances that have the given characteristics of the .

Initializes a new instance of a with the given mediaType value.

The that is associated with or instances that have the given characteristics of the .

Gets the that is associated with or instances that have the given characteristics of the .

Implemented in a derived class to determine if the should be associated with the of the .

The quality of the match. It must be between 0.0 and 1.0. A value of 0.0 signifies no match. A value of 1.0 signifies a complete match. The to evaluate for the characteristics associated with the of the .

Implemented in a derived class to determine if the should be associated with the of the .

Returns the quality of the match of the associated with request.

Returns the quality of the match of the associated with response.

Class that provides s from query strings.

Initializes a new instance of the class.

The name of the query string parameter to match, if present. The value of the query string parameter specified by queryStringParameterName. The to use if the query parameter specified by queryStringParameterName is present and assigned the value specified by queryStringParameterValue.

Initializes a new instance of the class.

The name of the query string parameter to match, if present. The value of the query string parameter specified by queryStringParameterName. The media type to use if the query parameter specified by queryStringParameterName is present and assigned the value specified by queryStringParameterValue.

Gets the query string parameter name.

Gets the query string parameter value.

This class provides a mapping from an arbitrary HTTP request header field to a used to select instances for handling the entity body of an or . <remarks>This class only checks header fields associated with for a match. It does not check header fields associated with or instances.</remarks>

Initializes a new instance of the class.

Name of the header to match. The header value to match. The to use when matching headerValue. if set to true then headerValue is considered a match if it matches a substring of the actual header value. The to use if headerName and headerValue is considered a match.

Initializes a new instance of the class.

Name of the header to match. The header value to match. The value comparison to use when matching headerValue. if set to true then headerValue is considered a match if it matches a substring of the actual header value. The media type to use if headerName and headerValue is considered a match.

Gets the name of the header to match.

Gets the header value to match.

Gets the to use when matching .

Gets a value indicating whether is a matched as a substring of the actual header value. this instance is value substring.

truefalse

Returns a value indicating whether the current instance can return a from request.

The quality of the match. It must be between 0.0 and 1.0. A value of 0.0 signifies no match. A value of 1.0 signifies a complete match. The to check.

Returns a value indicating whether the current instance can return a from response.

The quality of the match. It must be between 0.0 and 1.0. A value of 0.0 signifies no match. A value of 1.0 signifies a complete match. The to check.

Class that provides s from path extensions appearing in a .

Initializes a new instance of the class.

The extension corresponding to mediaType. This value should not include a dot or wildcards. The that will be returned if uriPathExtension is matched.

Initializes a new instance of the class.

The extension corresponding to mediaType. This value should not include a dot or wildcards. The media type that will be returned if uriPathExtension is matched.

Gets the path extension.

class to handle Xml.

Initializes a new instance of the class.

Determines whether this can read objects of the specified type.

true if objects of this type can be read, otherwise false. The type of object that will be read.

Determines whether this can write objects of the specified type.

true if objects of this type can be written, otherwise false. The type of object that will be written.

Gets or sets the to use when writing data.

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

<remarks> The default media type does not have any charset parameter as the can be configured on a per instance basis. </remarks>

Called during serialization to write an object of the specified type to the specified stream.

Unregisters the serializer currently associated with the given type.

true if a serializer was registered for the type; otherwise false. The type of object whose serializer should be removed.

Registers the to use to read or write the specified <typeparamref name="T" /> type.

The instance to use. The type of object that will be serialized or deserialized with serializer.

Registers the to use to read or write the specified type.

The type of object that will be serialized or deserialized with serializer. The instance to use.

Registers the to use to read or write the specified type.

The type of objects for which serializer will be used. The instance to use.

Registers the to use to read or write the specified <typeparamref name="T" /> type.

The instance to use. The type of object that will be serialized or deserialized with serializer.

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

truefalsefalse