summaryrefslogtreecommitdiffstats
path: root/src/DotNetOpenAuth.OpenId/OpenId/Messages/IErrorMessage.cs
blob: 549b32745e2a28cb1df3ddd2123480a9ca835cbc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
//-----------------------------------------------------------------------
// <copyright file="IErrorMessage.cs" company="Andrew Arnott">
//     Copyright (c) Andrew Arnott. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------

namespace DotNetOpenAuth.OpenId.Messages {
	using DotNetOpenAuth.Messaging;

	/// <summary>
	/// Members found on error response messages sent from a Provider 
	/// to a Relying Party in response to direct and indirect message
	/// requests that result in an error.
	/// </summary>
	internal interface IErrorMessage : IProtocolMessage {
		/// <summary>
		/// Gets or sets a human-readable message indicating why the request failed. 
		/// </summary>
		string ErrorMessage { get; set; }

		/// <summary>
		/// Gets or sets the contact address for the administrator of the server. 
		/// </summary>
		/// <value>The contact address may take any form, as it is intended to be displayed to a person. </value>
		string Contact { get; set; }

		/// <summary>
		/// Gets or sets a reference token, such as a support ticket number or a URL to a news blog, etc. 
		/// </summary>
		string Reference { get; set; }
	}
}