Documentation Coverage Report
Current view: top level - Cqrs/Authentication - IAuthenticationTokenHelper.cs Hit Total Coverage
Version: 2.2 Artefacts: 2 2 100.0 %
Date: 2018-08-07 15:04:50

          Line data    Source code
       1             : #region Copyright
       2             : // // -----------------------------------------------------------------------
       3             : // // <copyright company="Chinchilla Software Limited">
       4             : // //   Copyright Chinchilla Software Limited. All rights reserved.
       5             : // // </copyright>
       6             : // // -----------------------------------------------------------------------
       7             : #endregion
       8             : 
       9             : using System;
      10             : using System.ServiceModel;
      11             : 
      12             : namespace Cqrs.Authentication
      13             : {
      14             :         /// <summary>
      15             :         /// A helper for setting and retrieving authentication tokens of type <typeparamref name="TAuthenticationToken"/>.
      16             :         /// </summary>
      17             :         /// <typeparam name="TAuthenticationToken">The <see cref="Type"/> of authentication token.</typeparam>
      18             :         [ServiceContract(Namespace = "https://getcqrs.net/SingleSignOn/TokenHelper")]
      19             :         public interface IAuthenticationTokenHelper<TAuthenticationToken>
      20             :         {
      21             :                 /// <summary>
      22             :                 /// Get the current <typeparamref name="TAuthenticationToken">authentication token</typeparamref> for the current context/request.
      23             :                 /// </summary>
      24             :                 [OperationContract]
      25           1 :                 TAuthenticationToken GetAuthenticationToken();
      26             : 
      27             :                 /// <summary>
      28             :                 /// Set the provided <paramref name="token"/> for the current context/request.
      29             :                 /// </summary>
      30             :                 [OperationContract]
      31           1 :                 TAuthenticationToken SetAuthenticationToken(TAuthenticationToken token);
      32             :         }
      33             : }

Generated by: LCOV version 1.12