Skip to content
This repository has been archived by the owner on Dec 14, 2018. It is now read-only.

Commit

Permalink
Note possible StatusCodes of Challenge
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanbrandenburg committed Mar 3, 2017
1 parent b208a58 commit 57b18dd
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions src/Microsoft.AspNetCore.Mvc.Core/ControllerBase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1270,6 +1270,10 @@ public virtual AcceptedAtRouteResult AcceptedAtRoute(string routeName, object ro
/// Creates a <see cref="ChallengeResult"/>.
/// </summary>
/// <returns>The created <see cref="ChallengeResult"/> for the response.</returns>
/// <remarks>
/// The behavior of this method depends on the <see cref="AuthenticationManager"/> in use.
/// <see cref="StatusCodes.Status401Unauthorized"/> and <see cref="StatusCodes.Status403Forbidden"/> are among likely status results.
/// </remarks>
[NonAction]
public virtual ChallengeResult Challenge()
=> new ChallengeResult();
Expand All @@ -1279,6 +1283,10 @@ public virtual ChallengeResult Challenge()
/// </summary>
/// <param name="authenticationSchemes">The authentication schemes to challenge.</param>
/// <returns>The created <see cref="ChallengeResult"/> for the response.</returns>
/// <remarks>
/// The behavior of this method depends on the <see cref="AuthenticationManager"/> in use.
/// <see cref="StatusCodes.Status401Unauthorized"/> and <see cref="StatusCodes.Status403Forbidden"/> are among likely status results.
/// </remarks>
[NonAction]
public virtual ChallengeResult Challenge(params string[] authenticationSchemes)
=> new ChallengeResult(authenticationSchemes);
Expand All @@ -1289,6 +1297,10 @@ public virtual ChallengeResult Challenge(params string[] authenticationSchemes)
/// <param name="properties"><see cref="AuthenticationProperties"/> used to perform the authentication
/// challenge.</param>
/// <returns>The created <see cref="ChallengeResult"/> for the response.</returns>
/// <remarks>
/// The behavior of this method depends on the <see cref="AuthenticationManager"/> in use.
/// <see cref="StatusCodes.Status401Unauthorized"/> and <see cref="StatusCodes.Status403Forbidden"/> are among likely status results.
/// </remarks>
[NonAction]
public virtual ChallengeResult Challenge(AuthenticationProperties properties)
=> new ChallengeResult(properties);
Expand All @@ -1301,6 +1313,10 @@ public virtual ChallengeResult Challenge(AuthenticationProperties properties)
/// challenge.</param>
/// <param name="authenticationSchemes">The authentication schemes to challenge.</param>
/// <returns>The created <see cref="ChallengeResult"/> for the response.</returns>
/// <remarks>
/// The behavior of this method depends on the <see cref="AuthenticationManager"/> in use.
/// <see cref="StatusCodes.Status401Unauthorized"/> and <see cref="StatusCodes.Status403Forbidden"/> are among likely status results.
/// </remarks>
[NonAction]
public virtual ChallengeResult Challenge(
AuthenticationProperties properties,
Expand Down

0 comments on commit 57b18dd

Please sign in to comment.