Class LdapParams

Object that is used to set the different parameters of a Ldap.

Inheritance
System.Object
LinphoneObject
LdapParams
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Linphone
Assembly: cs.temp.dll.dll
Syntax
public class LdapParams : LinphoneObject

Properties

AuthMethod

Get the authentification method.

Check LdapAuthMethod for authentification values.

Declaration
public LdapAuthMethod AuthMethod { get; set; }
Property Value
Type Description
LdapAuthMethod

The LdapAuthMethod.

BaseObject

Get the BaseObject.

It is a specification for LDAP Search Scopes that specifies that the Search Request should only be performed against the entry specified as the search base DN. No entries above it will be considered. This field is required.

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

The specification.

BindDn

Get the Bind DN to use for bindings.

The bindDN DN is the credential that is used to authenticate against an LDAP. If empty, the connection will be Anonymous. eg: cn=ausername,ou=people,dc=bc,dc=com

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

The Bind DN to use for bindings.

DebugLevel

Return the debug verbosity level.

Declaration
public LdapDebugLevel DebugLevel { get; set; }
Property Value
Type Description
LdapDebugLevel

The LdapDebugLevel debug level.

Delay

Get the delay between each search in milliseconds.

Declaration
public int Delay { get; set; }
Property Value
Type Description
System.Int32

The delay in milliseconds.

Enabled

Return if the configuration is enabled.

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

Enable or not the LDAP configuration.

Filter

Get the search is based on this filter to search contacts.

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

The filter to use.

MaxResults

Get the max results when requesting searches.

Declaration
public int MaxResults { get; set; }
Property Value
Type Description
System.Int32

The max results when requesting searches.

MinChars

Get the minimum characters needed for doing a search on LDAP servers.

Declaration
public int MinChars { get; set; }
Property Value
Type Description
System.Int32

The minimum characters needed by a search.

NameAttribute

Get the attributes to build Name Friend, separated by a comma and the first is the highest priority.

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

The comma separated attributes for the search.

Password

Get the password to pass to server when binding.

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

The password to pass to server when binding.

SalEnabled

Return if the dns resolution is done by Linphone using Sal.

It will pass an IP to LDAP. By doing that, the TLS negociation could not check the hostname. You may deactivate the verifications if wanted to force the connection.

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

Enable or not the use of sal.

Server

Get the LDAP Server.

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

LDAP Server address.

ServerCertificatesVerificationMode

Return whether the tls server certificate must be verified when connecting to a LDAP server.

Declaration
public LdapCertVerificationMode ServerCertificatesVerificationMode { get; set; }
Property Value
Type Description
LdapCertVerificationMode

The TLS verification mode from LdapCertVerificationMode

SipAttribute

Get the attributes to build the SIP username in address of Friend.

Attributes are separated by a comma.

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

The comma separated attributes for building Friend.

SipDomain

Get the domain to the sip address(sip:username).

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

The SIP domain for the friend.

Timeout

Get the timeout in seconds.

Declaration
public int Timeout { get; set; }
Property Value
Type Description
System.Int32

The timeout in seconds.

TlsEnabled

Return if transactions are encrypted by LDAP over TLS(StartTLS).

You must use \'ldap\' scheme. \'ldaps\' for LDAP over SSL is non-standardized and deprecated. StartTLS in an extension to the LDAP protocol which uses the TLS protocol to encrypt communication. It works by establishing a normal - i.e. unsecured - connection with the LDAP server before a handshake negotiation between the server and the web services is carried out. Here, the server sends its certificate to prove its identity before the secure connection is established.

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

Enable or not the use of TLS.

Methods

Check()

Check parameters and return what are wrong.

Declaration
public int Check()
Returns
Type Description
System.Int32

The LdapCheck values. LinphoneLdapCheckOk if everything is ok.

Clone()

Instantiate a new LdapParams with values from source.

Declaration
public LdapParams Clone()
Returns
Type Description
LdapParams

The newly created LdapParams object.

GetCustomValue(String)

Get the value from field.

Declaration
public string GetCustomValue(string key)
Parameters
Type Name Description
System.String key

The key string.
Returns
Type Description
System.String

The Value associated to the key.

SetCustomValue(String, String)

Set custom field.

Declaration
public void SetCustomValue(string key, string val)
Parameters
Type Name Description
System.String key

The key string.
System.String val

The value string.