diff options
| author | Andrew Arnott <andrewarnott@gmail.com> | 2008-09-01 16:06:01 -0700 |
|---|---|---|
| committer | Andrew <andrewarnott@gmail.com> | 2008-09-01 16:06:01 -0700 |
| commit | 4e83c2d321f57cac5e5605097faf15bf1b46efa5 (patch) | |
| tree | 3bb5c8dff9b56f1fd2e621417c0a2efcee94adbb /src/DotNetOAuth/IndirectMessage.cs | |
| parent | d5fb1dbbc8388eac763ef85310097a618ff90437 (diff) | |
| download | DotNetOpenAuth-4e83c2d321f57cac5e5605097faf15bf1b46efa5.zip DotNetOpenAuth-4e83c2d321f57cac5e5605097faf15bf1b46efa5.tar.gz DotNetOpenAuth-4e83c2d321f57cac5e5605097faf15bf1b46efa5.tar.bz2 | |
Lots of StyleCop changes.
Diffstat (limited to 'src/DotNetOAuth/IndirectMessage.cs')
| -rw-r--r-- | src/DotNetOAuth/IndirectMessage.cs | 41 |
1 files changed, 37 insertions, 4 deletions
diff --git a/src/DotNetOAuth/IndirectMessage.cs b/src/DotNetOAuth/IndirectMessage.cs index 98295bf..638b4fd 100644 --- a/src/DotNetOAuth/IndirectMessage.cs +++ b/src/DotNetOAuth/IndirectMessage.cs @@ -1,16 +1,49 @@ -namespace DotNetOAuth {
+//-----------------------------------------------------------------------
+// <copyright file="IndirectMessage.cs" company="Andrew Arnott">
+// Copyright (c) Andrew Arnott. All rights reserved.
+// </copyright>
+//-----------------------------------------------------------------------
+
+namespace DotNetOAuth {
using System.Net;
+ /// <summary>
+ /// A protocol message that passes between Consumer and Service Provider
+ /// via the user agent using a redirect or form POST submission.
+ /// </summary>
+ /// <remarks>
+ /// An <see cref="IndirectMessage"/> instance describes the HTTP response that must
+ /// be sent to the user agent to initiate the message transfer.
+ /// </remarks>
public class IndirectMessage {
- public WebHeaderCollection Headers { get; set; }
+ /// <summary>
+ /// Gets the headers that must be included in the response to the user agent.
+ /// </summary>
+ /// <remarks>
+ /// The headers in this collection are not meant to be a comprehensive list
+ /// of exactly what should be sent, but are meant to augment whatever headers
+ /// are generally included in a typical response.
+ /// </remarks>
+ public WebHeaderCollection Headers { get; internal set; }
- public byte[] Body { get; set; }
+ /// <summary>
+ /// Gets the body of the HTTP response.
+ /// </summary>
+ public byte[] Body { get; internal set; }
- public HttpStatusCode Status { get; set; }
+ /// <summary>
+ /// Gets the HTTP status code to use in the HTTP response.
+ /// </summary>
+ public HttpStatusCode Status { get; internal set; }
+ /// <summary>
+ /// Gets or sets a reference to the actual protocol message that
+ /// is being sent via the user agent.
+ /// </summary>
internal IProtocolMessage OriginalMessage { get; set; }
/// <summary>
+ /// Automatically sends the appropriate response to the user agent.
/// Requires a current HttpContext.
/// </summary>
public void Send() {
|