AuthResult

Namespace: ASPSecurityKit.AuthProviders
Assembly: ASPSecurityKit.dll

Summary

Represents the result of an auth operation.

Properties

IsSuccess

Summary

Gets a value indicating whether operation represented by this instance succeeded.

Value

true if operation represented by this instance succeeded; otherwise, false.

Code

Summary

Gets a value indicating the exact result returned by the operation.

Value

The exact result returned by the operation.

FailureDescription

Summary

Gets a value Indicating additional information (if any) about the cause of the failure.

Value

The additional information (if any) about the cause of the failure.

Errors

Summary

Gets the individual data points representing the exact cause of, or the useful detailed information to help in troubleshooting the failure.

Value

The individual data points representing the exact cause of, or the useful detailed information to help in troubleshooting the failure.

Success

Summary

Shortcut property for creating success auth result.

Value

A new instance with Code initialized as Success.

Methods

Failed(reason,failureDescription,errors)

Summary

Gets a new instance of AuthResult initialized with the specified failure result.

Returns

A new instance of AuthResult initialized with the specified failure result.

Parameters
Name Type Description
reason ASPSecurityKit.OpResult The reason.
failureDescription System.String The failure description.
errors System.Collections.Generic.List{ASPSecurityKit.AuthError} The detailed/additional error information to aid in troubleshooting.
Exceptions
Type Description
System.InvalidOperationException When reason is Success.