diff options
Diffstat (limited to 'src/DotNetOpenAuth.AspNet/IAuthenticationClient.cs')
-rw-r--r-- | src/DotNetOpenAuth.AspNet/IAuthenticationClient.cs | 24 |
1 files changed, 18 insertions, 6 deletions
diff --git a/src/DotNetOpenAuth.AspNet/IAuthenticationClient.cs b/src/DotNetOpenAuth.AspNet/IAuthenticationClient.cs index 4a9c8fb..58232c6 100644 --- a/src/DotNetOpenAuth.AspNet/IAuthenticationClient.cs +++ b/src/DotNetOpenAuth.AspNet/IAuthenticationClient.cs @@ -12,26 +12,38 @@ namespace DotNetOpenAuth.AspNet { /// Represents a client which can authenticate users via an external website/provider. /// </summary> public interface IAuthenticationClient { + #region Public Properties + /// <summary> /// Gets the name of the provider which provides authentication service. /// </summary> string ProviderName { get; } + #endregion + + #region Public Methods and Operators + /// <summary> - /// Attempts to authenticate users by forwarding them to an external website, and - /// upon succcess or failure, redirect users back to the specified url. + /// Attempts to authenticate users by forwarding them to an external website, and upon succcess or failure, redirect users back to the specified url. /// </summary> - /// <param name="context">The context of the current request.</param> - /// <param name="returnUrl">The return url after users have completed authenticating against external website.</param> + /// <param name="context"> + /// The context of the current request. + /// </param> + /// <param name="returnUrl"> + /// The return url after users have completed authenticating against external website. + /// </param> void RequestAuthentication(HttpContextBase context, Uri returnUrl); /// <summary> /// Check if authentication succeeded after user is redirected back from the service provider. /// </summary> - /// <param name="context">The context of the current request.</param> + /// <param name="context"> + /// The context of the current request. + /// </param> /// <returns> - /// An instance of <see cref="AuthenticationResult"/> containing authentication result. + /// An instance of <see cref="AuthenticationResult"/> containing authentication result. /// </returns> AuthenticationResult VerifyAuthentication(HttpContextBase context); + #endregion } } |