Class LoginResult

Namespace

Zendesk.Runtime.Messaging.Results

Represents the result of a login operation, encapsulating both success and possible login errors.

public class LoginResult : ZendeskResult<LoginError>

Inheritance

object

ZendeskResult

ZendeskResult<LoginError>

LoginResult

Inherited Members

ZendeskResult<LoginError>.Error

ZendeskResult.IsSuccess

ZendeskResult.IsFailed

ZendeskResult.ErrorMessage

ZendeskResult.Failure(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Failure(LoginError)

Creates a failure result for the login operation with the specified LoginError.

public static LoginResult Failure(LoginError error)

Parameters

error LoginError

The specific LoginError that caused the failure.

Returns

LoginResult

A LoginResult indicating a failed login along with the error.

Success()

Creates a success result for the login operation.

public static LoginResult Success()

Returns

LoginResult

A LoginResult indicating a successful login.

Operators

implicit operator LoginResult(AuthenticationError)

Implicitly converts a LoginError to a failed LoginResult with the corresponding error.

public static implicit operator LoginResult(AuthenticationError error)

Parameters

error AuthenticationError

The error to convert to a failed LoginResult.

Returns

LoginResult

implicit operator LoginResult(LoginError)

Implicitly converts a LoginError to a failed LoginResult with the corresponding error.

public static implicit operator LoginResult(LoginError error)

Parameters

error LoginError

The error to convert to a failed LoginResult.

Returns

LoginResult