HttpWebAdapters.Adapters.HttpWebResponseAdapter Class Reference
Public Member Functions | |
HttpWebResponseAdapter (WebResponse response) | |
string | GetResponseHeader (string headerName) |
Gets the contents of a header that was returned with the response. | |
void | Close () |
When overridden by a descendant class, closes the response stream. | |
Stream | GetResponseStream () |
When overridden in a descendant class, returns the data stream from the Internet resource. | |
void | Dispose () |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. | |
Properties | |
CookieCollection | Cookies [get, set] |
Gets or sets the cookies that are associated with this response. | |
string | ContentEncoding [get] |
Gets the method that is used to encode the body of the response. | |
string | CharacterSet [get] |
Gets the character set of the response. | |
string | Server [get] |
Gets the name of the server that sent the response. | |
DateTime | LastModified [get] |
Gets the last date and time that the contents of the response were modified. | |
HttpStatusCode | StatusCode [get] |
Gets the status of the response. | |
string | StatusDescription [get] |
Gets the status description returned with the response. | |
Version | ProtocolVersion [get] |
Gets the version of the HTTP protocol that is used in the response. | |
string | Method [get] |
Gets the method that is used to return the response. | |
bool | IsFromCache [get] |
Gets a T:System.Boolean value that indicates whether this response was obtained from the cache. | |
bool | IsMutuallyAuthenticated [get] |
Gets a T:System.Boolean value that indicates whether mutual authentication occurred. | |
long | ContentLength [get, set] |
When overridden in a descendant class, gets or sets the content length of data being received. | |
string | ContentType [get, set] |
When overridden in a derived class, gets or sets the content type of the data being received. | |
Uri | ResponseUri [get] |
When overridden in a derived class, gets the URI of the Internet resource that actually responded to the request. | |
WebHeaderCollection | Headers [get] |
When overridden in a derived class, gets a collection of header name-value pairs associated with this request. |
Member Function Documentation
void HttpWebAdapters.Adapters.HttpWebResponseAdapter.Close | ( | ) |
When overridden by a descendant class, closes the response stream.
- Exceptions:
-
T:System.NotSupportedException Any attempt is made to access the method, when the method is not overridden in a descendant class.
<PermissionSet><IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" flags="UnmanagedCode, ControlEvidence"></PermissionSet>
Implements HttpWebAdapters.IHttpWebResponse.
void HttpWebAdapters.Adapters.HttpWebResponseAdapter.Dispose | ( | ) |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
<filterpriority>2</filterpriority>
string HttpWebAdapters.Adapters.HttpWebResponseAdapter.GetResponseHeader | ( | string | headerName ) |
Gets the contents of a header that was returned with the response.
- Returns:
- The contents of the specified header.
- Parameters:
-
headerName The header value to return.
- Exceptions:
-
T:System.ObjectDisposedException The current instance has been disposed.
Implements HttpWebAdapters.IHttpWebResponse.
Stream HttpWebAdapters.Adapters.HttpWebResponseAdapter.GetResponseStream | ( | ) |
When overridden in a descendant class, returns the data stream from the Internet resource.
- Returns:
- An instance of the T:System.IO.Stream class for reading data from the Internet resource.
- Exceptions:
-
T:System.NotSupportedException Any attempt is made to access the method, when the method is not overridden in a descendant class.
<PermissionSet><IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" flags="UnmanagedCode, ControlEvidence"></PermissionSet>
Implements HttpWebAdapters.IHttpWebResponse.
Property Documentation
string HttpWebAdapters.Adapters.HttpWebResponseAdapter.CharacterSet [get] |
Gets the character set of the response.
- Returns:
- A string that contains the character set of the response.
- Exceptions:
-
T:System.ObjectDisposedException The current instance has been disposed.
<PermissionSet><IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" flags="UnmanagedCode"></PermissionSet>
Implements HttpWebAdapters.IHttpWebResponse.
string HttpWebAdapters.Adapters.HttpWebResponseAdapter.ContentEncoding [get] |
Gets the method that is used to encode the body of the response.
- Returns:
- A string that describes the method that is used to encode the body of the response.
- Exceptions:
-
T:System.ObjectDisposedException The current instance has been disposed.
Implements HttpWebAdapters.IHttpWebResponse.
long HttpWebAdapters.Adapters.HttpWebResponseAdapter.ContentLength [get, set] |
When overridden in a descendant class, gets or sets the content length of data being received.
- Returns:
- The number of bytes returned from the Internet resource.
- Exceptions:
-
T:System.NotSupportedException Any attempt is made to get or set the property, when the property is not overridden in a descendant class.
<PermissionSet><IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" flags="UnmanagedCode, ControlEvidence"></PermissionSet>
Implements HttpWebAdapters.IHttpWebResponse.
string HttpWebAdapters.Adapters.HttpWebResponseAdapter.ContentType [get, set] |
When overridden in a derived class, gets or sets the content type of the data being received.
- Returns:
- A string that contains the content type of the response.
- Exceptions:
-
T:System.NotSupportedException Any attempt is made to get or set the property, when the property is not overridden in a descendant class.
<PermissionSet><IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" flags="UnmanagedCode, ControlEvidence"></PermissionSet>
Implements HttpWebAdapters.IHttpWebResponse.
CookieCollection HttpWebAdapters.Adapters.HttpWebResponseAdapter.Cookies [get, set] |
Gets or sets the cookies that are associated with this response.
- Returns:
- A T:System.Net.CookieCollection that contains the cookies that are associated with this response.
- Exceptions:
-
T:System.ObjectDisposedException The current instance has been disposed.
Implements HttpWebAdapters.IHttpWebResponse.
WebHeaderCollection HttpWebAdapters.Adapters.HttpWebResponseAdapter.Headers [get] |
When overridden in a derived class, gets a collection of header name-value pairs associated with this request.
- Returns:
- An instance of the T:System.Net.WebHeaderCollection class that contains header values associated with this response.
- Exceptions:
-
T:System.NotSupportedException Any attempt is made to get or set the property, when the property is not overridden in a descendant class.
<PermissionSet><IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" flags="UnmanagedCode, ControlEvidence"></PermissionSet>
Implements HttpWebAdapters.IHttpWebResponse.
bool HttpWebAdapters.Adapters.HttpWebResponseAdapter.IsFromCache [get] |
Gets a T:System.Boolean value that indicates whether this response was obtained from the cache.
- Returns:
- true if the response was taken from the cache; otherwise, false.
Implements HttpWebAdapters.IHttpWebResponse.
bool HttpWebAdapters.Adapters.HttpWebResponseAdapter.IsMutuallyAuthenticated [get] |
Gets a T:System.Boolean value that indicates whether mutual authentication occurred.
- Returns:
- true if both client and server were authenticated; otherwise, false.
Implements HttpWebAdapters.IHttpWebResponse.
DateTime HttpWebAdapters.Adapters.HttpWebResponseAdapter.LastModified [get] |
Gets the last date and time that the contents of the response were modified.
- Returns:
- A T:System.DateTime that contains the date and time that the contents of the response were modified.
- Exceptions:
-
T:System.ObjectDisposedException The current instance has been disposed.
<PermissionSet><IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" flags="UnmanagedCode, ControlEvidence"></PermissionSet>
Implements HttpWebAdapters.IHttpWebResponse.
string HttpWebAdapters.Adapters.HttpWebResponseAdapter.Method [get] |
Gets the method that is used to return the response.
- Returns:
- A string that contains the HTTP method that is used to return the response.
- Exceptions:
-
T:System.ObjectDisposedException The current instance has been disposed.
Implements HttpWebAdapters.IHttpWebResponse.
Version HttpWebAdapters.Adapters.HttpWebResponseAdapter.ProtocolVersion [get] |
Gets the version of the HTTP protocol that is used in the response.
- Returns:
- A T:System.Version that contains the HTTP protocol version of the response.
- Exceptions:
-
T:System.ObjectDisposedException The current instance has been disposed.
Implements HttpWebAdapters.IHttpWebResponse.
Uri HttpWebAdapters.Adapters.HttpWebResponseAdapter.ResponseUri [get] |
When overridden in a derived class, gets the URI of the Internet resource that actually responded to the request.
- Returns:
- An instance of the T:System.Uri class that contains the URI of the Internet resource that actually responded to the request.
- Exceptions:
-
T:System.NotSupportedException Any attempt is made to get or set the property, when the property is not overridden in a descendant class.
<PermissionSet><IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" flags="UnmanagedCode, ControlEvidence"></PermissionSet>
Implements HttpWebAdapters.IHttpWebResponse.
string HttpWebAdapters.Adapters.HttpWebResponseAdapter.Server [get] |
Gets the name of the server that sent the response.
- Returns:
- A string that contains the name of the server that sent the response.
- Exceptions:
-
T:System.ObjectDisposedException The current instance has been disposed.
Implements HttpWebAdapters.IHttpWebResponse.
HttpStatusCode HttpWebAdapters.Adapters.HttpWebResponseAdapter.StatusCode [get] |
Gets the status of the response.
- Returns:
- One of the T:System.Net.HttpStatusCode values.
- Exceptions:
-
T:System.ObjectDisposedException The current instance has been disposed.
Implements HttpWebAdapters.IHttpWebResponse.
string HttpWebAdapters.Adapters.HttpWebResponseAdapter.StatusDescription [get] |
Gets the status description returned with the response.
- Returns:
- A string that describes the status of the response.
- Exceptions:
-
T:System.ObjectDisposedException The current instance has been disposed.
Implements HttpWebAdapters.IHttpWebResponse.
The documentation for this class was generated from the following file:
- HttpWebAdapters/Impl/HttpWebResponseAdapter.cs
Generated on Sun May 3 2015 17:19:05 for SolrNet by 1.7.2