Clarify summary for ValidateSecurityStamp (#22483)

This commit is contained in:
Hao Kung 2020-06-02 17:06:57 -07:00 committed by GitHub
parent faf60675fe
commit bdc051a08a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions

View File

@ -296,12 +296,12 @@ namespace Microsoft.AspNetCore.Identity
}
/// <summary>
/// Validates the security stamp for the specified <paramref name="user"/>. Will always return false
/// if the userManager does not support security stamps.
/// Validates the security stamp for the specified <paramref name="user"/>. If no user is specified, or if the store
/// does not support security stamps, validation is considered successful.
/// </summary>
/// <param name="user">The user whose stamp should be validated.</param>
/// <param name="securityStamp">The expected security stamp value.</param>
/// <returns>True if the stamp matches the persisted value, otherwise it will return false.</returns>
/// <returns>The result of the validation.</returns>
public virtual async Task<bool> ValidateSecurityStampAsync(TUser user, string securityStamp)
=> user != null &&
// Only validate the security stamp if the store supports it