Clarify documentation of RefreshSignInAsync (#10637)

Helps to address issues of confusion raised in https://github.com/aspnet/Identity/issues/1900 and https://github.com/aspnet/AspNetCore/issues/5844
This commit is contained in:
Andrew Scott 2019-10-21 22:18:09 -07:00 committed by Hao Kung
parent b2edf785d7
commit 4303bbe786
1 changed files with 3 additions and 3 deletions

View File

@ -161,10 +161,10 @@ namespace Microsoft.AspNetCore.Identity
}
/// <summary>
/// Regenerates the user's application cookie, whilst preserving the existing
/// AuthenticationProperties like rememberMe, as an asynchronous operation.
/// Signs in the specified <paramref name="user"/>, whilst preserving the existing
/// AuthenticationProperties of the current signed-in user like rememberMe, as an asynchronous operation.
/// </summary>
/// <param name="user">The user whose sign-in cookie should be refreshed.</param>
/// <param name="user">The user to sign-in.</param>
/// <returns>The task object representing the asynchronous operation.</returns>
public virtual async Task RefreshSignInAsync(TUser user)
{