Show / Hide Table of Contents

Class LoginResponse

A response to login attempts. Check matched to determine whether the login attempt needs to be retried with updated parameters or not.

Inheritance
Object
LoginResponse
Implements
ILoginOkResponse
ILoginResetResponse
Inherited Members
Object.Equals(Object)
Object.Equals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Object.ReferenceEquals(Object, Object)
Object.ToString()
Namespace: PKWARE.Smartcrypt.Protocol
Assembly: SmartcryptProtocol.dll
Syntax
public sealed class LoginResponse : ILoginOkResponse, ILoginResetResponse

Properties

challenge

null only when matched is true.

Declaration
[CanBeNull]
public string challenge { get; set; }
Property Value
Type Description
String

loginRounds

Non-zero when matched is false.

Declaration
public int loginRounds { get; set; }
Property Value
Type Description
Int32

loginSalt

null only when matched is true.

Declaration
[CanBeNull]
public string loginSalt { get; set; }
Property Value
Type Description
String

matched

true if the request was made with the appropriate parameters; false if the request needs to be retried.

Declaration
public bool matched { get; set; }
Property Value
Type Description
Boolean
Remarks

When true, it is safe to cast this object as a ILoginOkResponse; when false it is safe to cast this object as a ILoginResetResponse.

pid

null only when matched is false.

Declaration
[CanBeNull]
public Pid pid { get; set; }
Property Value
Type Description
Pid

user

null only when matched is false.

Declaration
[CanBeNull]
public User user { get; set; }
Property Value
Type Description
User

Implements

ILoginOkResponse
ILoginResetResponse
Back to top Copyright © 2018 PKWARE, Inc.