﻿using System.Threading.Tasks;

namespace MoreDakka.BattleNetAuth.Provider
{
    /// <summary>
    /// Specifies callback methods which the <see cref="BattleNetAuthenticationMiddleware"></see> invokes to enable developer control over the authentication process. />
    /// </summary>
    public interface IBattleNetAuthenticationProvider
    {
        /// <summary>
        /// Invoked whenever GitHub succesfully authenticates a user
        /// </summary>
        /// <param name="context">Contains information about the login session as well as the user <see cref="System.Security.Claims.ClaimsIdentity"/>.</param>
        /// <returns>A <see cref="Task"/> representing the completed operation.</returns>
        Task Authenticated(BattleNetAuthenticatedContext context);

        /// <summary>
        /// Invoked prior to the <see cref="System.Security.Claims.ClaimsIdentity"/> being saved in a local cookie and the browser being redirected to the originally requested URL.
        /// </summary>
        /// <param name="context"></param>
        /// <returns>A <see cref="Task"/> representing the completed operation.</returns>
        Task ReturnEndpoint(BattleNetReturnEndpointContext context);
    }
}