HttpResponseMessageProperty Class

Definition

Namespace:

System.ServiceModel.Channels

Assembly:

System.ServiceModel.Http.dll

Package:

System.ServiceModel.Http v8.1.0

Source:

HttpResponseMessageProperty.cs

Provides access to the HTTP response in order to access and respond to the additional information made available for requests over the HTTP protocol.

public ref class HttpResponseMessageProperty sealed : System::ServiceModel::Channels::IMergeEnabledMessageProperty, System::ServiceModel::Channels::IMessageProperty

public sealed class HttpResponseMessageProperty : System.ServiceModel.Channels.IMergeEnabledMessageProperty, System.ServiceModel.Channels.IMessageProperty

type HttpResponseMessageProperty = class
    interface IMessageProperty
    interface IMergeEnabledMessageProperty

Public NotInheritable Class HttpResponseMessageProperty
Implements IMergeEnabledMessageProperty, IMessageProperty

Inheritance

Object

HttpResponseMessageProperty

Implements

IMessageProperty System.ServiceModel.Channels.IMergeEnabledMessageProperty

Examples

This shows how to use create an instance of the HttpResponseProperty class and modify some of its members:

HttpResponseMessageProperty responseProperty =
    new HttpResponseMessageProperty();
responseProperty.StatusCode = HttpStatusCode.OK;
responseProperty.Headers.Add(
                 HttpResponseHeader.ContentType,
                 "text/html; charset=UTF-8");

Remarks

This is a general-purpose class that gives you direct access to the HTTP response information, which could be used for encapsulation of HTTP-specific information. One use of this class is to support services implemented in accordance with the Representational State Transfer (REST) architecture.

This class enables you to support the following scenarios:

• Controls whether an entity body is transmitted.

• Allows HTTP header (key, value) pairs to be set for each response.

• Varies the status code and status description used for each response.

This class can be used by HttpTransportBindingElement and related classes.

Constructors

HttpResponseMessageProperty()

Initializes a new instance of the HttpResponseMessageProperty class.

Properties

Headers	Gets the HTTP headers from the HTTP response.
HttpResponseMessage
Name	Gets the name of the message property associated with the HttpResponseMessageProperty class.
StatusCode	Gets or sets the status code of the current HTTP response to which this property is attached.
StatusDescription	Gets or sets the description of the status code of the current HTTP response to which this property is attached.
SuppressEntityBody	Gets or sets a value that indicates whether the body of the message is ignored and an empty message is sent.
SuppressPreamble	Gets or sets whether the message preamble is suppressed.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

IMergeEnabledMessageProperty.TryMergeWithProperty(Object)
IMessageProperty.CreateCopy()	Creates a new copy of the current instance.