View Source

Class AutoLinkSignInResult

Result returned from signing in when auto-linking takes place

Inheritance

object

SignInResult

Namespace: Umbraco.Cms.Api.Management.Security

Assembly: Umbraco.Cms.Api.Management.dll

Syntax

public class AutoLinkSignInResult : SignInResult

Constructors

AutoLinkSignInResult()

Initializes a new instance of the AutoLinkSignInResult class with default values.

Declaration

public AutoLinkSignInResult()

AutoLinkSignInResult(IReadOnlyCollection<string>)

Initializes a new instance of the AutoLinkSignInResult class with the specified errors.

Declaration

public AutoLinkSignInResult(IReadOnlyCollection<string> errors)

Parameters

Type	Name	Description
IReadOnlyCollection<string>	errors	A collection of error messages related to the auto-link sign-in process.

Properties

Errors

Gets the collection of error messages related to the auto-link sign-in process.

Declaration

public IReadOnlyCollection<string> Errors { get; }

Property Value

Type	Description
IReadOnlyCollection<string>

FailedNoEmail

Gets a result indicating the auto-link sign-in failed due to no email being available.

Declaration

public static AutoLinkSignInResult FailedNoEmail { get; }

Property Value

Type	Description
AutoLinkSignInResult

FailedNotLinked

Gets a result indicating that the sign-in attempt failed because the account is not linked.

Declaration

public static AutoLinkSignInResult FailedNotLinked { get; }

Property Value

Type	Description
AutoLinkSignInResult

Methods

FailedCreatingUser(IReadOnlyCollection<string>)

Creates a failed AutoLinkSignInResult with the specified errors.

Declaration

public static AutoLinkSignInResult FailedCreatingUser(IReadOnlyCollection<string> errors)

Parameters

Type	Name	Description
IReadOnlyCollection<string>	errors	The collection of error messages describing why the user creation failed.

Returns

Type	Description
AutoLinkSignInResult	An AutoLinkSignInResult indicating failure with error details.

FailedException(string)

Creates a failed AutoLinkSignInResult with the specified error message.

Declaration

public static AutoLinkSignInResult FailedException(string error)

Parameters

Type	Name	Description
string	error	The error message describing the failure.

Returns

Type	Description
AutoLinkSignInResult	An AutoLinkSignInResult indicating failure with the provided error.

FailedLinkingUser(IReadOnlyCollection<string>)

Creates an AutoLinkSignInResult representing a failed auto-link sign-in attempt, including the specified errors.

Declaration

public static AutoLinkSignInResult FailedLinkingUser(IReadOnlyCollection<string> errors)

Parameters

Type	Name	Description
IReadOnlyCollection<string>	errors	A collection of error messages describing why the linking failed.

Returns

Type	Description
AutoLinkSignInResult	An AutoLinkSignInResult indicating failure and containing error details.