Share via


RequestHeaderMapping Class

 

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

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

Inheritance Hierarchy

System.Object
  System.Net.Http.Formatting.MediaTypeMapping
    System.Net.Http.Formatting.RequestHeaderMapping
      System.Net.Http.Formatting.XmlHttpRequestHeaderMapping

Syntax

public class RequestHeaderMapping : MediaTypeMapping
public ref class RequestHeaderMapping : MediaTypeMapping
type RequestHeaderMapping = 
    class
        inherit MediaTypeMapping
    end
Public Class RequestHeaderMapping
    Inherits MediaTypeMapping

Constructors

Name Description
System_CAPS_pubmethod RequestHeaderMapping(String, String, StringComparison, Boolean, MediaTypeHeaderValue)

Initializes a new instance of the RequestHeaderMapping class.

System_CAPS_pubmethod RequestHeaderMapping(String, String, StringComparison, Boolean, String)

Initializes a new instance of the RequestHeaderMapping class.

Properties

Name Description
System_CAPS_pubproperty HeaderName

Gets the name of the header to match.

System_CAPS_pubproperty HeaderValue

Gets the header value to match.

System_CAPS_pubproperty HeaderValueComparison

Gets the StringComparison to use when matching M:HeaderValue.

System_CAPS_pubproperty IsValueSubstring

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

System_CAPS_pubproperty MediaType

Gets the MediaTypeHeaderValue that is associated with HttpRequestMessage or HttpResponseMessage instances that have the given characteristics of the MediaTypeMapping. (Inherited from MediaTypeMapping.)

Methods

Name Description
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 GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

System_CAPS_pubmethod TryMatchMediaType(HttpRequestMessage)

Returns a value indicating whether the current RequestHeaderMapping instance can return a MediaTypeHeaderValue from request. (Overrides MediaTypeMapping.TryMatchMediaType(HttpRequestMessage).)

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