SignInResult Class¶

Inheritance Hierarchy¶

• System.Object
• Microsoft.AspNetCore.Identity.SignInResult

Syntax¶

public class SignInResult

class Microsoft.AspNetCore.Identity.SignInResult

Properties¶

Microsoft.AspNetCore.Identity.SignInResult.Failed¶

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

Return type:	Microsoft.AspNetCore.Identity.SignInResult
Returns:	A Microsoft.AspNetCore.Identity.SignInResult that represents a failed sign-in.

public static SignInResult Failed { get; }

Microsoft.AspNetCore.Identity.SignInResult.IsLockedOut¶

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

Return type:	System.Boolean
Returns:	True if the user attempting to sign-in is locked out, otherwise false.

public bool IsLockedOut { get; protected set; }

Microsoft.AspNetCore.Identity.SignInResult.IsNotAllowed¶

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

Return type:	System.Boolean
Returns:	True if the user attempting to sign-in is not allowed to sign-in, otherwise false.

public bool IsNotAllowed { get; protected set; }

Microsoft.AspNetCore.Identity.SignInResult.LockedOut¶

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

Return type:	Microsoft.AspNetCore.Identity.SignInResult
Returns:	A Microsoft.AspNetCore.Identity.SignInResult that represents sign-in attempt that failed due to the user being locked out.

public static SignInResult LockedOut { get; }

Microsoft.AspNetCore.Identity.SignInResult.NotAllowed¶

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

Return type:	Microsoft.AspNetCore.Identity.SignInResult
Returns:	A Microsoft.AspNetCore.Identity.SignInResult that represents sign-in attempt that failed due to the user is not allowed to sign-in.

public static SignInResult NotAllowed { get; }

Microsoft.AspNetCore.Identity.SignInResult.RequiresTwoFactor¶

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

Return type:	System.Boolean
Returns:	True if the user attempting to sign-in requires two factor authentication, otherwise false.

public bool RequiresTwoFactor { get; protected set; }

Microsoft.AspNetCore.Identity.SignInResult.Succeeded¶

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

Return type:	System.Boolean
Returns:	True if the sign-in was successful, otherwise false.

public bool Succeeded { get; protected set; }

Microsoft.AspNetCore.Identity.SignInResult.Success¶

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

Return type:	Microsoft.AspNetCore.Identity.SignInResult
Returns:	A Microsoft.AspNetCore.Identity.SignInResult that represents a successful sign-in.

public static SignInResult Success { get; }

Microsoft.AspNetCore.Identity.SignInResult.TwoFactorRequired¶

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

Return type:	Microsoft.AspNetCore.Identity.SignInResult
Returns:	A Microsoft.AspNetCore.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.AspNetCore.Identity.SignInResult object to its equivalent string representation.

Return type:	System.String
Returns:	A string representation of value of the current Microsoft.AspNetCore.Identity.SignInResult object.

public override string ToString()