diff options
Diffstat (limited to 'src/DotNetOAuth/IProtocolMessage.cs')
| -rw-r--r-- | src/DotNetOAuth/IProtocolMessage.cs | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/src/DotNetOAuth/IProtocolMessage.cs b/src/DotNetOAuth/IProtocolMessage.cs index ccf4e5a..4dd31ae 100644 --- a/src/DotNetOAuth/IProtocolMessage.cs +++ b/src/DotNetOAuth/IProtocolMessage.cs @@ -8,5 +8,18 @@ namespace DotNetOAuth { /// as OAuth messages.
/// </summary>
interface IProtocolMessage {
+ /// <summary>
+ /// Checks the message state for conformity to the protocol specification
+ /// and throws an exception if the message is invalid.
+ /// </summary>
+ /// <remarks>
+ /// <para>Some messages have required fields, or combinations of fields that must relate to each other
+ /// in specialized ways. After deserializing a message, this method checks the state of the
+ /// message to see if it conforms to the protocol.</para>
+ /// <para>Note that this property should <i>not</i> check signatures or perform any state checks
+ /// outside this scope of this particular message.</para>
+ /// </remarks>
+ /// <exception cref="ProtocolException">Thrown if the message is invalid.</exception>
+ void EnsureValidMessage();
}
}
|