Class LoginSettings

The settings used to login to the LemonEdge platform

Inheritance

object

LoginSettings

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: LemonEdge.Client.Core.Authentication

Assembly: LemonEdge.ClientCore.dll

Syntax

[DataContract]
public class LoginSettings

Constructors

LoginSettings(IOptions<ConnectionSettings>)

Declaration

public LoginSettings(IOptions<ConnectionSettings> connectionSettings)

Parameters

Type	Name	Description
IOptions<ConnectionSettings>	connectionSettings

Properties

DBDatabase

The database to login to if the Type is set to Database

Declaration

[DataMember]
public string DBDatabase { get; set; }

Property Value

Type	Description
string

DBIntegratedSecurity

Indicates the system should login to the sql server database using integrated security. Type is set to Database

Declaration

[DataMember]
public bool DBIntegratedSecurity { get; set; }

Property Value

Type	Description
bool

DBPassword

The password to use when logging into the sql server when DBIntegratedSecurity is set to false

Declaration

public string DBPassword { get; set; }

Property Value

Type	Description
string

DBServer

The database server to login to if the Type is set to Database

Declaration

[DataMember]
public string DBServer { get; set; }

Property Value

Type	Description
string

DBUser

The sql server user login to use if the Type is set to Database

Declaration

[DataMember]
public string DBUser { get; set; }

Property Value

Type	Description
string

DatabaseName

The name of the valid database alias against the web service to connect to. Used when the Type is set to Service

Declaration

[DataMember]
public string DatabaseName { get; set; }

Property Value

Type	Description
string

DomainUser

The domain of the user to use when logging into the LemonEdge platform when UseWindowsAuthentication is set to true

Declaration

public string DomainUser { get; set; }

Property Value

Type	Description
string

IsWindowsIntegrated

Returns if the selected login is windows integrated

Declaration

public bool IsWindowsIntegrated { get; }

Property Value

Type	Description
bool

LoginMethod

The key for the desired login provider.

Declaration

[DataMember]
public string LoginMethod { get; set; }

Property Value

Type	Description
string

Password

The password to use when logging into the LemonEdge platform when UseWindowsAuthentication is set to false

Declaration

public string Password { get; set; }

Property Value

Type	Description
string

RecentDBDatabases

A list of all recent sql databases that have been successfully logged into.

The login window can use this to display quick drop down lists for selection

Declaration

[DataMember]
public List<string> RecentDBDatabases { get; set; }

Property Value

Type	Description
List<string>

RecentDBServers

A list of all recent database servers that have been successfully logged into.

The login window can use this to display quick drop down lists for selection

Declaration

[DataMember]
public List<string> RecentDBServers { get; set; }

Property Value

Type	Description
List<string>

RecentDBUsers

A list of all recent sql server user logins that have been successfully logged into.

The login window can use this to display quick drop down lists for selection

Declaration

[DataMember]
public List<string> RecentDBUsers { get; set; }

Property Value

Type	Description
List<string>

RecentServiceConnectionStrings

A list of all recent service uri connections that have been successfully logged into.

The login window can use this to display quick drop down lists for selection

Declaration

[DataMember]
public List<string> RecentServiceConnectionStrings { get; set; }

Property Value

Type	Description
List<string>

RecentUsers

A list of all recent lemonedge users that have been successfully logged into.

The login window can use this to display quick drop down lists for selection

Declaration

[DataMember]
public List<string> RecentUsers { get; set; }

Property Value

Type	Description
List<string>

RememberMe

Indicates the system should store these settings (apart from passwords) to re-use when we next login

Declaration

[DataMember]
public bool RememberMe { get; set; }

Property Value

Type	Description
bool

ServiceConnectionString

The web service uri connection to use if the Type is set to Service

Declaration

[DataMember]
public string ServiceConnectionString { get; set; }

Property Value

Type	Description
string

ShowConnections

A UI tweak to indicate the user wants to see the connection details, rather than just the high level info

Declaration

[DataMember]
public bool ShowConnections { get; set; }

Property Value

Type	Description
bool

Theme

Indicates the default theme to use when showing the login window. This is always set to the theme of the last successfully logged in user

Declaration

[DataMember]
public Theme Theme { get; set; }

Property Value

Type	Description
Theme

Type

The type of connection to use when attempting to login. Either a direct database connection, or a web service connection.

Declaration

[DataMember]
public ConnectionType Type { get; set; }

Property Value

Type	Description
ConnectionType

UserName

The user name to login to the LemonEdge platform with

Declaration

[DataMember]
public string UserName { get; set; }

Property Value

Type	Description
string

Methods

AreSettingsValidForLoginAttempt(ILoginProvider)

Returns true if all the required settings for a valid login have been set, and the login attempt can be made

Declaration

public bool AreSettingsValidForLoginAttempt(ILoginProvider provider)

Parameters

Type	Name	Description
ILoginProvider	provider

Returns

Type	Description
bool	True if all the required settings for a valid login have been set, and the login attempt can be made

GetDefaultDomainUser()

Declaration

public string GetDefaultDomainUser()

Returns

Type	Description
string

GetFriendlyDatabaseNameConnection()

Gets the name of the database, or database alias (if connecting through a web service) that we are connecting to from these settings

If the web service uri includes a database alias in it, then that is used in preference over any DatabaseName the setting has

Declaration

public string GetFriendlyDatabaseNameConnection()

Returns

Type	Description
string	The name of the database, or database alias (if connecting through a web service) that we are connecting to from these settings

LoadOrCreateSettings()

Loads the current local saved copy of any login settings (if previous logins were done with RememberMe set to true), or creates a new set of login settings using the default options

Declaration

public LoginSettings LoadOrCreateSettings()

Returns

Type	Description
LoginSettings

SaveSettings(LoginSettings)

Saves the specified settings to the local file system for retrieval when loading the application login again

Declaration

public void SaveSettings(LoginSettings settings)

Parameters

Type	Name	Description
LoginSettings	settings	The settings to be saved. No passwords are saved.

Extension Methods

LinqExtensions.AsArray<T>(T)

LinqExtensions.ToArrayOfOne<T>(T)

LinqExtensions.ToListOfOne<T>(T)

MiscExtensions.SetIfNotEqual<T, TP>(T, Expression<Func<T, TP>>, TP)

WeakReferenceExtensions.WeakReference(object)

SQLExtensions.ToSQLValue(object, bool)

ReflectionExtensions.ClearEventInvocations(object, string)

StringExtensions.ToCSVFormatString(object, Type)