SignInResult Class

Summary

Represents the result of a sign-in operation.

Syntax

public class SignInResult

GitHub

View on GitHub

class Microsoft.AspNet.Identity.SignInResult

Properties

Failed()

Returns a Microsoft.AspNet.Identity.SignInResult that represents a failed sign-in.

Return type:Microsoft.AspNet.Identity.SignInResult
Returns:A <see cref=”T:Microsoft.AspNet.Identity.SignInResult” /> that represents a failed sign-in. 
public static SignInResult Failed { get; }
IsLockedOut()

Returns a flag indication whether the user attempting to sign-in is locked out.

Return type:System.Boolean 
public bool IsLockedOut { get; protected set; }
IsNotAllowed()

Returns a flag indication whether the user attempting to sign-in is not allowed to sign-in.

Return type:System.Boolean 
public bool IsNotAllowed { get; protected set; }
LockedOut()

Returns a Microsoft.AspNet.Identity.SignInResult that represents a sign-in attempt that failed because the user was logged out.

Return type:Microsoft.AspNet.Identity.SignInResult
Returns:A <see cref=”T:Microsoft.AspNet.Identity.SignInResult” /> that represents sign-in attempt that failed due to the user being locked out. 
public static SignInResult LockedOut { get; }
NotAllowed()

Returns a Microsoft.AspNet.Identity.SignInResult that represents a sign-in attempt that failed because the user is not allowed to sign-in.

Return type:Microsoft.AspNet.Identity.SignInResult
Returns:A <see cref=”T:Microsoft.AspNet.Identity.SignInResult” /> that represents sign-in attempt that failed due to the user is not allowed to sign-in. 
public static SignInResult NotAllowed { get; }
RequiresTwoFactor()

Returns a flag indication whether the user attempting to sign-in requires two factor authentication.

Return type:System.Boolean 
public bool RequiresTwoFactor { get; protected set; }
Succeeded()

Returns a flag indication whether the sign-in was successful.

Return type:System.Boolean 
public bool Succeeded { get; protected set; }
Success()

Returns a Microsoft.AspNet.Identity.SignInResult that represents a successful sign-in.

Return type:Microsoft.AspNet.Identity.SignInResult
Returns:A <see cref=”T:Microsoft.AspNet.Identity.SignInResult” /> that represents a successful sign-in. 
public static SignInResult Success { get; }
TwoFactorRequired()

Returns a Microsoft.AspNet.Identity.SignInResult that represents a sign-in attempt that needs two-factor authentication.

Return type:Microsoft.AspNet.Identity.SignInResult
Returns:A <see cref=”T:Microsoft.AspNet.Identity.SignInResult” /> that represents sign-in attempt that needs two-factor authentication. 
public static SignInResult TwoFactorRequired { get; }

Methods

ToString()

Converts the value of the current Microsoft.AspNet.Identity.SignInResult object to its equivalent string representation.

Return type:System.String
Returns:A string representation of value of the current <see cref=”T:Microsoft.AspNet.Identity.SignInResult” /> object. 
public override string ToString()