Liblinphone  5.5.0
Linphone.LdapParams Class Reference
Inheritance diagram for Linphone.LdapParams:
Linphone.LinphoneObject

Public Member Functions

int Check ()
 
Linphone.LdapParams Clone ()
 
string GetCustomValue (string key)
 
void SetCustomValue (string key, string val)
 

Properties

Linphone.LdapAuthMethod AuthMethod [get, set]
 
string BaseObject [get, set]
 
string BindDn [get, set]
 
Linphone.LdapDebugLevel DebugLevel [get, set]
 
int Delay [get, set]
 
bool Enabled [get, set]
 
string Filter [get, set]
 
int MaxResults [get, set]
 
int MinChars [get, set]
 
string NameAttribute [get, set]
 
string Password [get, set]
 
bool SalEnabled [get, set]
 
string Server [get, set]
 
Linphone.LdapCertVerificationMode ServerCertificatesVerificationMode [get, set]
 
string SipAttribute [get, set]
 
string SipDomain [get, set]
 
int Timeout [get, set]
 
int TimeoutTlsMs [get, set]
 
bool TlsEnabled [get, set]
 

Additional Inherited Members

- Protected Member Functions inherited from Linphone.LinphoneObject
static String linphone_pointer_to_string (IntPtr ptr)
 
static IntPtr linphone_string_to_pointer ([MarshalAs(LinphoneWrapper.ByteStringMarshalling)] String str)
 
IntPtr StringArrayToBctbxList (IEnumerable< string > stringlist)
 
void CleanStringArrayPtrs (IntPtr l)
 

Detailed Description

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

Member Function Documentation

int Linphone.LdapParams.Check ( )
inline

Check parameters and return what are wrong.

Returns
The Linphone.LdapCheck values. LinphoneLdapCheckOk if everything is ok.
Linphone.LdapParams Linphone.LdapParams.Clone ( )
inline

Instantiate a new Linphone.LdapParams with values from source.

Returns
The newly created Linphone.LdapParams object.
string Linphone.LdapParams.GetCustomValue ( string  key)
inline

Get the value from field.

Parameters
keyThe key string.
Returns
The Value associated to the key.
void Linphone.LdapParams.SetCustomValue ( string  key,
string  val 
)
inline

Set custom field.

Parameters
keyThe key string.
valThe value string.

Property Documentation

Linphone.LdapAuthMethod Linphone.LdapParams.AuthMethod
getset

Get the authentification method.

Check Linphone.LdapAuthMethod for authentification values.

Returns
The Linphone.LdapAuthMethod.
string Linphone.LdapParams.BaseObject
getset

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.

Returns
The specification.
string Linphone.LdapParams.BindDn
getset

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

Returns
The Bind DN to use for bindings.
Linphone.LdapDebugLevel Linphone.LdapParams.DebugLevel
getset

Return the debug verbosity level.

Returns
The Linphone.LdapDebugLevel debug level.
int Linphone.LdapParams.Delay
getset

Get the delay between each search in milliseconds.

Deprecated : 22/08/2025 use Linphone.RemoteContactDirectory.Delay instead.

Returns
The delay in milliseconds.
bool Linphone.LdapParams.Enabled
getset

Return if the configuration is enabled.

Returns
Enable or not the LDAP configuration.

Deprecated : 22/08/2025 Use Linphone.RemoteContactDirectory.Enabled() instead.

string Linphone.LdapParams.Filter
getset

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

Returns
The filter to use.
int Linphone.LdapParams.MaxResults
getset

Get the max results when requesting searches.

0 means the results aren't limited (but magic search limitation may apply).

Returns
The max results when requesting searches.

Deprecated : 18/11/2024 use Linphone.RemoteContactDirectory.Limit instead.

int Linphone.LdapParams.MinChars
getset

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

Returns
The minimum characters needed by a search.

Deprecated : 18/11/2024 use Linphone.RemoteContactDirectory.MinCharacters instead.

string Linphone.LdapParams.NameAttribute
getset

Get the list of LDAP attributes to check for the contact name, separated by a comma and the first being the highest priority.

Returns
The comma separated attributes for the search.
string Linphone.LdapParams.Password
getset

Get the password to pass to server when binding.

Returns
The password to pass to server when binding.
bool Linphone.LdapParams.SalEnabled
getset

Handle the DNS resolution using liblinphone's own resolver, which allows to use DNS SRV records.

Returns
whether liblinphone'own DNS resolver is used.
string Linphone.LdapParams.Server
getset

Get the LDAP Server.

Returns
LDAP Server address.

Deprecated : 18/11/2024 use Linphone.RemoteContactDirectory.ServerUrl instead.

Linphone.LdapCertVerificationMode Linphone.LdapParams.ServerCertificatesVerificationMode
getset

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

Returns
The TLS verification mode from Linphone.LdapCertVerificationMode
string Linphone.LdapParams.SipAttribute
getset

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

Attributes are separated by a comma.

Returns
The comma separated attributes for building Friend.
string Linphone.LdapParams.SipDomain
getset

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

Returns
The SIP domain for the friend.
int Linphone.LdapParams.Timeout
getset

Get the timeout for requests in seconds.

Returns
The timeout in seconds.

Deprecated : 18/11/2024 use Linphone.RemoteContactDirectory.Timeout instead.

int Linphone.LdapParams.TimeoutTlsMs
getset

Get the timeout for TLS connection in milliseconds.

Returns
The timeout in milliseconds.
bool Linphone.LdapParams.TlsEnabled
getset

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

You must use &apos;ldap&apos; scheme. &apos;ldaps&apos; 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.

Returns
Enable or not the use of TLS.

The documentation for this class was generated from the following file: