Early Preview
This is currently very much a preview. Please feel free to try things out,
but don't be upset if anything is not yet working. Feedback is welcome over on our
GitHub Dicussions page.
class Microsoft.AspNetCore.Authentication.HandleRequestResult
Assembly: Microsoft.AspNetCore.Authentication
Inheritance: object → AuthenticateResult → HandleRequestResult
Contains the result of an Authenticate call
Properties
public
bool
Handled
Indicates that stage of authentication was directly handled by
user intervention and no further processing should be attempted.
public
bool
Skipped
Indicates that the default authentication logic should be
skipped and that the rest of the pipeline should be invoked.
public
bool
Succeeded
public
AuthenticationTicket
Ticket
Principal
public
AuthenticationProperties
Properties
public
System.Exception
Failure
public
bool
None
Methods
public static
HandleRequestResult
Success(AuthenticationTicket ticket)
Indicates that authentication was successful.
Returns The result.
ticket
The ticket representing the authentication result.
public static
HandleRequestResult
Fail(System.Exception failure)
Indicates that there was a failure during authentication.
Returns The result.
failure
The failure exception.
public static
HandleRequestResult
Fail(System.Exception failure,
AuthenticationProperties? properties)
Indicates that there was a failure during authentication.
Returns The result.
failure
The failure exception.
properties
Additional state values for the authentication session.
public static
HandleRequestResult
Fail(string failureMessage)
Indicates that there was a failure during authentication.
Returns The result.
failureMessage
The failure message.
public static
HandleRequestResult
Fail(string failureMessage,
AuthenticationProperties? properties)
Indicates that there was a failure during authentication.
Returns The result.
failureMessage
The failure message.
properties
Additional state values for the authentication session.
public static
HandleRequestResult
Handle()
Discontinue all processing for this request and return to the client.
The caller is responsible for generating the full response.
Returns The result.
public static
HandleRequestResult
SkipHandler()
Discontinue processing the request in the current handler.
Returns The result.
public static
HandleRequestResult
NoResult()
Indicates that there were no results produced during authentication.
Returns The result.
public
bool
Equals(object obj)
Inherited from object
protected
void
Finalize()
Inherited from object
public
int
GetHashCode()
Inherited from object
protected
object
MemberwiseClone()
Inherited from object
public
string
ToString()
Inherited from object