Class LoginSettings

The settings used to login to the LemonEdge platform

Inheritance
System.Object
LoginSettings
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: LemonEdge.Client.Core.Authentication
Assembly: ClientCore.dll
Syntax
[DataContract]
public class LoginSettings

Fields

DEFAULT_SERVICE_CONNECTION

Declaration
public const string DEFAULT_SERVICE_CONNECTION = ""
Field Value
Type Description
System.String

Properties

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
System.String

DBDatabase

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

Declaration
[DataMember]
public string DBDatabase { get; set; }
Property Value
Type Description
System.String

DBPassword

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

Declaration
public string DBPassword { get; set; }
Property Value
Type Description
System.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
System.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
System.String

DBUseWindowsAuthentication

Indicates the system should login to the sql server database using windows authentication if the Type is set to Database

Declaration
[DataMember]
public bool DBUseWindowsAuthentication { get; set; }
Property Value
Type Description
System.Boolean

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
System.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
System.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
System.Collections.Generic.List<System.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
System.Collections.Generic.List<System.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
System.Collections.Generic.List<System.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
System.Collections.Generic.List<System.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
System.Collections.Generic.List<System.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
System.Boolean

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
System.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
System.Boolean

Theme

Indicates the default theme to use when showing the login window. This is always set to the theme of the last sucessfully 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
System.String

UseWindowsAuthentication

Indicates the system should login to the LemonEdge platform using windows authentication rather than a username/password

Declaration
[DataMember]
public bool UseWindowsAuthentication { get; set; }
Property Value
Type Description
System.Boolean

Methods

AreSettingsValidForLoginAttempt()

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

Declaration
public bool AreSettingsValidForLoginAttempt()
Returns
Type Description
System.Boolean

True if all the required settings for a valid login have been set, and the login attemt can be made

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
System.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 static 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 static void SaveSettings(LoginSettings settings)
Parameters
Type Name Description
LoginSettings settings

The settings to be saved. No passwords are saved.

Extension Methods