summaryrefslogtreecommitdiffstats
path: root/src/DotNetOpenId/RelyingParty/IXrdsProviderEndpoint.cs
blob: 78c873fc417eb2680d6f811ced2bcdd217f3d10b (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
using System.Diagnostics.CodeAnalysis;

namespace DotNetOpenId.RelyingParty {
	/// <summary>
	/// An <see cref="IProviderEndpoint"/> interface with additional members for use
	/// in sorting for most preferred endpoint.
	/// </summary>
	[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Xrds")]
	public interface IXrdsProviderEndpoint : IProviderEndpoint {
		/// <summary>
		/// Checks for the presence of a given Type URI in an XRDS service.
		/// </summary>
		bool IsTypeUriPresent(string typeUri);
		/// <summary>
		/// Gets the priority associated with this service that may have been given
		/// in the XRDS document.
		/// </summary>
		int? ServicePriority { get; }
		/// <summary>
		/// Gets the priority associated with the service endpoint URL.
		/// </summary>
		/// <remarks>
		/// When sorting by priority, this property should be considered second after 
		/// <see cref="ServicePriority"/>.
		/// </remarks>
		int? UriPriority { get; }
	}
}