LoginResult

Namespace: ASPSecurityKit
Assembly: ASPSecurityKit.dll

Summary

Represents the result of a login operation.

Properties

Auth

Summary

Gets the auth details returned by the operation.

Value

The auth details returned by the operation.

Result

Summary

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

Value

The exact result returned by the operation.

IsSuccess

Summary

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

Value

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

Methods

Failed(reason)

Summary

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

Returns

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

Parameters
Name Type Description
reason ASPSecurityKit.OpResult Reason of failure.
Exceptions
Type Description
System.InvalidOperationException When reason is Success.

Succeeded(auth)

Summary

Gets a new instance of LoginResult initialized with the specified auth details and success result.

Returns

A new instance of LoginResult initialized with the specified auth details and success result.

Parameters
Name Type Description
auth ASPSecurityKit.IAuthDetails The logged in identity details object.
Exceptions
Type Description
System.ArgumentNullException When auth is null.