Class ConnectionSettings

Class to store connection settings.

Inheritance
System.Object
ConnectionSettings
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Quark.CMSAdapters.Core.Data
Assembly: Quark.CMSAdapters.Core.dll
Syntax
[Serializable]
public class ConnectionSettings

Constructors

ConnectionSettings()

Initializes a new instance of the ConnectionSettings class.

Declaration
public ConnectionSettings()

ConnectionSettings(ConnectionSettings)

Initializes a new instance of the ConnectionSettings class.

Declaration
public ConnectionSettings(ConnectionSettings connectionSettings)
Parameters
Type Name Description
ConnectionSettings connectionSettings

The connection settings.

ConnectionSettings(Dictionary<String, Object>)

Initializes a new instance of the ConnectionSettings class.

Declaration
public ConnectionSettings(Dictionary<string, object> settings)
Parameters
Type Name Description
System.Collections.Generic.Dictionary<System.String, System.Object> settings

Fields

PREFERENCE_KEY

The preference key to get and set connection settings.

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

Properties

DomainName

Gets or sets the name of the domain.

Declaration
public string DomainName { get; set; }
Property Value
Type Description
System.String

The name of the domain.

IsDomainUser

Gets or sets a value indicating whether login as domain user is configured.

Declaration
public bool IsDomainUser { get; set; }
Property Value
Type Description
System.Boolean

true if login as domain user is configured; otherwise, false.

Password

Gets or sets the password.

Declaration
public string Password { get; set; }
Property Value
Type Description
System.String

The password.

Port

Gets or sets the port.

Declaration
public string Port { get; set; }
Property Value
Type Description
System.String

The port.

ProxyServerSettings

Gets or sets the proxy server settings.

Declaration
public ConnectionSettings ProxyServerSettings { get; set; }
Property Value
Type Description
ConnectionSettings

The proxy server settings.

ServerName

Gets or sets the name of the server.

Declaration
public string ServerName { get; set; }
Property Value
Type Description
System.String

The name of the server.

UseHttps

Gets or sets a value indicating whether HTTPS protocol is configured.

Declaration
public bool UseHttps { get; set; }
Property Value
Type Description
System.Boolean

true if HTTPS protocol is configured; otherwise, false.

UserName

Gets or sets the name of the user.

Declaration
public string UserName { get; set; }
Property Value
Type Description
System.String

The name of the user.

UseSSO

Gets or sets a value indicating whether login using single sign-on is configured.

Declaration
public bool UseSSO { get; set; }
Property Value
Type Description
System.Boolean

true if login using single sign-on is configured; otherwise, false.

Methods

Equals(Object)

Determines whether the specified System.Object, is equal to this instance.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj

The System.Object to compare with this instance.
Returns
Type Description
System.Boolean

true if the specified System.Object is equal to this instance; otherwise, false.
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Returns a hash code for this instance.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
Overrides
System.Object.GetHashCode()

GetURL()

Returns the url.

Declaration
public string GetURL()
Returns
Type Description
System.String

Operators

Equality(ConnectionSettings, ConnectionSettings)

Implements the operator ==.

Declaration
public static bool operator ==(ConnectionSettings connectionSettings1, ConnectionSettings connectionSettings2)
Parameters
Type Name Description
ConnectionSettings connectionSettings1

The connection settings1.
ConnectionSettings connectionSettings2

The connection settings2.
Returns
Type Description
System.Boolean

The result of the operator.

Inequality(ConnectionSettings, ConnectionSettings)

Implements the operator !=.

Declaration
public static bool operator !=(ConnectionSettings connectionSettings1, ConnectionSettings connectionSettings2)
Parameters
Type Name Description
ConnectionSettings connectionSettings1

The connection settings1.
ConnectionSettings connectionSettings2

The connection settings2.
Returns
Type Description
System.Boolean

The result of the operator.

Extension Methods